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

Encabezados

webhook-id
string
requerido

A unique identifier for this webhook request

Ejemplo:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

webhook-signature
string
requerido

The signature of the webhook request with the webhook version prepended

Ejemplo:

"v1,BASE64ENCODEDSIGNATURE"

webhook-timestamp
string
requerido

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

Ejemplo:

"1727606400"

Cuerpo

application/json
api_version
string
requerido

The API version for this webhook

Allowed value: "v1"
Ejemplo:

"v1"

api_version_date
string | null
requerido

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

Ejemplo:

"2026-07-20"

data
object
requerido
id
string
requerido

A unique ID for every single webhook request

Ejemplo:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

timestamp
string<date-time>
requerido

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

Ejemplo:

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

type
string
requerido

The webhook event type

Allowed value: "plan.created"
Ejemplo:

"plan.created"

account_id
string | null

The account ID that this webhook event is associated with

Ejemplo:

"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

Respuesta

200

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