API reference · Webhooks
Every event type a webhook can receive, with the JSON Schema of its data
/v1/webhooks/event-types- TypeScript
client.webhooks.listEventTypes()- Python
client.webhooks.list_event_types()- CLI
hayonix webhooks event-types
The whole catalogue in one response (next_cursor is always null). Needs no authentication.
None: this operation is public.
Examples
The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.
curl -sS "$API_BASE_URL/webhooks/event-types" \
-H "Authorization: Bearer $API_KEY"Request
Response
200 JSON — The event catalogue
The items
ShowHide 8 fields of
dataobjectstringrequiredAlways `webhook_event_type`: the type of this object
One of
webhook_event_typetypestringrequiredThe event type, as listed in `event_types`
productstringrequiredProduct the event belongs to
product_labelstringrequiredProduct name to show people
scopestringrequired`project`: sent to the destinations of the project it happened in; `org`: an organization event, sent to destinations with `org_events: true`
One of
projectorgsubscribablebooleanrequiredWhether it can be listed in `event_types` (false for the test event, which is only sent on request)
summarystringrequiredWhen the event is sent, in one sentence
data_schemaobjectrequiredJSON Schema of the event’s `data`
next_cursorany JSON | nullrequiredPass as `cursor` to get the next page; null when there is no more
Example response
{
"data": [
{
"object": "webhook_event_type",
"type": "pod.running",
"product": "pods",
"product_label": "string",
"scope": "project",
"subscribable": true,
"summary": "string",
"data_schema": {}
}
],
"next_cursor": {}
}Errors
Errors use the standard envelope. What this operation can answer:
| Status | Type | When |
|---|---|---|
429 | rate_limit_error rate_limited | Too many requests; retry after retry-after seconds. |