API reference
Webhooks
11 operations. Each page has the request, the response, the errors and examples in curl, TypeScript, Python and the CLI.
- GETEvery event type a webhook can receive, with the JSON Schema of its data
/v1/webhooks/event-types - GETList the project’s webhook destinations, with their delivery health
/v1/webhooks - POSTCreate a webhook destination (its signing secret is returned once)
/v1/webhooks - GETGet a webhook destination
/v1/webhooks/{webhook_id} - PATCHChange a webhook destination, or pause or resume it
/v1/webhooks/{webhook_id} - DELETEDelete a webhook destination and its delivery log
/v1/webhooks/{webhook_id} - POSTReplace the signing secret (returned once); the previous one keeps signing during the overlap
/v1/webhooks/{webhook_id}/rotate-secret - POSTSend a test event to this destination (also while it is paused)
/v1/webhooks/{webhook_id}/test - GETList a destination’s deliveries, newest first
/v1/webhooks/{webhook_id}/deliveries - GETGet a delivery with its payload and attempt log
/v1/webhooks/{webhook_id}/deliveries/{delivery_id} - POSTSend a delivery’s event again (a new delivery, same event ID)
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver