List available webhook events

The following endpoint lists all of the available webhook events that are available to subscribe to

List the available webhooks that can be subscribed to.

List the available webhooks that can be subscribed to.

GET/workspaces/{workspaceId}/available-webhooks

Authorization

useraccessKey

Path parameters

workspaceId*Workspace ID

The ID for the workspace.

Query parameters

Response

200

List of webhook-events.

Body

application/json

resultsarray of AvailableWebhook (object)

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/available-webhooks', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "results": [
    {
      "service": "text",
      "events": [
        {
          "name": "text",
          "filterKeys": [
            "text"
          ]
        }
      ]
    }
  ]
}

Example Request

The following example will list of all the available webhook events for your workspace

curl --location 'https://nest.messagebird.com/workspaces/<your-workspace-id>/available-webhooks' \
--header 'Accept: application/json' \
--header 'Authorization: AccessKey <your-access-key>'

Response

In the example response below, it is possible to subscribe multiple webhooks events:

1. sms.inbound: Incoming messages

2. sms.outbound: Status updates for outgoing messages

3. voice.inbound: Events for inbound calls

4. voice.outbound: Events for outbound calls

Event filterKeys are inclusive, meaning to get updates for a specific channel the channelId must be included in the filterKey. Check the example below.

{
    "results": [
        {
            "service": "channels",
            "events": [
                {
                    "name": "sms.inbound",
                    "filterKeys": [
                        "channelId"
                    ]
                },
                {
                    "name": "sms.outbound",
                    "filterKeys": [
                        "channelId"
                    ]
                }
            ]
        }
    ]
}