Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Your unique organization API key. Required on all requests.

Body

application/json
agent_id
string<uuid>
required

The UUID of the agent this webhook is associated with.

name
string
required

A friendly name for this webhook.

Required string length: 1 - 255
url
string<uri>
required

The HTTPS URL where webhook payloads will be sent.

events
enum<string>[]
required

List of event types to subscribe to.

Minimum array length: 1
Available options:
CALL_STARTED,
CALL_FINISHED,
CALL_FAILED
data_options
object
custom_headers
object

Custom HTTP headers to send with webhook requests.

Response

Webhook created successfully

message
string
required
data
object
required