Skip to content
Hayonix

API reference · Webhooks

Every event type a webhook can receive, with the JSON Schema of its data

GET/v1/webhooks/event-types
No authentication
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

    Show 8 fields of data
    • objectstringrequired

      Always `webhook_event_type`: the type of this object

      One ofwebhook_event_type

    • typestringrequired

      The event type, as listed in `event_types`

    • productstringrequired

      Product the event belongs to

    • product_labelstringrequired

      Product 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 ofprojectorg

    • subscribablebooleanrequired

      Whether it can be listed in `event_types` (false for the test event, which is only sent on request)

    • summarystringrequired

      When the event is sent, in one sentence

    • data_schemaobjectrequired

      JSON Schema of the event’s `data`

  • next_cursorany JSON | nullrequired

    Pass as `cursor` to get the next page; null when there is no more

Example response
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:

Errors
StatusTypeWhen
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.