Update Webhook

Performs a full update of a webhook configuration. All fields in the request body overwrite the stored values.

⚠️ 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.

Constraints

webhook_endpoint must be a valid HTTPS URL.

The webhook must not be in a deleted state.

The webhook ID and creation metadata (created_at, created_by) are never overwritten.

updated_at and updated_by are set automatically.

Note: The webhook remains active during and after the update. Event delivery continues uninterrupted.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location --request PUT 'https://platform-api.convirza.com/v3/webhooks/' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "webhook_name": "Lead Webhook", "webhook_endpoint": "https://example.com/webhook", "description": "Sends lead data to CRM system", "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": "Lead Notification Webhook", "webhook_Endpoint": "https://api.example.com/webhooks/leads", "include_Data_Append": false, "include_DNI_Logs": false, "include_Indicator_Scores": false, "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" } ] }'

Request

Responses