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 Additional data about the event.
Types of Events audio_transcription.succeeded
data is an audio transcription
Occurs whenever an audio transcription succeeds.
The ID of the audio transcription.
The status of the audio transcription.
The text of the audio transcription.
audio_transcription.failed
Occurs whenever an audio transcription fails.
The ID of the audio transcription.
The status of the audio transcription.
The error message of the audio transcription.
note_generation.succeeded
data is a note
Occurs whenever a note generation succeeds.
The status of the note generation.
The JSON representation of the note. The note style used will determine which fields are present. See the SOAP Note example.
The markdown representation of the note.
The start time of the note generation.
The completion time of the note generation.
Occurs whenever a note generation fails.
The status of the note generation.
The start time of the note generation.
The completion time of the note generation.
data is a coding result
Occurs whenever a coding operation succeeds.
The id of the coding operation.
The status of the coding operation.
ISO 8601 timestamp of when the coding operation was created.
ISO 8601 timestamp of when the coding operation was last updated.
Array of diagnosed conditions with ICD-10-CM and SNOMED CT codes.
Unique identifier for the diagnosis.
Array of coding systems (ICD-10-CM, SNOMED CT).
Human-readable description of the diagnosis.
Start character position in the source text.
End character position in the source text.
The actual text that was coded.
Array of medical procedures with CPT codes.
Unique identifier for the procedure.
Array of coding systems (CPT).
Human-readable description of the procedure.
Start character position in the source text.
End character position in the source text.
The actual text that was coded.
Occurs whenever a coding operation fails.
The id of the coding operation.
The status of the coding operation (will be “failed”).
The error message describing why the coding operation failed.
