Skip to main content
WEBHOOK
Required permissions:
  • webhook_receive:accounts

En-têtes

webhook-id
string
requis

A unique identifier for this webhook request

Exemple:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

webhook-signature
string
requis

The signature of the webhook request with the webhook version prepended

Exemple:

"v1,BASE64ENCODEDSIGNATURE"

webhook-timestamp
string
requis

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Exemple:

"1727606400"

Corps

application/json
api_version
string
requis

The API version for this webhook

Allowed value: "v1"
Exemple:

"v1"

api_version_date
string | null
requis

The dated API version (Api-Version-Date) the payload is serialized to

Exemple:

"2026-07-20"

data
object
requis
id
string
requis

A unique ID for every single webhook request

Exemple:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

timestamp
string<date-time>
requis

The timestamp in ISO 8601 format that the webhook was sent at on the server

Exemple:

"2025-01-01T00:00:00.000Z"

type
string
requis

The webhook event type

Allowed value: "account.financing_approved"
Exemple:

"account.financing_approved"

account_id
string | null

The account ID that this webhook event is associated with

Exemple:

"biz_xxxxxxxxxxxxxx"

previous_attributes
object

For some .updated events, the old values of the payload fields that changed, keyed by field name. Omitted when no capture is available for the event

Réponse

200

Return a 200 status to indicate that the data was received successfully