List webhook event type rows

Settings module

GET/webhook-eventswebhookEventTypes.list

A webhook event from the domain event table. Returns a cursor page of webhook event type rows the caller may see. The default order is `code` ascending. Supports sparse fieldsets and the filter grammar.

Requires the capability org.settings.read.
OAuth scopes: org.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

webhookEventTypes.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of WebhookEventType

webhookEventTypes.list: WebhookEventType
Field	Type	Required	Description
code	string	Yes	Event name `{resource}.{event}`.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
description	string	Yes	When it fires.Constraints: length 1 to 300
subject	string	Yes	Table whose rows the event describes.Constraints: length 1 to 300

{
  "data": [
    {
      "code": "record.state_changed",
      "description": "A record moved to another state.",
      "subject": "purchase_orders"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/webhook-events" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.webhookEventTypes.listAll()) {
  console.log(row);
}

for row in xos.webhook_event_types.list_all():
    print(row)

xos webhook-event-types list --all