SSE Events

Real-time workspace event stream delivered via Server-Sent Events (SSE).

The platform publishes real-time events to workspace subscribers via Server-Sent Events (SSE). Each event has a fixed event_type discriminator and a typed payload. Events are immutable once published.

Fields that may contain protected health information are annotated in the schema with x-phi: true. Consumers that persist or log event payloads can use this annotation to apply redaction or access controls.

Workspace Events

Call Events

Event Type	Description	Key Fields
call.started	A call session began	call_sid, direction, service_id, caller_id
call.ended	A call session ended	call_sid, direction, duration_seconds, completion_reason, escalated
call.escalated	A call was escalated to an operator	call_sid, escalation_id, trigger, reason

Text Events

Event Type	Description	Key Fields
text.started	A text session began	session_id, service_id, channel_kind, entity_id
text.completed	A text session ended	session_id, duration_seconds, turn_count, completion_reason, final_state, channel_kind

Surface Events

Event Type	Description	Key Fields
surface.created	A surface was created	surface_id, entity_id, channel, fields_count, source, form_template_id
surface.delivered	A surface was delivered to a patient	surface_id, entity_id, channel, channel_address, delivery_status, message_id, short_url
surface.updated	A surface was updated	surface_id, entity_id
surface.archived	A surface was archived	surface_id, entity_id
surface.submitted	A surface was submitted by a patient	surface_id, entity_id, submitted_at, fields_submitted
surface.field_saved	A single field was saved on a surface	surface_id, entity_id, field_key
surface.opened	A surface was opened by a patient	surface_id, entity_id
surface.reshaped	A surface was reshaped	surface_id, entity_id
surface.pending_review	A surface is pending review	surface_id, entity_id
surface.review_approved	A surface review was approved	surface_id
surface.review_rejected	A surface review was rejected	surface_id, reason

Encounter Events

Event Type	Description	Key Fields
encounter.updated	An encounter was updated during a copilot session	encounter_entity_id, session_id

Narrative Events

Event Type	Description	Key Fields
self_image.brief_generated	A narrative brief was generated or refreshed	target_entity_id, target_entity_type, event_id, version, confidence, event_count

Review Events

Event Type	Description	Key Fields
review.submitted	A review action was taken	action, item_id, entity_id, entity_type, count

The action field is one of: approve, reject, correct, batch_approve, batch_reject.

Simulation Events

Event Type	Description	Key Fields
simulation.turn_stored	A simulation turn was recorded	service_id, run_id, session_id, turn_index, state_before, state_after, is_terminal

Trigger Events

Event Type	Description	Key Fields
trigger.fired	An automation trigger was activated	trigger_id, trigger_name, manual
trigger.completed	An automation trigger completed successfully	trigger_id, trigger_name, status
trigger.failed	An automation trigger failed	trigger_id, trigger_name, status

Operator Events

Event Type	Description	Key Fields
operator.registered	An operator was registered	operator_id, name
operator.status_changed	An operator's status changed	operator_id, status
operator.profile_updated	An operator's profile was updated	operator_id
operator.joined_call	An operator joined a call	call_sid, operator_id, mode
operator.left_call	An operator left a call	call_sid, operator_id
operator.mode_changed	An operator's mode changed on a call	call_sid, operator_id, mode
operator.wrap_up	An operator entered wrap-up	call_sid, operator_id

Operator status is one of: online, busy, offline. Operator mode is one of: listen, takeover.

Pipeline Events

Event Type	Description	Key Fields
pipeline.sync_completed	A data pipeline sync completed	data_source_id, event_count, duration_ms
pipeline.error	A data pipeline sync failed	data_source_id, error

Observer Events

Observer events are delivered over WebSocket to clients observing an active call session.

Event Type	Description	Key Fields
user_transcript	User speech was transcribed	transcript, state, speaker_id, speaker_role, is_final, channel
agent_transcript	Agent speech was generated	transcript, action, interrupted, filler_type, speaker_id, speaker_role, streaming
tool_call_started	A tool call began	tool_name, tool_input
tool_call_completed	A tool call finished	tool_name, output, succeeded, duration_ms, error
forward_call_resolved	A call forward was resolved	target_number, location_name, result, error
speaker_muted	A speaker was muted	speaker_id, speaker_role

The filler_type field on agent transcripts is one of: empathy, receipt, working.

PHI Annotations

The following fields are annotated as potentially containing PHI:

Event	Field
call.started	caller_id
surface.delivered	channel_address
user_transcript	transcript
agent_transcript	transcript
tool_call_started	tool_input
tool_call_completed	output
forward_call_resolved	target_number