Create Webhook

Creates a new outbound webhook that delivers event notifications to your specified endpoint whenever call or SMS events occur in your account.

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

Required fields

webhook_name — Display name for identifying this webhook

webhook_endpoint — HTTPS URL where event notifications will be sent

format — Response format: JSON, XML, XML_CQM, or FORM_DATA

method — HTTP method: GET, POST, PUT, or PATCH

Optional configuration

description — Human-readable description of the webhook purpose

include_data_append — Include appended custom data fields in the payload

include_dni_logs — Include Dynamic Number Insertion (DNI) tracking logs

include_indicator_scores — Include call quality and conversion indicator scores

include_ivr_keypresses — Include Interactive Voice Response (IVR) keypress data

webhook_status — Initial status: active (default), inactive, or deleted

static_parameters — Array of custom key-value pairs to include in every webhook request

Each parameter requires field_name (string) and field_value (string)

Example: [{"field_name": "api_key", "field_value": "sk_live_1234567890"}]

Behavior

Webhooks are activated immediately upon creation

Creation timestamp and user ID are automatically recorded

Failed deliveries can be retried based on your account settings

Response
Returns the newly created webhook ID for future reference and management.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location 'https://platform-api.convirza.com/v3/webhooks' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "webhook_name": "Lead Webhook", "webhook_endpoint": "https://example.com/webhook", "description": "Webhook for lead notifications", "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" } ] }'

Create Webhook

Request

Responses