Update Webhook - Connectly

PUT

businesses

{businessId}

update

webhooks

{webhookId}

Update Webhook

curl --request PUT \
  --url https://api.example.com/v1/businesses/{businessId}/update/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "configuration": {
    "echo": true,
    "channelTypes": [
      {}
    ],
    "filters": [
      {
        "field": "<string>",
        "expression": "<string>"
      }
    ],
    "webengageConfiguration": {
      "webengageToken": "<string>",
      "webengageWebhookUrl": "<string>"
    }
  }
}
'

Update the destination URL or configuration of an existing webhook registration. Only the fields you include in the request body are changed — omitting a field keeps its current value.

You cannot change the topic of an existing registration. To switch topics, delete the registration and create a new one.

Endpoint

PUT https://api.connectly.ai/v1/businesses/{businessId}/update/webhooks/{webhookId}

Retrieve the webhookId from the Get webhooks response.

Request body

address

string

New destination URL. Must be a publicly accessible HTTPS endpoint.

configuration

object

Updated configuration. Any fields you provide overwrite the existing values.

Show configuration properties

echo

boolean

When true, outbound messages sent by your business are echoed back to this webhook.

channelTypes

array

List of channel types to filter events by (e.g. ["whatsapp"]).

filters

array

Updated filter rules. Replaces the existing filters entirely.

Show filter properties

field

string

The event field to match on (e.g. campaign_name).

expression

string

Glob-style expression to match against the field value (e.g. prod-*).

webengageConfiguration

object

Required when the webhook type is webengage.

Show webengageConfiguration properties

webengageToken

string

Your WebEngage API token.

webengageWebhookUrl

string

Your WebEngage webhook URL.

Examples

Update address only

curl --request PUT \
  --url https://api.connectly.ai/v1/businesses/{businessId}/update/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --data '{
    "address": "https://example.com/webhook-v2"
  }'

Update configuration only

curl --request PUT \
  --url https://api.connectly.ai/v1/businesses/{businessId}/update/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --data '{
    "configuration": {
      "echo": true,
      "channelTypes": ["whatsapp"],
      "filters": [
        { "field": "campaign_name", "expression": "prod-*" }
      ]
    }
  }'

Update both address and configuration

curl --request PUT \
  --url https://api.connectly.ai/v1/businesses/{businessId}/update/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --data '{
    "address": "https://example.com/webhook-v2",
    "configuration": {
      "echo": false,
      "channelTypes": ["whatsapp"],
      "filters": [
        { "field": "campaign_name", "expression": "prod-*" }
      ]
    }
  }'

Response

{ "id": "wh_01ARZ3NDEKTSV4RRFFQ69G5FAV" }

Error responses

Status	Meaning
`400`	Malformed body or invalid field values.
`401`	Missing or invalid `X-API-Key`.
`404`	The specified `webhookId` does not exist.
`500`	Internal server error.

Get Webhooks

Delete Webhook

⌘I

​Endpoint

​Request body

​Examples

​Response

​Error responses

Endpoint

Request body

Examples

Response

Error responses