Get webhook registrations for business

PreviousUpdate an existing webhook registration by event topic NextDelete a webhook registration for business

Last updated 2 years ago

API to get a webhook registrations for business

get

/v1/businesses/{businessId}/webhooks

Authorizations

Path parameters

businessIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/businesses/{businessId}/webhooks' \
  --header 'X-API-Key: YOUR_API_KEY'

200

201

default

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

A successful response.