Partial Update Webhook

Applies a partial update to a webhook, modifying only the fields present in the request body.

⚠️ DEPRECATION NOTICE
PascalCase field names (webhook_Name, webhook_Endpoint, include_Data_Append, include_DNI_Logs, include_Indicator_Scores, include_IVR_Keypresses, static_Parameter) are DEPRECATED.
Please use snake_case field names (webhook_name, webhook_endpoint, include_data_append, include_dni_logs, include_indicator_scores, include_ivr_keypresses, static_parameters) instead.
Both formats are currently supported for backwards compatibility, but PascalCase fields will be removed in v4 API.

Common use cases

Update name: { "webhook_name": "Updated Name" }

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

Update status: { "webhook_status": "inactive" }

Update includes: { "include_data_append": true }

Constraints

At least one field must be present.

If webhook_endpoint is changed, it must be a valid HTTPS URL.

The webhook must not be in a deleted state.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location --request PATCH 'https://platform-api.convirza.com/v3/webhooks/' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "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", "field_Name": "api_key", "field_Value": "sk_live_1234567890" } ], "webhook_Name": "Updated Webhook Name", "webhook_Endpoint": "https://api.example.com/webhooks/updated", "include_Data_Append": true, "include_DNI_Logs": false, "include_Indicator_Scores": true, "include_IVR_Keypresses": false, "static_Parameter": [ { "field_name": "api_key", "field_value": "sk_live_1234567890", "field_Name": "api_key", "field_Value": "your-api-key-here" } ] }'

Partial Update Webhook

Request

Responses