List Outbound Webhook Event Types
GET/api/webhook-events
Returns the full catalog of subscribable events. Each entry includes the wire event name, human label/description, UI group, the required_scope needed to subscribe and view samples, and a one-record sample_payload shaped exactly like the live webhook payload. Requires webhooks:read or webhooks:manage.
webhooks:read|webhooks:manageGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The sample_payload shown here is abridged for readability — see Get Outbound Event Sample Payload for the complete field list an integration receives.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.