Skip to main content
POST
Send a test event
Choose a subscribed type or omit it to use the first subscribed type in catalogue order. The delivered envelope has type webhook.test and data containing sampleType and sample. Tests are limited to five per minute per destination. A delivery failure is an outcome with ok: false, rather than a problem response. Paused destinations return destination_paused.

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.

Path Parameters

id
string
required

The id.

Required string length: 1 - 128

Body

application/json

The event to send a sample of.

type
enum<string>

One of the destination's events. Defaults to its first event.

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

Response

The test delivery result.

The destination answered with a 2xx status.

ok
any
required
status
integer
required
latencyMs
number
required