API reference

Webhooks API

Signed event delivery to your own endpoints. Register an endpoint, rotate its signing secret, browse the event catalogue, and inspect, test or replay individual deliveries.

Endpoints

11 operations, each with its parameters, schemas and an example request on its own page.

get/api/webhooksList webhooks — Every endpoint in the workspace, or the ones a given bot's events reach.
post/api/webhooksCreate webhook — Registers an endpoint and returns its signing secret, once.
get/api/webhooks/deliveriesList all deliveries — Deliveries across every endpoint, newest first.
get/api/webhooks/deliveries/{delivery_id}Get delivery — One delivery, with the payload that was actually sent.
post/api/webhooks/deliveries/{delivery_id}/replayReplay delivery — Re-sends a delivery as a new attempt that remembers the original.
get/api/webhooks/eventsList events — The event catalogue, with a sample payload for each.
get/api/webhooks/{webhook_id}Get webhook
patch/api/webhooks/{webhook_id}Update webhook — Changes URL, events, description or active state.
delete/api/webhooks/{webhook_id}Delete webhook
post/api/webhooks/{webhook_id}/rotate-secretRotate secret — Issues a new signing secret. The old one stops working immediately.
post/api/webhooks/{webhook_id}/testTest webhook — Fires a synthetic event down the real delivery path.

Authentication

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned

The models these endpoints send back, with every field. Open one to read it.

WebhookResponse19 fields

api_versionstringrequired
bot_idstring (uuid) | nullrequired
consecutive_failuresintegerrequired
created_atstring (date-time)required
delivery_countintegerrequired
descriptionstring | nullrequired
disabled_atstring (date-time) | nullrequired
eventsarray of stringrequired
failure_countintegerrequired
healthstringrequired
One word for a status dot, derived rather than stored.
Stored health is health that goes stale the moment a delivery lands and nothing recomputes it.
idstring (uuid)required
is_activebooleanrequired
last_errorstring | nullrequired
last_failure_atstring (date-time) | nullrequired
last_success_atstring (date-time) | nullrequired
org_idstring (uuid)required
updated_atstring (date-time)required
urlstringrequired
secret_hintstring | null

WebhookCreated20 fields

api_versionstringrequired
bot_idstring (uuid) | nullrequired
consecutive_failuresintegerrequired
created_atstring (date-time)required
delivery_countintegerrequired
descriptionstring | nullrequired
disabled_atstring (date-time) | nullrequired
eventsarray of stringrequired
failure_countintegerrequired
healthstringrequired
One word for a status dot, derived rather than stored.
Stored health is health that goes stale the moment a delivery lands and nothing recomputes it.
idstring (uuid)required
is_activebooleanrequired
last_errorstring | nullrequired
last_failure_atstring (date-time) | nullrequired
last_success_atstring (date-time) | nullrequired
org_idstring (uuid)required
secretstringrequired
The signing secret, shown exactly once. Store it now - it cannot be retrieved again, only rotated.
updated_atstring (date-time)required
urlstringrequired
secret_hintstring | null

PaginatedResponse_WebhookDeliveryResponse_6 fields

itemsarray of WebhookDeliveryResponserequired
12 fields · WebhookDeliveryResponse
- attemptsintegerrequired
- created_atstring (date-time)required
- delivered_atstring (date-time) | nullrequired
- duration_msinteger | nullrequired
- eventstringrequired
- idstring (uuid)required
- response_bodystring | nullrequired
- response_statusinteger | nullrequired
- statusstringrequired
- webhook_idstring (uuid)required
- payloadobject | null
- replay_of_idstring (uuid) | null
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
has_moreboolean
Default: false
next_cursorstring | null

WebhookDeliveryResponse12 fields

attemptsintegerrequired
created_atstring (date-time)required
delivered_atstring (date-time) | nullrequired
duration_msinteger | nullrequired
eventstringrequired
idstring (uuid)required
response_bodystring | nullrequired
response_statusinteger | nullrequired
statusstringrequired
webhook_idstring (uuid)required
payloadobject | null
replay_of_idstring (uuid) | null

EventDescriptor4 fields

deliverystringrequired
One of: immediate, batched
descriptionstringrequired
exampleobjectrequired
namestringrequired

Message2 fields

messagestringrequired
okboolean
Default: true

RotateSecretResponse2 fields

rotated_atstring (date-time)required
secretstringrequired

WebhookTestResponse5 fields

delivery_idstring (uuid)required
okbooleanrequired
duration_msinteger
Default: 0
errorstring | null
status_codeinteger | null

Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.