v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0114775543.6 KB

Webhooks

pre-conversation

Fired before the agent begins speaking. Use this to enrich CRM data, log call attempts, or gate outbound calls.

Does not contain callData, transcript, variables, analytics, or recordingUrl. callData is on post-conversation and analytics-completed; transcript, variables, and recordingUrl are only on post-conversation; analytics is only on analytics-completed.

Delivery. Sent as an HTTP POST with a 30 second timeout. Non-2xx responses and network errors mark the delivery as failed; there are no retries. Verify the X-Signature header before trusting the body. For the full field-level reference, see the Webhooks guide.

post/webhook-events/pre-conversation

Headers

X-Signaturestring required

Example:b0c3a1e4f2...

Hex-encoded HMAC-SHA256 of the raw request body, keyed by the webhook's signing secret. See the Webhooks guide for verification samples.

Request body

urlstring required

The webhook URL endpoint that received the event.

descriptionstring required

Human-readable label configured on the webhook (e.g. "Debt Collection Agent's Endpoint").

eventstring required

Event identifier in the form {agentId}.{eventType}.

idstring required

Unique webhook delivery ID (separate from metadata.callId).

Example request

{
  "url": "https://example.com/webhook",
  "event": "69fc7dd072a0c1d28d948ace.post-conversation",
  "id": "69fd96118fd277fc807e4c23",
  "metadata": {
    "agentId": "69fc7dd072a0c1d28d948ace",
    "eventType": "pre-conversation",
    "conversationType": "telephonyOutbound",
    "toPhone": "+916296641821",
    "fromPhone": "+918035317096",
    "callId": "CALL-1778226705739-7e4c17"
  }
}

Response

Your endpoint should return a 2XX status to acknowledge receipt.