List available webhook events

List the available webhook services and filters a customer can use to build its subscription.

List the available webhook services and filters a customer can use to build its subscription. An example of filter would be to subscribe all events from the service channels and using as filter a channelId.

GEThttps://api.bird.com/workspaces/{workspaceId}/available-webhooks

Path parameters

workspaceId*Workspace ID

The ID for the workspace.

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

Query parameters

Response

200

The list of available webhook events was returned successfully. It can be an empty results list if no webhook event is available for the given event filters/services set.

Body

application/json

resultsarray of Notifications_AvailableWebhook (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "results": [
    {
      "service": "channels",
      "events": [
        {
          "name": "sms.outbound",
          "filterKeys": [
            "channelId"
          ]
        }
      ]
    }
  ]
}

Please refer to Webhook subscriptionsto know more about valid events and filters for the services.

Examples

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

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

• AccessKey: abcd

Listing available webhook events

Request

curl -X DELETE "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/lists/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd"

Response (204 No Content)