Create Webhook

Creates a new outbound webhook that will deliver event notifications to a target URL whenever specified call or SMS events occur in your account.

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

How webhooks work
When a configured event fires (e.g. a call ends, an SMS is received), the platform sends an HTTP POST request to your endpoint_url with a JSON payload describing the event. Your server should respond with HTTP 200 within 10 seconds.

Required fields

webhook_name (or deprecated webhook_Name) — name for the webhook

webhook_endpoint (or deprecated webhook_Endpoint) — the HTTPS URL that will receive the event payload

format — response format (JSON, XML, XML_CQM, FORM_DATA)

method — HTTP method (GET, POST, PUT, PATCH)

Optional configuration

description — webhook description

include_data_append — include data append in payload

include_dni_logs — include DNI logs in payload

include_indicator_scores — include indicator scores in payload

include_ivr_keypresses — include IVR keypresses in payload

webhook_status — webhook status (active, inactive, deleted)

static_parameters — array of static parameters with field_name and field_value

Behavior

Webhooks are activated immediately after creation.

created_at and created_by (authenticated user ID) are recorded automatically.

Response
Returns the new webhook ID and a success flag.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location --request POST '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