Webhooks docs: signature verification, standard variables, deletion gate
Webhooks docs: signature verification, standard variables, deletion gate
The Webhooks guide now documents behaviors previously only discoverable from the wire or from the platform source.
What’s new
- Signature verification. New section names the
X-Signatureheader, the HMAC-SHA256 (hex) algorithm, and the raw-body input rule, with runnable Python and Node samples that use constant-time comparison. - Standard variables in
metadata.variables. The platform always injectscall_id,user_number,agent_number,conversation_type,agent_gender,default_language,supported_languages,current_date,current_time,current_day, andtimezone. Custom keys from the agent’s config stack alongside these. - Signing secret via API.
GET /webhookandGET /webhook?webhookId=<id>return the secret in thedecryptedSecretKeyfield, so integrations can fetch it without opening the dashboard. - Deletion behavior.
DELETE /webhook/{id}returns 400 while the webhook is still assigned to any agent. Clear assignments viaDELETE /agent/{agentId}/webhook-subscriptions, then retry the delete. PATCH /webhook/{id}scope. Onlyendpoint,description, andheaderscan be updated in place; event subscriptions must be changed through the webhook-subscriptions endpoints or the agent editor.
The example post-conversation body was updated so variables now shows the standard platform-set keys alongside a couple of custom ones.
API Reference additions
PATCH /webhook/{id}is now in the spec (previously undocumented despite existing on the platform). Documents theendpoint | description | headersupdate surface, the{}sentinel for clearing custom headers, and the header limits (10 max, 1024-char values, reserved names).X-Signatureis now a declared header parameter on the three webhook event callbacks (pre-conversation,post-conversation,analytics-completed) with a pointer to the verification samples in the guide.- Each callback description also names the 30 s delivery timeout and the no-retry policy.
- The
Webhook.decryptedSecretKeyfield description was corrected: the secret is returned by both the list and the single-webhook GET endpoints (previously said “only single by ID”).
FAQ
The page’s Tips accordion was replaced with a 10-question FAQ covering delivery timeout, retry policy, egress IPs, event ordering, local testing, signing-secret retrieval, subscription changes, delete-gate behavior, and variable stability.

