Get a webhook subscription
Get the specified webhook subscription given its ID.
Authorizations
Path parameters
workspaceIdstring · uuidRequiredExample:
The ID for the workspace.
b4e02c85-c6d2-4b15-8885-e09671799c61
organizationIdstring · uuidRequiredExample:
The ID for the organization.
cb28a94e-8557-4394-80ea-5bbd2170d434
webhookSubscriptionIdstring · uuidRequiredExample:
The ID for the webhook subscription.
852883af-5f68-4204-b611-7ee8db9600f4
Responses
200
The webhook subscription was found and returned successfully.
application/json
404
The specified webhook subscription was not found.
application/json
get
GET /organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId} HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"organizationId": "cb28a94e-8557-4394-80ea-5bbd2170d434",
"workspaceId": "b4e02c85-c6d2-4b15-8885-e09671799c61",
"service": "channels",
"event": "sms.outbound",
"eventFilters": [
{
"key": "channelId",
"value": "clicked"
}
],
"template": "twilio",
"url": "https://example.com/webhook",
"signingKey": "KeV+/HGoIQrxuE5YPCRR6AuQOJveldYNNhbVi1i22qk=",
"status": "active",
"createdAt": "2025-06-22T19:05:31.240Z",
"updatedAt": "2025-06-22T19:05:31.240Z"
}
Examples
Let's establish some of our data that will be used in the following example:
Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352
Organization ID: 823fbfaf-f14e-4693-b55a-8ec1c17d649e
Previously created Webhook subscription ID: 0edf722b-93b4-4451-8a5d-4fafba5cdf8b
AccessKey: abcd
Getting a previously created webhook subscription
curl -X GET "https://api.bird.com/organizations/823fbfaf-f14e-4693-b55a-8ec1c17d649e/workspaces/{{workspaceId}}/webhook-subscriptions/0edf722b-93b4-4451-8a5d-4fafba5cdf8b
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd"
Last updated
Was this helpful?