v2

latestOpenAPI 3.1.02026-08-074390396.7 KB

Webhook Subscriptions

List Webhook Subscriptions

List all webhook subscriptions with pagination and filtering options

get/api/v1/webhook-subscriptions

Query parameters

perPageinteger

Record limiter per page. Default is 5, max is 100

pageinteger

Page number. Default is 1

entityIdstring

Filter by entity ID (for webhook subscriptions scoped to an entity).

Response

Webhook subscriptions listed successfully

Example response

{
  "data": [
    {
      "id": "01983282-53cf-7e16-b5e1-dd0de4ce02fa",
      "attributes": {
        "url": "https://example.com/webhook",
        "secretKey": "a2e2c04657b924390d2a2623439c65734d07e0f8",
        "scopeName": "Test Organisation"
      }
    }
  ]
}