Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

API key

Body

application/json
url
string<uri>
required
Maximum string length: 200
events
enum<string>[]
required
  • call.started - Fired when a call starts
  • call.joined - Fired when a call is joined
  • call.ended - Fired when a call ends
  • call.billed - Fired when a call is billed
Available options:
call.started,
call.joined,
call.ended,
call.billed
agentId
string<uuid> | null

If set, this webhook will be limited to calls with this agent.

secrets
string[]
Maximum string length: 120

Response

201 - application/json
webhookId
string<uuid>
required
read-only
created
string<date-time>
required
read-only
url
string<uri>
required
Maximum string length: 200
events
enum<string>[]
required
  • call.started - Fired when a call starts
  • call.joined - Fired when a call is joined
  • call.ended - Fired when a call ends
  • call.billed - Fired when a call is billed
Available options:
call.started,
call.joined,
call.ended,
call.billed
status
enum<string>
required
  • normal - NORMAL
  • unhealthy - UNHEALTHY
Available options:
normal,
unhealthy
lastStatusChange
string<date-time> | null
required
read-only
recentFailures
object[]
required
read-only

A list of recent failures for this webhook, if any.

agentId
string<uuid> | null

If set, this webhook will be limited to calls with this agent.

secrets
string[]
Maximum string length: 120