List webhook subscriptions

List all webhook subscriptions

get

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.

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidrequired

The ID for the workspace.

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

organizationIdstring · uuidrequired

The ID for the organization.

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

Query parameters

SearchFiltersobjectoptional

You can use this parameter to filter the results based on the search criteria. To get all subscriptions for the service channels, you can use it like this: SearchFilter[service]=channels

limitinteger · min: 1 · max: 100 · default: 10optional

Limits the number of results to return. The default value is 10, the minimum is one and the maximum is 100.

pageTokenstring · max: 8000optional

Pagination token that keeps of track of the current position in the list. Use it to get remaining results that were paginated. To learn more, please refer to Common API Usage Pagination section.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.bird.com/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions' \
  --header 'Authorization: Bearer JWT'

200

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": "2025-03-23T02:01:42.978Z",
      "updatedAt": "2025-03-23T02:01:42.978Z"
    }
  ],
  "nextPageToken": "WyIyMDI0LTExLTE1VDEzOjM0OjQ1Ljc3NTYzMDE0OVoiLCJhMGEwM2IxOS03NTQ5LTRlZmUtOTBjZS1jNzdlYzI0ZjZmN2YiXQ=="
}

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

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.