Skip to content
VaakyoDocs
Navigation
Open console →

Agents

Webhook and number

The Webhook & number tab sets where the agent's call events are posted and which phone number the agent answers and calls from.

Fields

FieldTypeDefaultWhat it does
webhook_urlstring""Every event of this agent’s calls, including call.completed with the full call record, is posted here.
phone_numberstring""An E.164 number from your workspace (another number is refused with 422). Inbound calls to it are answered by this agent, and it is the default caller ID for the agent’s outbound calls.
{
  "webhook_url": "https://crm.example.com/vaakyo/call-events",
  "phone_number": "+918035001234"
}

Webhook URL

The agent’s webhook URL receives the lifecycle of this agent’s calls: call.queued, call.placed (dialling), call.started (in progress), call.ended and call.completed (the final record, after analytics). For turn-by-turn events, add a workspace endpoint that lists them; see Webhook events.

  • Requests are signed with your workspace’s default signing secret. Read its hint with GET /api/v1/webhooks/default-secret and get a new one with POST /api/v1/webhooks/default-secret/rotate (the new secret is returned once).
  • Deliveries are retried and logged like any other webhook.
  • If a workspace endpoint is also subscribed, both receive the event.

See Webhooks for the payload, the signature and retries.

Phone number

A number answers with one agent at a time. When you save an agent with a number that another agent in your workspace already has, the number moves to the new agent and is cleared from the old one. A number used by another workspace returns 409 that number belongs to another workspace.

To connect a number and also point its incoming calls at Vaakyo, use Phone numbers in the console or POST /api/v1/numbers/{number}/connect. See Inbound calls.

On outbound calls, from_number in the place-call request wins over the agent’s number. If neither is set, the request fails with 400. See Outbound calls.

Esc