Webhooks
Outbound event subscriptions and their deliveries.
The webhook subscription object
As returned by GET /webhooks. Every endpoint below that returns this resource returns exactly these fields.
| Name | Type | Description |
|---|---|---|
idrequired | string (uuid) | UUID |
urlrequired | string | Where events are POSTed |
descriptionrequired | string | null | |
eventsrequired | string[] | Subscribed event types |
enabledrequired | boolean | false = nothing is delivered; pending deliveries wait |
api_versionrequired | string | The payload version this endpoint receives |
secret_last4required | string | The last four characters of the signing secret |
consecutive_failuresrequired | integer | Unbroken run of failed deliveries; reset to 0 on success |
disabled_atrequired | string (date-time) | null | |
disabled_reasonrequired | string | null | Why it is off — `auto: …` when the platform switched it off |
last_success_atrequired | string (date-time) | null | |
last_errorrequired | string | null | |
last_error_atrequired | string (date-time) | null | |
created_atrequired | string (date-time) | ISO 8601 timestamp |
updated_atrequired | string (date-time) | ISO 8601 timestamp |
Endpoints
10 endpoints, each on its own page with its parameters, responses, error codes and samples in curl, Node and Python.