Skip to main content
A Webhook object represents an endpoint you’ve configured to receive Event notifications — payment successes, refunds, subscription changes, and more. Each webhook is subscribed to one or more event types and receives an HTTP POST for every matching event, signed with its secret. A workspace may have a small, fixed number of webhooks configured at once; create returns an error once that limit is reached.
Webhook URLs must use http:// or https:// and resolve to a public address. Other schemes, and URLs that resolve to a loopback, private, or link-local address (including cloud metadata endpoints), are rejected — both at creation/update time and again at delivery time.

​
Endpoints

​
The Webhook object

​
object
string
Object type identifier. Always "webhook" for Webhook objects.
​
id
string
required
Unique identifier (UUID) for this webhook.
​
url
string
required
The endpoint that receives event deliveries.
​
status
string
required
Current webhook status. Possible values: active, inactive
​
secret
string
required
Signing secret used to verify the x-fngs-signature header on each delivery.
​
events
array
required
Event types this webhook is subscribed to.
​
createdAt
integer
Unix timestamp (milliseconds) when the webhook was created.
​
deletedAt
integer | null
Unix timestamp (milliseconds) when the webhook was archived. null if not archived.

​
The Webhook Attempt object

Each delivery attempt — success or failure — is recorded and available via the attempts endpoint.
​
object
string
Object type identifier. Always "webhook_attempt" for Webhook Attempt objects.
​
id
string
required
Unique identifier (UUID) for this attempt.
​
webhookId
string
required
The Webhook this attempt belongs to.
​
eventType
string | null
The Event type that was delivered.
​
sequence
integer
required
Retry sequence number for this delivery. 0 is the first try.
​
statusCode
integer | null
HTTP status code returned by the receiving endpoint. null if the request itself failed (timeout, connection error, blocked URL).
​
request
object | null
The request body that was sent.
​
response
object | null
The parsed JSON response body, if any.
​
createdAt
integer
Unix timestamp (milliseconds) when the attempt was made.

​
Example response

Events

The notification payloads webhooks deliver

Webhook Setup Guide

Configuring and verifying webhook deliveries