recording.started

Event Properties

Field	Value
`event`	`"recording.started"`
`confidential`	`boolean`
`payload`	`object`

Public Payload
Confidential Payload

Field	Type	Description
`mode`	`"virtual" \| "in-person"`	Recording mode at start
`language`	`string`	Language used for transcription
`interactionId`	`string`	Unique interaction identifier
`interactionState`	`InteractionState`	Current state of the interaction

Example

{
  "event": "recording.started",
  "confidential": false,
  "payload": {
    "mode": "virtual",
    "language": "en",
    "interactionId": "int_123",
    "interactionState": "ongoing"
  }
}

Field	Type	Description
`mode`	`"virtual" \| "in-person"`	Recording mode at start
`language`	`string`	Language used for transcription
`interaction`	`ExternalInteraction`	Interaction context including transcripts, documents, and facts

interaction object properties

Field	Type	Description
`id`	`string`	Unique interaction identifier
`title`	`string \| null`	Interaction title
`state`	`InteractionState`	Current state of the interaction
`startedAt`	`string (ISO 8601 date)`	When the interaction started (ISO 8601 date string)
`transcriptCount`	`number`	Number of transcripts in the interaction
`documentCount`	`number`	Number of documents in the interaction
`facts`	`Fact[]`	Facts extracted during the interaction

Fact properties:

Field	Type	Description
`id`	`string`	Unique fact identifier
`text`	`string`	Fact text content
`group`	`string`	Fact group/category name
`source`	`"core" \| "system" \| "user"`	Source of the fact: core (AI extracted), system, or user
`isDiscarded`	`boolean`	Whether the fact has been discarded

Example

{
  "event": "recording.started",
  "confidential": true,
  "payload": {
    "mode": "virtual",
    "language": "en",
    "interaction": {
      "id": "int_123",
      "title": "Visit",
      "state": "ongoing",
      "startedAt": "2024-01-01T00:00:00.000+00:00",
      "transcriptCount": 0,
      "documentCount": 0,
      "facts": []
    }
  }
}

Overview

Get Started

Integrations

API Reference

Events

Event Properties

Example

Example

Overview

Get Started

Integrations

API Reference

Events

​Event Properties

​Example

​Example

Event Properties

Example

Example