Webhooks
Webhook endpoints v2, retry, replay and playground. - 22 operations in this section.
OpenAPI reference
webhooks operations
Server-rendered operation index with methods, paths, scopes and schema downloads. It remains available even when the interactive client reference cannot be loaded by the browser.
| Method | Path | Operation | Scopes | Guide |
|---|---|---|---|---|
| GET | /webhooks/endpoints | List webhook endpoints listWebhookEndpoints | webhooks:read | Open |
| POST | /webhooks/endpoints | Create webhook endpoint createWebhookEndpoint | webhooks:write | Open |
| GET | /webhooks/endpoints/{id} | Get webhook endpoint details getWebhookEndpoint | webhooks:read | Open |
| PATCH | /webhooks/endpoints/{id} | Update webhook endpoint updateWebhookEndpoint | webhooks:write | Open |
| DELETE | /webhooks/endpoints/{id} | Delete webhook endpoint deleteWebhookEndpoint | webhooks:write | Open |
| POST | /webhooks/endpoints/{id}/test | Send test webhook testWebhookEndpoint | webhooks:write | Open |
| POST | /webhooks/endpoints/{id}/rotate-secret | Rotate webhook secret rotateWebhookSecret | webhooks:write | Open |
| GET | /webhooks/deliveries | List webhook deliveries listWebhookDeliveries | webhooks:read | Open |
| GET | /webhooks/deliveries/{id} | Get webhook delivery details getWebhookDelivery | webhooks:read | Open |
| POST | /webhooks/deliveries/{id}/replay | Replay webhook delivery replayWebhookDelivery | webhooks:write | Open |
| GET | /webhooks/events | Event catalog listWebhookEvents | webhooks:read | Open |
| GET | /webhooks/playground/{token} | Capture GET in Webhook Playground captureWebhookPlaygroundGet | webhooks:read | Open |
| POST | /webhooks/playground/{token} | Capture POST in Webhook Playground captureWebhookPlaygroundPost | webhooks:write | Open |
| PUT | /webhooks/playground/{token} | Capture PUT in Webhook Playground captureWebhookPlaygroundPut | webhooks:write | Open |
| PATCH | /webhooks/playground/{token} | Capture PATCH in Webhook Playground captureWebhookPlaygroundPatch | webhooks:write | Open |
| DELETE | /webhooks/playground/{token} | Capture DELETE in Webhook Playground captureWebhookPlaygroundDelete | webhooks:write | Open |
| GET | /events | Public event catalog listEventCatalog | webhooks:read | Open |
| GET | /webhook-endpoints | List webhook endpoints public API v2 listPublicWebhookEndpoints | webhooks:read | Open |
| POST | /webhook-endpoints | Create webhook endpoint public API v2 createPublicWebhookEndpoint | webhooks:write | Open |
| GET | /webhook-endpoints/{id} | Get webhook endpoint details public API v2 getPublicWebhookEndpoint | webhooks:read | Open |
| PATCH | /webhook-endpoints/{id} | Update webhook endpoint public API v2 updatePublicWebhookEndpoint | webhooks:write | Open |
| DELETE | /webhook-endpoints/{id} | Delete webhook endpoint public API v2 deletePublicWebhookEndpoint | webhooks:write | Open |