Sign in
Webhook Subscriptions

List webhook subscriptions

Returns webhook subscriptions. Filter by event type or active state.

get/webhooks

Request

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

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.

eventsWebhookEvent[]

Only subscriptions that include at least one of these comma-separated event types.

[
  "transaction.created"
]
activeboolean

Filter by whether the subscription is currently delivering (isActive).

Response

A page of webhook subscriptions.

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",
      "url": "https://hooks.example.com/saturation",
      "events": [
        "transaction.created"
      ],
      "workspaceId": "txn_8f2a1c9e",
      "projectId": "txn_8f2a1c9e"
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

Changes to this operation have not been checked yet.