List supported webhook event types
Returns all event type identifiers available for webhook subscriptions.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Returns the catalog of webhook event types your client can subscribe to. Use this list to populate the webhook_events field when configuring a webhook subscription — only events in this catalog are accepted for delivery.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - The caller must hold the
webhooks.catalog.readpermission and have the OWNER, DEVELOPER, or OPERATIONS role.
Response
200 — Returns a WebhookEventCatalogResponse with a single field events: an array of supported event type identifiers (for example payment.status_changed, kyc.status_changed, kyb.status_changed, contract.request.completed, workflow.run.completed). Each identifier is a string that can be passed to a webhook subscription.
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.