Webhook event catalogue

The envelope contains a stable event ID and event-specific data. Times inside data are milliseconds unless marked otherwise.

Envelope

Field	Meaning
id	Stable evt_ event ID, reused on replay
type	One catalogue type below
createdAt	Occurrence time as an ISO 8601 string
orgId	Organization ID
region	Organization region
agent	Originating agent: id, kind and name, or null
data	The type-specific object

Agent kind is chat or voice. Multi-agent conversations also include their agents array inside data.

Catalogue

Type	Meaning	Source filter
conversation.started	A chat starts or a call is answered.	Chat and voice agents
conversation.ended	A chat or call ends. Includes the transcript.	Chat and voice agents
conversation.analyzed	The summary and analysis are ready.	Chat and voice agents
call.transcript_updated	New lines of a live call. Sent at most every 2 seconds per call.	Voice agents
call.transfer_ringing	A transfer is ringing the other side.	Voice agents
call.transfer_connected	The other side answered a transfer.	Voice agents
call.transfer_bridged	The caller is joined to the other side.	Voice agents
call.transfer_failed	A transfer could not connect.	Voice agents
call.transfer_cancelled	A transfer was stopped before it connected.	Voice agents
call.guardrail_triggered	A guardrail stopped or changed a reply.	Voice agents
call.sms_sent	The agent texted the caller during a call.	Voice agents
call.continued_in_chat	The caller opened the chat link sent during a call.	Voice agents
handoff.requested	The agent asked for a team member.	Chat and voice agents
handoff.accepted	A team member took over.	Chat and voice agents
handoff.unmet	No team member was available.	Chat and voice agents
handoff.completed	The team member finished.	Chat and voice agents
campaign.message_sent	A campaign message left Tars.	Campaigns
campaign.message_delivered	The channel confirmed delivery.	Campaigns
campaign.message_read	The recipient opened the message.	Campaigns
campaign.message_replied	The recipient replied to a campaign message.	Campaigns
campaign.message_failed	The message could not be sent or delivered.	Campaigns
campaign.completed	Every message in a scheduled campaign has been sent.	Campaigns
contact.created	A new contact was added.	Organization: All resources
contact.updated	A contact’s details changed.	Organization: All resources

Shared data objects

Object	Fields
conversation	id, channel, status, startedAt, endedAt, contactId, campaignId
agents	Array of id, kind and name
transcript	entries and truncated
transcript entry	seq, kind, text, at, optional startMs and endMs
ending	reason, by and detail
recording	kind, artefactId, url, expiresAt and refreshUrl
campaign	id, name and mode
contact	id, optional name/email/phone, tags, origin, optional channelIdentifiers and consent, createdAt and lastSeenAt

endedAt, contactId and campaignId can be null. Transcript entry kind identifies the end user, agent or human responder. The call object follows the public call representation with privacy protections applied. See Calls API. Recording links follow the call’s captured signed-URL policy. expiresAt can be null when time expiry is disabled. Use refreshUrl to obtain a fresh recording link. Deleting content invalidates existing links and removes available event bodies.

conversation.started

data contains conversation and agents. Voice starts also include call. A chat starts when its conversation is created. A voice conversation starts when the call is answered.

conversation.ended

data contains conversation, agents, ending and transcript. Voice endings can also include call and recordings. conversation can be null for a refused call that never created a conversation. transcript can be null when unavailable. ending.reason is resolved, abandoned, superseded or call_ended. ending.by is agent, system or null. detail is nullable.

conversation.analyzed

data contains conversation, agents, analysis and run. Voice analysis can also include call and recordings. analysis contains nullable summary, successful, sentiment and language. sentiment is negative, neutral, positive, unknown or null. run contains index and rerun. Each completed analysis run has its own event.

call.transcript_updated

data contains callId, conversationId and entries. Entries use the shared transcript-entry shape. Updates are coalesced over two seconds. Entries describe the batch rather than repeating the entire transcript.