Skip to main content
POST
/
v1
/
calls
/
webhooks
Create a call webhook
curl --request POST \
  --url https://api.wavix.com/v1/calls/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://you-site.com/webhook"
}
'
{
  "success": true,
  "event_type": "post-call",
  "url": "https://you-site.com/webhook"
}

Authorizations

​
Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Body

application/json

Webhook configuration.

​
url
string<uri>
required

Webhook URL to send call events to.

Example:

"https://you-site.com/webhook"

​
event_type
enum<string>
required

Allowed values: on-call, post-call.

  • on-call: Sends real-time status updates when a call starts, is answered, and ends.

  • post-call: Sends a callback after the call ends with disposition, duration, and cost.

Available options:
post-call,
on-call

Response

Webhook created.

A call webhook response

​
success
boolean
required
Example:

true

​
event_type
enum<string>
required

Type of call events

Available options:
post-call,
on-call
Example:

"post-call"

​
url
string<uri>
required

Webhook URL

Example:

"https://you-site.com/webhook"