Skip to content

Reference

Webhooks

Where this account's job events are delivered, and what happened to each delivery.

Operations

7 operations: 3 that read and 4 that change something. Every path is relative to the API base URL. Open one for its parameters, its response shape and the refusals it can answer.

Webhooks: 7 operations
EndpointScopesRate limit
POST /webhooks Register a webhook endpointwebhooks:manage idempotency keywrite, 120/min
DELETE /webhooks/{id} Delete a webhook endpointwebhooks:manage idempotency keywrite, 120/min
GET /webhooks/{id}/deliveries One endpoint's delivery logwebhooks:manage write, 120/min
GET /webhooks/{id} One webhook endpointwebhooks:manage write, 120/min
GET /webhooks The account's webhook endpointswebhooks:manage write, 120/min
POST /webhooks/{id}/test Send a test deliverywebhooks:manage idempotency keywrite, 120/min
PATCH /webhooks/{id} Change a webhook endpointwebhooks:manage idempotency keywrite, 120/min