Skip to content

List webhook delivery rows

Settings module

GET/webhook-deliverieswebhookDeliveries.list

A webhook delivery attempt, replayable from Atlas. Returns a cursor page of webhook delivery rows the caller may see. The default order is `created_at` 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

webhookDeliveries.list: Path and query parameters
FieldTypeRequiredDescription
limitLimitNoPage size. Default 50, maximum 200.Constraints: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort 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_]*)*$
filterFilterNoFilter 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 WebhookDelivery

webhookDeliveries.list: WebhookDelivery
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the webhook delivery.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
webhook_endpoint_idstring (uuid)YesIdentifier of the endpoint.
delivery_statusstringYesDelivery status. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
delivered_atstring (date-time) | nullYesWhen it was delivered.
domain_event_idstring (uuid)YesIdentifier of the domain event delivered; every attempt sends the same body built from it.
attempt_countintegerYesAttempts started.Constraints: range 0 to any
next_attempt_atstring (date-time)YesWhen the dispatcher may try next.
last_attempt_atstring (date-time) | nullYesWhen the latest attempt started.
last_response_statusinteger | nullYesHTTP status of the latest response; null when no response arrived.Constraints: range 100 to any
last_errorstring | nullYesNetwork or HTTP error of the latest failed attempt.Constraints: length 1 to 2000
replay_requested_bystring (uuid) | nullYesIdentifier of the person who replayed the event from Atlas.
{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "webhook_endpoint_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "delivery_status": "Delivered",
      "delivered_at": "2026-10-08T14:30:00Z",
      "domain_event_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "attempt_count": 1,
      "next_attempt_at": "2026-10-08T14:30:00Z",
      "last_attempt_at": "2026-10-08T14:30:00Z",
      "last_response_status": 200,
      "last_error": "Connection timed out.",
      "replay_requested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/webhook-deliveries" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.webhookDeliveries.listAll()) {
  console.log(row);
}
for row in xos.webhook_deliveries.list_all():
    print(row)
xos webhook-deliveries list --all