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.