Skip to main content
POST
Register Webhook

Authorizations

api_key
string
header
required

Headers

Company-Name
string
required

Schema name for multi-tenancy

Body

application/json
webhook_url
string<uri>
required

URL to send webhook payloads to

Example:

"https://webhook.site/abcdef123456"

description
string
required

Description of the webhook purpose

Example:

"This is a test webhook to capture call start and end events."

agent_ids
string[]
required

List of agent IDs this webhook is associated with

events_to_subscribe
string[]
required

List of events to subscribe to (e.g. call.started, call.ended)

Response

Webhook registered successfully

message
string
Example:

"Webhook registered successfully!"

data
object