Events
Webhooks
Subscribe to domain events (call started/ended, etc.) delivered as HTTP POSTs to your endpoint. Use them to sync calls into your CRM or trigger workflows. Each delivery is recorded and retryable.
GET
/webhooks/event-types workspace:adminList event types
The catalog of events you can subscribe to.
Example request
bash
curl https://api.bolchoai.in/v1/webhooks/event-types -H "Authorization: Bearer $VOXA_API_KEY"GET
/webhooks workspace:adminList endpoints
Your configured webhook endpoints.
Example request
bash
curl https://api.bolchoai.in/v1/webhooks \
-H "Authorization: Bearer $VOXA_API_KEY"POST
/webhooks workspace:adminCreate endpoint
Register a URL to receive events.
Body
| url* | string | HTTPS endpoint to POST events to. |
| events | string[] | Event types to subscribe to (default: all). |
Example request
bash
curl -X POST https://api.bolchoai.in/v1/webhooks -H "Authorization: Bearer $VOXA_API_KEY" -H "Content-Type: application/json" \
-d '{ "url": "https://example.com/hooks/voxa", "events": ["call.completed"] }'POST
/webhooks/{id}/test workspace:adminSend test event
Deliver a sample event to verify your endpoint.
Path parameters
| id* | uuid | Endpoint id. |
Example request
bash
curl -X POST https://api.bolchoai.in/v1/webhooks/$ID/test \
-H "Authorization: Bearer $VOXA_API_KEY"GET
/webhooks/{id}/deliveries workspace:adminDelivery log
Recent delivery attempts + responses for an endpoint.
Path parameters
| id* | uuid | Endpoint id. |
Example request
bash
curl https://api.bolchoai.in/v1/webhooks/$ID/deliveries \
-H "Authorization: Bearer $VOXA_API_KEY"DELETE
/webhooks/{id} workspace:adminDelete endpoint
Remove a webhook endpoint.
Path parameters
| id* | uuid | Endpoint id. |
Example request
bash
curl -X DELETE https://api.bolchoai.in/v1/webhooks/$ID \
-H "Authorization: Bearer $VOXA_API_KEY"