Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.oneinbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Before you start

You need: an api_key and a public HTTPS URL that accepts POST requests. Common events:
EventWhen
call.startedCall connects
call.endedCall finishes
transcript.finalFull transcript ready
1

1. Create a webhook

curl -X POST https://api.oneinbox.ai/v1/webhooks \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Call events",
    "url": "https://example.com/webhook",
    "events": ["call.started", "call.ended", "transcript.final"]
  }'
2

2. Test delivery

Send a test payload to your URL:
curl -X POST https://api.oneinbox.ai/v1/webhooks/<webhook_id>/test \
  -H "Authorization: Bearer <api_key>"
Check your server logs for the incoming request.
3

3. List or update

# List all
curl https://api.oneinbox.ai/v1/webhooks \
  -H "Authorization: Bearer <api_key>"

# Update events
curl -X PATCH https://api.oneinbox.ai/v1/webhooks/<webhook_id> \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "events": ["call.started", "call.ended"]
  }'

# Delete
curl -X DELETE https://api.oneinbox.ai/v1/webhooks/<webhook_id> \
  -H "Authorization: Bearer <api_key>"

​
API reference

Create webhook · Test webhook · List webhooks