Get webhook registrations for business

API to get a webhook registrations for business

GET/v1/businesses/{businessId}/webhooks

Path parameters

businessId*string

Response

200201default

A successful response.

Body

application/json

entitywebhookWebhookCollection (object)

Request

JavaScriptCurl

const response = await fetch('/v1/businesses/{businessId}/webhooks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "entity": {
    "businessId": "text",
    "webhooks": [
      {
        "topic": "topic_unspecified",
        "address": "text",
        "id": "text",
        "configuration": {
          "echo": true,
          "channelTypes": [
            "sms"
          ],
          "webengageConfiguration": {
            "webengageToken": "text",
            "webengageWebhookUrl": "text"
          },
          "filters": [
            {
              "field": "campaign_name",
              "expression": "test-campaign-*"
            }
          ]
        }
      }
    ]
  }
}