webhook

Create a new Webhook record entry

Creates a new webhook configuration for receiving real-time event notifications. Webhooks enable integration with external systems by sending HTTP requests when specified events occur.

post/webhook

Request

  • Base URL
    https://apicfa.conviza.com/v2
  • URL
    https://apicfa.conviza.com/v2/webhook
  • Auth
    none declared

Request body

webhook_status'active' | 'inactive' required

The current status of webhook. Type: enum (string); Allowed values: active, inactive.

org_unit_idinteger required

Organization unit (group) ID. Integer. Same concept as group_id; used in newer endpoints.

webhook_Namestring required

Name of the Webhook. Type: string.

descriptionstring

Description of Webhook. Type: string.

webhook_Endpointstring required

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

method'POST' | 'PUT' required

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

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

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.

Response

Newly created webhook ID and confirmation 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).

Changes

No recorded changes to this operation across all 2 revisions of this API.