Create a webhook subscription
To know more about how to use signingKeys, please refer to the section Verifying a webhook.
Examples
Let's establish some of our data that will be used in the following examples:
Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352
Organization ID: 823fbfaf-f14e-4693-b55a-8ec1c17d649e
AccessKey: abcd
Creating a subscription for events of a specific channel
In this example, we're sending event notifications for each sent message by the specified channel. To know more about valid events for each platform (e.g. SMS, E-mail), please refer to this documentation.
curl -X POST "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" \
-d '{
"service": "channels",
"event": "sms.outbound",
"url": "https://webhook.site/68be485e-5faa-4363-8033-2e3d236830db",
"eventFilters": [
{
"key": "channelId",
"value": "3e3a68da-85a2-4b12-b114-b2c28117bf37"
}
]
}'
Creating a webhook subscription and filtering events based on interaction type
This will send notification events to the specified webhook URL when an e-mail sent by the specified channel is opened by end-customers. To know more about all supported interactions, refer to this documentation.
curl -X POST "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" \
-d '{
"service": "channels",
"event": "email.interaction",
"url": "https://webhook.site/68be485e-5faa-4363-8033-2e3d236830db",
"eventFilters": [
{
"key": "channelId",
"value": "3e3a68da-85a2-4b12-b114-b2c28117bf37"
{
"key": "interactionType",
"value": "opened"
}
],
}'
Creating a webhook subscription without filtering
This will send notification events to the specified webhook URL for all email interactions. To know more about all supported interactions, refer to this documentation.
curl -X POST "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" \
-d '{
"service": "channels",
"event": "email.interaction",
"url": "https://webhook.site/68be485e-5faa-4363-8033-2e3d236830db",
}'
Last updated
Was this helpful?