Skip to main content
POST
/
api
/
webhooks
cURL
curl --request POST \
  --url https://api.ultravox.ai/api/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [
    "call.started"
  ],
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "secrets": [
    "<string>"
  ]
}
'
{
  "webhookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "events": [
    "call.started"
  ],
  "status": "normal",
  "lastStatusChange": "2023-11-07T05:31:56Z",
  "recentFailures": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "failure": "<string>"
    }
  ],
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "secrets": [
    "<string>"
  ]
}

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
​
created
string<date-time>
required
​
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
​
recentFailures
object[]
required

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