List available webhook events

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

get

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.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID for the workspace.

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

Query parameters

servicestring · enumOptional

The service for the request.

Possible values:

Responses

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.

application/json

get

/workspaces/{workspaceId}/available-webhooks

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/available-webhooks HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

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.

{
  "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)