Webhook Subscriptions

List recent deliveries

Returns delivery attempts, newest first. Filter by status, event type, or time.

get/webhooks/{webhookId}/deliveries

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/webhooks/{webhookId}/deliveries
  • Auth: HTTP bearer

Path parameters

webhookIdstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Webhook subscription identifier (whk_…).

Query parameters

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

order'asc' | 'desc'

Sort direction.

withCountboolean

Include the total number of matching items. Defaults to false.

status'pending' | 'success' | 'failed' | 'blocked' | 'dropped'

Outcome of a delivery. pending may be retried. success, failed, blocked, and dropped are final.

Only deliveries with this attempt outcome.

event'transaction.created' | 'transaction.updated' | 'budget.changed' | 'purchaseOrder.created' | 'purchaseOrder.pending' | 'purchaseOrder.approved' | 'purchaseOrder.rejected' | 'purchaseOrder.actualizing' | 'purchaseOrder.paid' | 'purchaseOrder.void' | 'document.created' | 'document.linked' | 'document.unlinked' | 'document.deleted' | 'incentive.added' | 'pack.installed' | 'pack.uninstalled'

Event types available for webhook subscriptions.

Example:transaction.created

Only deliveries for this event type.

sincestring date-time

Only deliveries that occurred at or after this ISO-8601 timestamp. An end before the start (when paired with sort bounds) returns 400 invalid_date_range.

Response

A page of delivery attempts.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total matching items; present only when withCount=true was requested.

truncatedboolean

Whether inaccessible records shortened this page.

Example response

{
  "data": [
    {
      "id": "txn_8f2a1c9e",
      "entityKind": "transaction",
      "entityId": "txn_8f2a1c9e",
      "requestUrl": "https://hooks.example.com/saturation",
      "responseStatus": 200,
      "attempts": 1
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.