v1

latestSwagger 2.02026-08-06114161439.7 KB

webhook

Update requested Webhook record entry

Updates an existing webhook configuration. Allows modification of endpoint URL, trigger events, authentication settings, and delivery preferences.

put/webhook

webhook_idinteger required

ID Of the respective webhook. Type: integer (int32).

webhook_status'active' | 'inactive'

Status of webhook. Type: enum (string); Allowed values: active, inactive.

webhook_Namestring

Name of the Webhook. Type: string.

descriptionstring

Description of the Webhook. Type: string.

webhook_Endpointstring

End Point URl saved with webhook , where response is received. Type: string.

method'POST' | 'PUT'

Type of method. Type: enum (string); Allowed values: POST, PUT.

format'JSON' | 'XML' | 'XML_NEW' | 'XML_CQM' | 'FORM-URLENCODED'

Type of format. Type: enum (string); Allowed values: JSON, XML, XML_NEW, XML_CQM, FORM-URLENCODED.

include_Data_Appendboolean

This enables user to see Data Append of call in response. Type: boolean.

include_DNI_Logsboolean

This enables user to see DNI setting of the call flow in response whom with webhook is attached. Type: boolean.

include_Indicator_Scoresboolean

This enables user to see indicator scores of call in response. Type: boolean.

include_IVR_Keypressesboolean

This enables user to see ivr keypresses of call in response. Type: boolean.

Confirmation of webhook update with result status

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

datastring required

Response payload. Shape varies by endpoint.

entry_countinteger required

The sequential number of the entry in the submitted array. Type: integer (int32).