Skip to main content

​
Overview

Corti Assistant uses a real-time event system to communicate state changes and important updates from the embedded application to your integration. Events enable you to build responsive integrations that react to user actions, recording states, and document lifecycle changes without polling.

​
Event Structure

All Corti Assistant events follow a consistent schema: 
{
  event: string,                 // Event name (e.g., 'recording.started', 'document.generated')
  confidential: boolean,         // Whether event contains sensitive data
  payload: object                // Event-specific data
}

​
Structure Components

  • event: A dot-notation string identifier for the specific event type (e.g., 'recording.started', 'document.generated', 'interaction.loaded')
  • confidential: A boolean indicating whether the payload contains sensitive patient or user data
  • payload: An object containing event-specific data. The structure varies by event type and confidentiality level.

​
Confidential vs Public Events

Events can contain two types of payloads:
  • Public Payload: Contains metadata and identifiers (IDs, states, durations) without sensitive information
  • Confidential Payload: Contains full interaction context including transcripts, documents, facts, and other protected data
The confidential field indicates which payload type is included.

​
Integration Transports

Events are delivered through different transport mechanisms depending on your integration method. For details on how to receive and handle events in your specific integration:
  • PostMessage API - For iframe/WebView integrations
  • Window API - For same-origin integrations
  • Web Component (coming soon) - For simplified component-based integration

​
Detailed Event Reference

For complete documentation of each event, including full payload schemas, confidential fields, and usage examples, see the individual event pages in this section.