Create Webhook

POST

https://apicfa.convirza.com/v2/webhook

Webhook

Last modified:2026-04-03 12:54:09

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.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Newly created webhook ID and confirmation status

Headers

Body

🟠400

🟠401

🟠403

🟠404

🔴500

⚪default

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://apicfa.convirza.com/v2/webhook' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "webhook_status": "active",
    "org_unit_id": 1,
    "webhook_Name": "string",
    "description": "string",
    "webhook_Endpoint": "string",
    "method": "POST",
    "format": "JSON",
    "include_Data_Append": false,
    "include_DNI_Logs": false,
    "include_Indicator_Scores": false,
    "static_Parameter": [
        {
            "field_Name": "string",
            "field_Value": "string"
        }
    ],
    "include_IVR_Keypresses": false
}'

Response Example

200 - Example 1

[
    {
        "result": "string",
        "data": "string",
        "entry_count": 0
    }
]

Modified at 2026-04-03 12:54:09

List Webhooks

Update Webhook