Skip to main content
POST
/
webhooks
Register a new webhook
curl --request POST \
  --url https://api.voice-mate.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "api_key_id": "<string>",
  "phone_number_id": "<string>",
  "call_started_event": true,
  "call_ended_event": true
}
'
{
  "status": "success",
  "webhook": {
    "sid": "<string>",
    "url": "<string>",
    "call_started_event": true,
    "call_ended_event": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "api_key": {
      "sid": "<string>",
      "name": "<string>"
    },
    "phone_number": {
      "sid": "<string>",
      "number": "<string>",
      "name": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer auth header. Pass with value 'Bearer {api_key}'. Api key can be found in account Settings -> API Keys page

Body

application/json
​
url
string<uri>
required

HTTPS URL to receive webhook events

​
api_key_id
string
required

SID of the API key to use for webhook authentication

​
phone_number_id
string | null

SID of the phone number to attach the webhook to. Leave blank for a global webhook.

​
call_started_event
boolean
default:true

Whether to trigger webhook on call started event

​
call_ended_event
boolean
default:true

Whether to trigger webhook on call ended event

Response

Webhook registered

​
status
enum<string>
required
Available options:
success,
error
​
webhook
object
required