Get a webhook subscription

Get the specified webhook subscription

get

Get the specified webhook subscription given its ID.

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

webhookSubscriptionIdstring · uuidRequired

The ID for the webhook subscription.

Example: 852883af-5f68-4204-b611-7ee8db9600f4

Responses

200

The webhook subscription was found and returned successfully.

application/json

idstring · uuidRequired

The unique identifier for the webhook subscription. This identifier is used to reference the webhook subscription in other API calls.

organizationIdstring · uuidRequiredExample: cb28a94e-8557-4394-80ea-5bbd2170d434

workspaceIdstring · uuidRequiredExample: b4e02c85-c6d2-4b15-8885-e09671799c61

servicestring · enumRequired

The service that the webhook is subscribed to. For example, to get events regarding channels, the service would be channels.

Possible values:

eventstringRequired

The event name identifies the webhook event, such as sms.outbound for notifications about SMS messages being sent.

Example: sms.outbound

templatestringOptional

Used for our Exit APIs for Twilio and Sinch. More information can be found here for Twilio and here for Sinch.

Example: twilio

urlstringRequired

The URL of the webhook is used to send events to the webhook. The URL must be a valid URL that respects the established pattern and is accessible from the internet.

Example: https://example.com/webhookPattern: ^https://([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(/[^\s]*)?$

signingKeystringOptional

The signing key for the webhook and can be used to verify the authenticity of the webhook.

Example: KeV+/HGoIQrxuE5YPCRR6AuQOJveldYNNhbVi1i22qk=

statusstring · enumRequiredPossible values:

statusReasonstringOptional

A human-readable explanation for the current status of the webhook subscription.

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

404

The specified webhook subscription was not found.

application/json

get

/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
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",
  "statusReason": "text",
  "createdAt": "2026-03-09T12:56:28.784Z",
  "updatedAt": "2026-03-09T12:56:28.784Z"
}

---

Examples

Let's establish some of our data that will be used in the following example:

• Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

• Previously created Webhook subscription ID: 0edf722b-93b4-4451-8a5d-4fafba5cdf8b

• AccessKey: abcd

Getting a previously created webhook subscription

Request

curl -X GET "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/webhook-subscriptions/0edf722b-93b4-4451-8a5d-4fafba5cdf8b
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd"

Response (200 - OK)