Partial Update Webhook

Applies a selective update to an existing webhook. Only the fields included in the request body are modified; all other fields remain unchanged.

Common use cases

Change webhook name:
{ "webhook_name": "Updated Lead Webhook" }

Update target endpoint:
{ "webhook_endpoint": "https://new-endpoint.example.com/webhook" }

Pause webhook delivery:
{ "webhook_status": "inactive" }

Enable additional data in payload:
{ "include_data_append": true, "include_indicator_scores": true }

Update static parameters:
{ "static_parameters": [{"field_name": "api_key", "field_value": "new_key_123"}] }

Validation

At least one field must be provided in the request body

If updating webhook_endpoint, must be a valid HTTPS URL

Webhook must exist and not be in deleted state

Behavior

Only specified fields are updated; unspecified fields retain current values

webhook_updated is automatically set to current timestamp

If static_parameters is provided, it completely updates existing parameters (not merged)

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --globoff --request PATCH 'https://platform-api.convirza.com/v3/webhooks/{id}' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "webhook_id": 123, "webhook_name": "Updated Webhook Name", "webhook_endpoint": "https://example.com/updated-webhook", "description": "Updated description", "format": "JSON", "method": "GET", "include_data_append": true, "include_dni_logs": false, "include_indicator_scores": true, "include_ivr_keypresses": false, "webhook_status": "active", "static_parameters": [ { "field_name": "api_key", "field_value": "sk_live_1234567890" } ] }'

Partial Update Webhook

Request

Responses