Call Webhook

Webhook

POST

Call Completed

Configuration

Contact Hatif team to configure the webhook.

Authentication

If a webhookSecret is configured on the channel, all webhook requests include an X-Voxa-Signature header containing an HMAC-SHA256 signature of the raw
JSON request body.

Verifying the Signature

Get the raw request body as a UTF-8 string.

Compute the HMAC-SHA256 hash using your channel's webhookSecret as the key

Convert the hash to a lowercase hexadecimal string.

Compare the computed signature with the X-Voxa-Signature header value.

Retry Policy

Failed deliveries are retried up to 5 times with exponential backoff: 2, 4, 8, 16, 32 minutes.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://your-api-server.com' \
--header 'Content-Type: application/json' \
--data '{
    "callId": "4722cd84-0ec7-4ef5-8c34-1b0150f45f53",
    "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
    "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
    "status": 0,
    "type": 1,
    "callerNumber": "string",
    "calleeNumber": "string",
    "pickupTime": "2019-08-24T14:15:22.123Z",
    "hangupTime": "2019-08-24T14:15:22.123Z",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "userName": "string",
    "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
    "contactNumber": "string",
    "callLength": "00:05:32",
    "aiAgentId": "de6aefb3-8e9c-49f1-b481-86af32c29492",
    "recordingUrl": "string",
    "transcription": {
        "text": "string",
        "words": [
            {
                "text": "string",
                "start": 0,
                "end": 0,
                "type": "string",
                "speaker": "string"
            }
        ]
    },
    "summary": "string",
    "sentiment": 1,
    "evaluationCriteriaResult": [
        {
            "id": "string",
            "dataType": "string",
            "description": "string",
            "value": "string",
            "rationale": "string"
        }
    ],
    "creationTime": "2019-08-24T14:15:22.123Z"
}'

Response Example

{}

Modified at 2026-04-14 12:07:24

List Tags

WhatsApp Message Webhook

Call Webhook

Configuration#

Authentication#