Webhooks

Register webhook endpoints to receive real-time event notifications from Rymi.

Register Webhook

POST /webhooks

Field	Type	Required	Description
url	string	✅	HTTPS endpoint to receive events
events	string[]	✅	Events to subscribe to

Available Events:

Event	Description
call.started	A call has been initiated
call.completed	A call has ended
call.failed	A call failed to connect
transcript.ready	Full transcript is available
campaign.completed	All contacts in a campaign have been contacted

curl -X POST https://api.rymi.ai/v1/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "url": "https://your-app.com/api/rymi-events",
    "events": ["call.completed", "transcript.ready"]
  }'

Response 201

{ "status": "registered" }

List Webhooks

GET /webhooks

Delete Webhook

DELETE /webhooks/:id

Payload Format

When an event fires, Rymi will POST to your registered URL:

{
  "event": "call.completed",
  "timestamp": "2026-03-01T10:05:00Z",
  "data": {
    "call_id": "call_abc123",
    "duration": 145,
    "sentiment": "positive"
  }
}

Signature Verification

Every webhook includes an X-Rymi-Signature header (HMAC-SHA256). See the Webhook Verification Guide for implementation details.