Update an existing webhook registration by event topic

put

API to update an existing webhook registration by event topic

Authorizations

Path parameters

businessIdanyrequired

webhookIdanyrequired

Body

addressstringoptional

configurationobjectoptional

to extend with other dimensions of the webhook topics as we go, i.e. channel_type, fields, etc.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/businesses/{businessId}/update/webhooks/{webhookId}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "address": "text",
    "configuration": {
      "echo": true,
      "channelTypes": [
        "sms"
      ],
      "webengageConfiguration": {
        "webengageToken": "text",
        "webengageWebhookUrl": "text"
      },
      "filters": [
        {
          "field": "campaign_name",
          "expression": "test-campaign-*"
        }
      ]
    }
  }'

200

201

default

200

{
  "id": "text"
}

A successful response.