Skip to content

Webhooks

Webhook endpoints, signing secrets, deliveries and notification settings. Signatures: see Webhooks.

The permission column lists what the route checks. An API token needs one of them as a scope. Where a route lists several, the route checks them for different parts of the request.

Method Path Permission
GET /api/webhooks webhooks:read, webhooks:write
POST /api/webhooks webhooks:write
GET /api/webhooks/:id webhooks:read, webhooks:write
PATCH /api/webhooks/:id webhooks:write
DELETE /api/webhooks/:id webhooks:write
GET /api/webhooks/:id/deliveries webhooks:read
GET /api/webhooks/:id/deliveries/:deliveryId webhooks:read, webhooks:write
POST /api/webhooks/:id/deliveries/:deliveryId/redeliver webhooks:write
POST /api/webhooks/:id/rotate-secret webhooks:write
POST /api/webhooks/:id/test webhooks:write
GET /api/webhooks/event-types webhooks:read, webhooks:write
GET /api/webhooks/settings webhooks:read, webhooks:write
PUT /api/webhooks/settings webhooks:write

This page is generated from the API route inventory. 13 endpoints.