Skip to main content
POST
Register a webhook endpoint

Authorizations

X-API-KEY
string
header
required

Body

application/json
agent_id
string
required

The agent whose call events this endpoint receives. Cannot be changed later; delete and recreate to move a subscription.

url
string
required

Absolute https:// URL. Max 2048 chars. Private and loopback addresses are rejected.

events
enum<string>[]

Event types to receive. Empty or omitted means all.

Available options:
call_started,
call_completed,
recording_completed
headers
object

Static headers sent with every delivery — this is how your endpoint authenticates us. Max 20 headers, 8 KB total. Framing headers (Content-Type, Host, …) and the X-Webhook-* family are reserved. Values are write-only.

signing_enabled
boolean
default:false

Also send X-Webhook-Signature / X-Webhook-Timestamp. Off by default: the headers above are the primary authentication.

payload_format
enum<string>
default:native

Wire shape of the body. ringg reshapes it for a receiver written against Ringg's webhooks.

Available options:
native,
ringg
description
string

Response

Created. The only response carrying signing_secret, and only when signing was enabled.