Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

An API key from Settings > API keys. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:write, webhooks:manage.

Headers

Idempotency-Key
string

A unique value, up to 255 characters, that makes retries of this request safe for 24 hours.

Maximum string length: 255

Body

application/json
url
string<uri>
required

HTTPS URL that receives events.

Maximum string length: 2000
events
enum<string>[]
required
Minimum array length: 1
Available options:
call.completed,
appointment.booked,
appointment.rescheduled,
appointment.cancelled,
message.taken,
contact.created
description
string
Maximum string length: 200

Response

Created

data
object
required