List available webhook events

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

Last updated 2 months ago

Was this helpful?

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.

get

/workspaces/{workspaceId}/available-webhooks

Authorizations

Path parameters

workspaceIdWorkspace IDrequired

The ID for the workspace.

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

Query parameters

EventFiltersobject

The event filters for the request.

servicestring · enum

The service for the request.

Options: channels, numbers, conversations, payments

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.bird.com/workspaces/{workspaceId}/available-webhooks' \
  --header 'Authorization: Bearer JWT'

200

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

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.