Skip to main content

List webhook subscriptions

POST 
/api/v1/webhooks/list-subscriptions

Returns a paginated list of webhook subscriptions. Optionally filter by endpoint ID.

The following access conditions are preserved as declared intent and are not implemented by generated code: Tenant request context, Tenant-scoped webhook ownership.

Use this in a guide: Recover a missing backend update · Receive a completed order summary in your backend

Request​

Responses​

Subscriptions listed successfully

List subscriptions for an existing endpoint.​

Section ID: DOC-IN-webhooks-api-listWebhookSubscriptions#example-webhooks-listWebhookSubscriptions-request

Request example

{
  "endpointId": "ep_abc123",
  "page": 1,
  "perPage": 25
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-IN-webhooks-api-listWebhookSubscriptions#example-webhooks-listWebhookSubscriptions-response

Response example

{
  "subscriptions": [
    {
      "id": "example_123",
      "name": "example",
      "endpointId": "https://example.com/resource",
      "eventTypes": [
        "example"
      ],
      "filter": {},
      "retryConfig": {
        "strategy": "RETRY_STRATEGY_LINEAR",
        "retryCount": 1,
        "intervalSeconds": 1
      },
      "createdAt": "2026-09-16T12:00:00Z",
      "externalId": "example_123",
      "updatedAt": "2026-09-16T12:00:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "perPage": 1,
    "totalPages": 1
  }
}

Document ID: DOC-IN-webhooks-api-listWebhookSubscriptions. Section identities and revisions.

SectionStable reference
List webhook subscriptionsDOC-IN-webhooks-api-listWebhookSubscriptions#overview
RequestDOC-IN-webhooks-api-listWebhookSubscriptions#request
ResponsesDOC-IN-webhooks-api-listWebhookSubscriptions#responses