List available webhook events
Last updated
Was this helpful?
Last updated
Was this helpful?
Please refer to Webhook subscriptionsto know more about valid events and filters for the services.
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
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.
The ID for the workspace.
b4e02c85-c6d2-4b15-8885-e09671799c61The service for the request.
GET /workspaces/{workspaceId}/available-webhooks HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*
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"
]
}
]
}
]
}