Skip to main content
POST
Create a webhook destination
Store the returned whsec_ secret securely. Read the destination list for its remaining fields. The default timeout is 10 seconds.

Authorizations

Authorization
string
header
required

An API key (tars_sk_…) sent as Authorization: Bearer <key>. Each operation names the permission it needs. Create keys in Settings → Integrations → API keys.

Body

application/json

A new webhook destination.

url
string<uri>
required

A public https URL.

Maximum string length: 2048
sources
required

Where events come from: "all", or the chat agents, voice agents and campaigns to receive events from.

events
enum<string>[]
required
Minimum array length: 1
Available options:
conversation.started,
conversation.ended,
conversation.analyzed,
call.transcript_updated,
call.transfer_ringing,
call.transfer_connected,
call.transfer_bridged,
call.transfer_failed,
call.transfer_cancelled,
call.guardrail_triggered,
call.sms_sent,
call.continued_in_chat,
handoff.requested,
handoff.accepted,
handoff.unmet,
handoff.completed,
campaign.message_sent,
campaign.message_delivered,
campaign.message_read,
campaign.message_replied,
campaign.message_failed,
campaign.completed,
contact.created,
contact.updated
name
string
Maximum string length: 80
timeoutMs
integer
default:10000
Required range: 1000 <= x <= 30000
enabled
boolean
default:true

Response

The destination and its secret.

The destination and its signing secret. The secret is shown only here.

id
string
required
secret
string
required