Get a webhook subscription

Get the specified webhook subscription

Get the specified webhook subscription given its ID.

GEThttps://api.bird.com/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}

Path parameters

workspaceId*Workspace ID

The ID for the workspace.

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

organizationId*Organization ID

The ID for the organization.

Example: "cb28a94e-8557-4394-80ea-5bbd2170d434"

webhookSubscriptionId*WebhookSubscriptionID

The ID for the webhook subscription.

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

Response

200404

Get the webhook subscription successfully.

Body

application/json

id*string (uuid)

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

organizationId*string (uuid)

workspaceId*string (uuid)

service*string

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

Example: "channels"

event*string

The name of the event is used to identify the event that is sent to the webhook. For example, to get events regarding SMS messages being sent (outbound), the name of the event would be "sms.outbound".

Example: "sms.outbound"

eventFiltersarray of Notifications_WebhookEventFilter (object)

templatestring

url*URL

The URL of the webhook is used to send events to the webhook. The URL must be a valid URL that is accessible from the internet. For example, if you want to send events to a webhook that is hosted at "https://example.com/webhook", the URL would be "https://example.com/webhook".

Example: "https://example-site.com/resource"

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

signingKeysigningKey

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

Example: "KeV+/HGoIQrxuE5YPCRR6AuQOJveldYNNhbVi1i22qk="

status*Notifications_WebhookSubscriptionStatus (enum)

activeinactive

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "service": "channels",
  "event": "sms.outbound",
  "eventFilters": [
    {
      "key": "channelId",
      "value": "58c44c1d-a6a0-4cb6-9f78-05308de87451"
    }
  ],
  "template": "text",
  "url": "https://example-site.com/resource",
  "signingKey": "KeV+/HGoIQrxuE5YPCRR6AuQOJveldYNNhbVi1i22qk=",
  "status": "active",
  "createdAt": "2024-11-21T15:40:36.855Z",
  "updatedAt": "2024-11-21T15:40:36.855Z"
}