Overview

Events capture various changes to API resources. By setting up a webhook you can be notified when various events occur. This is particularly useful for listening to asynchronous events such as generating notes or audio transcriptions.

The Event Object

type · string

The type of the event.

data · object

Additional data about the event.

Types of Events

audio_transcription.succeeded

data is an audio transcription

Occurs whenever an audio transcription succeeds.

Hide properties

data · object

Show properties

transcriptionId · string

The ID of the audio transcription.

status · string

The status of the audio transcription.

payload · object

Hide properties

transcription · string

The text of the audio transcription.

audio_transcription.failed

Occurs whenever an audio transcription fails.

Hide properties

data · object

Show properties

transcriptionId · string

The ID of the audio transcription.

status · string

The status of the audio transcription.

error · string

The error message of the audio transcription.

note_generation.succeeded

data is a note

Occurs whenever a note generation succeeds.

Hide properties

data · object

Show properties

id · string

The id of the note.

status · string

The status of the note generation.

payload · object

Hide properties

json · object

The JSON representation of the note. The note style used will determine which fields are present. See the SOAP Note example.

markdown · string

The markdown representation of the note.

timestamp · object

Hide properties

start · number

The start time of the note generation.

complete · number

The completion time of the note generation.

note_generation.failed

Occurs whenever a note generation fails.

Hide properties

data · object

Show properties

id · string

The id of the note.

status · string

The status of the note generation.

timestamp · object

Hide properties

start · number

The start time of the note generation.

complete · number

The completion time of the note generation.

coding.succeeded

data is a coding result

Occurs whenever a coding operation succeeds.

Hide properties

data · object

Show properties

id · string

The id of the coding operation.

status · string

The status of the coding operation.

created_at · string

ISO 8601 timestamp of when the coding operation was created.

updated_at · string

ISO 8601 timestamp of when the coding operation was last updated.

result · object

Hide properties

diagnoses · array

Array of diagnosed conditions with ICD-10-CM and SNOMED CT codes.

Show diagnosis object

id · string

Unique identifier for the diagnosis.

code · object

Show properties

coding · array

Array of coding systems (ICD-10-CM, SNOMED CT).

text · string

Human-readable description of the diagnosis.

text_span · object

Show properties

start_char · number

Start character position in the source text.

end_char · number

End character position in the source text.

text · string

The actual text that was coded.

procedures · array

Array of medical procedures with CPT codes.

Show procedure object

id · string

Unique identifier for the procedure.

code · object

Show properties

coding · array

Array of coding systems (CPT).

text · string

Human-readable description of the procedure.

text_span · object

Show properties

start_char · number

Start character position in the source text.

end_char · number

End character position in the source text.

text · string

The actual text that was coded.

coding.failed

Occurs whenever a coding operation fails.

Hide properties

data · object

Show properties

id · string

The id of the coding operation.

status · string

The status of the coding operation (will be “failed”).

error · string

The error message describing why the coding operation failed.