Webhook subscriptions

List webhook subscriptions

Copy page

Lists the authenticated Store's outbound webhook subscriptions in stable creation order. Requires webhooks:read.

GET/api/v3/webhook-subscriptions

List webhook subscriptions

Lists the authenticated Store's outbound webhook subscriptions in stable creation order. Requires `webhooks:read`. Follow `links.next` while `pagination.has_more` is true. Signing secrets and provider metadata are never returned.

List webhook subscriptions

Click Send to see the live response.

Overview

Follow links.next while pagination.has_more is true. Signing secrets and provider metadata are never returned.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: webhooks:read

Query parameters

limitstringquery

Page size from 1 to 100. Defaults to 20.

Example: 20

List webhook subscriptions

curl https://web.signcustomiser.com/api/v3/webhook-subscriptions?limit=20&cursor= \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

{
  "data": [
    {
      "object": "webhook_subscription",
      "id": 42,
      "topic": "product:created",
      "url": "https://example.com/webhooks/sign-customiser",
      "created_at": "2026-07-22T00:00:00Z",
      "updated_at": "2026-07-22T00:00:00Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/webhook-subscriptions",
    "documentation": "https://www.signcustomiser.com/help/api/",
    "next": null
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
  "title": "Missing API key",
  "status": 401,
  "code": "missing_api_key",
  "detail": "Provide a store API key as a bearer token.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This operation requires the webhooks:read scope.",
  "required_scopes": [
    "webhooks:read"
  ],
  "granted_scopes": [
    "webhooks:write"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/invalid_parameter",
  "title": "Invalid query parameter",
  "status": 422,
  "code": "invalid_parameter",
  "detail": "The limit parameter must be an integer between 1 and 100.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "Wait before retrying.",
  "retry_after": 60,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}