List webhook subscriptions

List all webhook subscriptions

This endpoint allows you to list all webhook subscriptions for a workspace. You can filter the subscriptions by interactionType, status, and other filters. This will return a maximum of 100 webhook subscriptions per page, but 10 as default. You can use the limit and cursor query parameters to paginate the results. Learn more about pagination in the Common API Usage pagination section.

GEThttps://api.bird.com/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions

Path parameters

workspaceId*Workspace ID

The ID for the workspace.

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

organizationId*Organization ID

The ID for the organization.

Example: "cb28a94e-8557-4394-80ea-5bbd2170d434"

Query parameters

Response

200

A list of webhook subscriptions was returned. The list can be empty if no webhook subscriptions are found.

Body

application/json

resultsarray of Notifications_WebhookSubscription (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Example: "WyIyMDI0LTExLTE1VDEzOjM0OjQ1Ljc3NTYzMDE0OVoiLCJhMGEwM2IxOS03NTQ5LTRlZmUtOTBjZS1jNzdlYzI0ZjZmN2YiXQ=="

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "cb28a94e-8557-4394-80ea-5bbd2170d434",
      "workspaceId": "b4e02c85-c6d2-4b15-8885-e09671799c61",
      "service": "channels",
      "event": "sms.outbound",
      "eventFilters": [
        {
          "key": "channelId",
          "value": "clicked"
        }
      ],
      "template": "twilio",
      "url": "https://example.com/webhook",
      "signingKey": "KeV+/HGoIQrxuE5YPCRR6AuQOJveldYNNhbVi1i22qk=",
      "status": "active",
      "createdAt": "2024-12-21T16:12:16.375Z",
      "updatedAt": "2024-12-21T16:12:16.375Z"
    }
  ],
  "nextPageToken": "WyIyMDI0LTExLTE1VDEzOjM0OjQ1Ljc3NTYzMDE0OVoiLCJhMGEwM2IxOS03NTQ5LTRlZmUtOTBjZS1jNzdlYzI0ZjZmN2YiXQ=="
}

Examples

Let's establish some of our data that will be used in the following example:

• Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

• Organization ID: 823fbfaf-f14e-4693-b55a-8ec1c17d649e

• AccessKey: abcd

Request

curl -X GET "https://api.bird.com/organizations/823fbfaf-f14e-4693-b55a-8ec1c17d649e/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/webhook-subscriptions" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd"

Response (200 - OK)

{
  "nextPageToken": "WyJvcmdhbml6YXRpb25zI2ZmMWE1OTQ5LWE3MDQtNDhkMi05OWQ5LWIyY2RmYjdmZWYzZSN3b3Jrc3BhY2VzI2IyZDdhMDEzLTg2ZGYtNGFhNy04MjQ1LThmMzcxNWM4N2FlMiN3ZWJob29rLXN1YnNjcmlwdGlvbnMiLCJ3ZWJob29rLXN1YnNjcmlwdGlvbiNhNWMzOWE1Mi0wMDViLTQwOWUtOTM3ZC0yNzE3YzkxODk3OWMiLCJvcmdhbml6YXRpb25zI2ZmMWE1OTQ5LWE3MDQtNDhkMi05OWQ5LWIyY2RmYjdmZWYzZSN3b3Jrc3BhY2VzI2IyZDdhMDEzLTg2ZGYtNGFhNy04MjQ1LThmMzcxNWM4N2FlMiN3ZWJob29rLXN1YnNjcmlwdGlvbnMiLCJ3ZWJob29rLXN1YnNjcmlwdGlvbiNhNWMzOWE1Mi0wMDViLTQwOWUtOTM3ZC0yNzE3YzkxODk3OWMiXQ==",
  "results": [
    {
      "id": "b02e99b2-dc38-4e2d-b349-d9e1fd772c44",
      "organizationId": "823fbfaf-f14e-4693-b55a-8ec1c17d649e",
      "workspaceId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
      "service": "payments",
      "event": "intent",
      "template": "",
      "url": "https://www.test.com",
      "status": "active",
      "createdAt": "2024-09-30T12:31:36.106613753Z",
      "updatedAt": "2024-09-30T12:31:36.106613843Z"
    },
    {
      "id": "a5c39a52-005b-409e-937d-2717c918979c",
      "organizationId": "823fbfaf-f14e-4693-b55a-8ec1c17d649e",
      "workspaceId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
      "service": "channels",
      "event": "whatsapp.interaction",
      "eventFilters": [
        {
          "key": "channelId",
          "value": "f788aecc-4886-5ee9-b392-de28bc2fd063"
        },
        {
          "key": "interactionType",
          "value": "read"
        }
      ],
      "template": "",
      "url": "https://webhook.site/68be485e-5faa-4363-8033-2e3d236830db",
      "status": "active",
      "createdAt": "2024-11-21T10:44:38.824639879Z",
      "updatedAt": "2024-11-21T10:44:38.824640035Z"
    }
  ]

Note: if you have more than 10 webhook subscriptions, the results may be paginated. To know more about how to use the nextPageToken to get the following results, refer to this pagination documentation.