Create a webhook subscription

The following endpoint will create a webhook based on the service, event and eventfilters provided.

Create a Workspace Webhook Subscription

Create a workspace webhook subscription

POST/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions

Authorization

useraccessKey

Path parameters

workspaceId*Workspace ID

The ID for the workspace.

organizationId*Organization ID

The ID for the organization.

Body

application/json

service*string

event*string

eventFiltersnullable array of WebhookEventFilter (object)

templatestring

url*string

signingKeystring

Response

201400409422

Created

Body

application/json

id*string (uuid)

organizationId*string (uuid)

workspaceId*string (uuid)

service*string

event*string

eventFiltersarray of WebhookEventFilter (object)

templatestring

url*string

signingKeystring

status*WebhookSubscriptionStatus (enum)

activeinactive

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "service": "text",
      "event": "text",
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "service": "text",
  "event": "text",
  "eventFilters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "template": "text",
  "url": "text",
  "signingKey": "text",
  "status": "active",
  "createdAt": "2024-04-29T10:25:49.550Z",
  "updatedAt": "2024-04-29T10:25:49.550Z"
}

WebhookRequest object

Property	Type	Description	Required
signingKey	string	Set your own signing key to validate webhooks	Yes
event	string	The event you are subscribing to	Yes
eventFilters[]	object	Event filters are inclusive, which means you will only get events for filters you add
eventFilters.key	string	Event filters are inclusive e.g. adding a key and value will mean getting events for that value	Yes
eventFilters.value	string	The filter value.	Yes
service	string	The service that will be sending the webhooks.
url	string	A valid HTTPS endpoint to receive the webhooks	Yes
template	string	Will use a specific template for the webhook body

Currently, several subscriptions can be created.

Please examine the examples provided below.

For voice.outbound:

{
  "service": "channels",
  "event": "voice.outbound",
  "url": "https://yoururl.com",
  "signingKey": "mysecretkey",
  "eventFilters": []
}

For voice.inbound:

{
  "service": "channels",
  "event": "voice.inbound",
  "url": "https://yoururl.com",
  "signingKey": "mysecretkey",
  "eventFilters": [
    {
      "key": "channelId",
      "value": "b827924e-9789-4c2f-a4d5-b352175354f6"
    },
    {
      "key": "status",
      "value": "completed"
    },
    {
      "key": "status",
      "value": "starting"
    }
  ]
}

For voice events (voice.inbound and voice.outbound), there are various filtering options available, such as channel ID and call status.