Webhook

The webhook URL is where Vaanii sends post-call events whenever a call on the campaign completes. Set it at campaign creation, or update it any time with `PATCH /api/v1/campaigns/{campaign_id}/webhook`.

PATCH/api/v1/campaigns/{campaign_id}/webhook

Examples

Request

curl --request PATCH \
  --url 'https://api.vaanii.ai/api/v1/campaigns/6422ad8b-e725-4aef-9fa2-7120dcf4eb17/webhook' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <your_api_key>' \
  --data '{"webhook_url":"https://your-app.example.com/vaanii/call-completed"}'

Response

Possible HTTP status codes for this endpoint, with a representative response body for each. Select a status to preview it.

200 OKSuccessful response

{
  "message": "Webhook URL updated",
  "webhook_url": "https://your-app.example.com/vaanii/call-completed"
}

Field	Type	Description
`webhook_url`	URL (string, ≤ 512 chars)	URL that receives post-call events.

Example: "https://your-app.example.com/vaanii/call-completed"

It can also be updated directly via PATCH /api/v1/campaigns/{campaign_id}/webhook.