Discoverable catalog of webhook event types and payload fields
Programmatic catalog of webhook events. Tenant SDK consumers wiring up a receiver can consult this endpoint to know: - Which event_type strings to expect on…
GET
Programmatic catalog of webhook events.
Tenant SDK consumers wiring up a receiver can consult this endpoint
to know:
- Which
event_typestrings to expect on the wire - Which payload fields are guaranteed (envelope + per-event)
- Which subscription wildcard means ‘everything’
events array) reference it.
Cached for 300s; supports If-None-Match.
Response
WebhookEventsResponse
string
required
Schema version of the envelope (matches
api_version on every delivery).string[]
required
Fields injected by the webhook envelope on every delivery.
WebhookEventDescriptor[]
required
Every event_type the platform may emit.
string
required
When subscribing to a webhook endpoint, this token in the
events array means ‘all event types’.