Developer Reference

Webhooks & Events

Vomyra pushes call events to your endpoint as they happen � no polling required. This page is the canonical reference for every event type, the payload structure, and how to verify request signatures.

No code required for logging

If you just want to log leads or call outcomes without building a webhook endpoint, use the Google Sheets integration instead. Webhooks are for teams wiring Vomyra into their own backend.

Setup

1Create an HTTPS endpoint that accepts POST requests and replies with 200 immediately.

2Register the endpoint URL in the Vomyra dashboard under Settings ? Webhooks.

3Select the events you want to receive.

4Copy the signing secret shown after saving � you will use it to verify requests.

Event types

All events are sent as a JSON POST body with a top-level event field and a data object.

Event	Description	Key fields
`call.started`	Fired when a call connects and Myra begins speaking. Inbound and outbound.	`call_idassistant_idphone_number_iddirectioncallerstarted_at`
`call.ended`	Fired when any call terminates. Contains the ended_reason and a summary of the call.	`call_idstatusended_reasonduration_secondscosttranscript_urlrecording_url`
`call.tool_invoked`	Fired each time Myra invokes a tool during a call. Useful for auditing and debugging.	`call_idtool_nametool_idparametersinvoked_at`
`call.transferred`	Fired when a call is forwarded to a human agent or another number via the transfer tool.	`call_idtransfer_destinationtransferred_atreason`
`assistant.updated`	Fired when an assistant's configuration is changed via the API or dashboard.	`assistant_idupdated_bychanged_fieldsupdated_at`

Example payload � call.ended

{ "event": "call.ended", "created_at": "2024-03-15T10:23:41Z", "data": { "call_id": "call_01hx8r...", "assistant_id": "asst_01hx...", "status": "completed", "ended_reason": "customer-ended-call", "direction": "inbound", "duration_seconds": 87, "cost": 7.25, "caller": { "number": "+919876543210" }, "transcript_url": "https://api.vomyra.com/v1/calls/call_01hx8r.../transcript", "recording_url": "https://api.vomyra.com/v1/calls/call_01hx8r.../recording" } }

Verifying signatures

Never skip verification

Your endpoint is publicly accessible. Always verify the HMAC signature before trusting the payload and taking any action.

Vomyra adds an X-Vomyra-Signature header containing a hex-encoded HMAC-SHA256 of the raw request body, signed with your webhook secret.

Verification � Node.js

import crypto from 'crypto'; export function isValidSignature( rawBody: Buffer, signature: string, secret: string, ): boolean { const expected = crypto .createHmac('sha256', secret) .update(rawBody) .digest('hex'); return crypto.timingSafeEqual( Buffer.from(expected, 'hex'), Buffer.from(signature, 'hex'), ); } // In your handler: app.post('/webhooks/vomyra', (req, res) => { const sig = req.headers['x-vomyra-signature'] as string; if (!isValidSignature(req.rawBody, sig, process.env.WEBHOOK_SECRET!)) { return res.status(401).send('Invalid signature'); } res.status(200).send('OK'); queue.add(req.body); // process asynchronously });

Best practices

Reply immediately, process later

Return 200 within 2 seconds. Push the event to a queue and process it asynchronously. If Vomyra does not receive a 2xx, it retries the event.

Handle retries idempotently

Network failures cause duplicate deliveries. Key your handler off call_id or a combination of event + call_id to avoid double-processing.

Test locally with a tunnel

Use ngrok or Cloudflare Tunnel to expose your local server during development. Register the tunnel URL in the dashboard.

Log everything while building

Log the raw request headers and body while developing. You will need this when a payload shape differs from what you expected.

Use separate endpoints per environment

Call Lifecycle

All call statuses and ended_reason codes � the values you'll filter on in webhook handlers.

API Reference

REST endpoints for retrieving call details, transcripts, and recordings.

Authentication

API key management and webhook secret rotation.

Google Sheets

No-code alternative for logging call outcomes without a webhook endpoint.

Event types

All events are sent as a JSON POST body with a top-level event field and a data object.

Event	Description	Key fields
`call.started`	Fired when a call connects and Myra begins speaking. Inbound and outbound.	`call_idassistant_idphone_number_iddirectioncallerstarted_at`
`call.ended`	Fired when any call terminates. Contains the ended_reason and a summary of the call.	`call_idstatusended_reasonduration_secondscosttranscript_urlrecording_url`
`call.tool_invoked`	Fired each time Myra invokes a tool during a call. Useful for auditing and debugging.	`call_idtool_nametool_idparametersinvoked_at`
`call.transferred`	Fired when a call is forwarded to a human agent or another number via the transfer tool.	`call_idtransfer_destinationtransferred_atreason`
`assistant.updated`	Fired when an assistant's configuration is changed via the API or dashboard.	`assistant_idupdated_bychanged_fieldsupdated_at`

Example payload � call.ended

Verifying signatures

Never skip verification

Your endpoint is publicly accessible. Always verify the HMAC signature before trusting the payload and taking any action.

Vomyra adds an X-Vomyra-Signature header containing a hex-encoded HMAC-SHA256 of the raw request body, signed with your webhook secret.

Verification � Node.js

Best practices

Reply immediately, process later

Return 200 within 2 seconds. Push the event to a queue and process it asynchronously. If Vomyra does not receive a 2xx, it retries the event.

Handle retries idempotently

Network failures cause duplicate deliveries. Key your handler off call_id or a combination of event + call_id to avoid double-processing.

Test locally with a tunnel

Use ngrok or Cloudflare Tunnel to expose your local server during development. Register the tunnel URL in the dashboard.

Log everything while building

Log the raw request headers and body while developing. You will need this when a payload shape differs from what you expected.

Use separate endpoints per environment

Webhooks & Events

Setup

Event types

Example payload � call.ended

Verifying signatures

Best practices

Related pages

Call Lifecycle

API Reference

Authentication

Google Sheets

Webhooks & Events

Setup

Event types

Example payload � call.ended

Verifying signatures

Best practices

Related pages

Call Lifecycle

API Reference

Authentication

Google Sheets