List available webhook events

List the available webhook events that can be subscribed to.

This endpoint will return a list of services and the events that can be subscribed to.

GEThttps://nest.messagebird.one/workspaces/{workspaceId}/available-webhooks

Path parameters

workspaceId*Workspace ID

The ID for the workspace.

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

Query parameters

Response

The list of available webhook events was returned successfully. It can be an empty results list if no webhook event is available for the given event filters/services set.

Body

resultsarray of Notifications_AvailableWebhook (object)

Request

Response

Available events

For more details and a comprehensive understanding of the available webhook events, refer to the following pages:

Last updated 1 day ago

{
  "results": [
    {
      "service": "channels",
      "events": [
        {
          "name": "sms.outbound",
          "filterKeys": [
            "channelId",
            "interactionType",
            "messageStatus",
            "platformId",
            "channelStatus"
          ]
        }
      ]
    }
  ]
}