Conversation Callbacks
A list of all the real-time updates you’ll receive during the span of a conversation.
Callbacks
Overview
Our callbacks aim to provide insight for developers to the conversations they create. They range from system-related callbacks like replica joins and room shutdowns, to application-related callbacks like final transcription parsing and recording ready webhooks, with many more webhooks coming soon!
Callback Types
Our callbacks are split into two main categories:
- System Callbacks
These callbacks are to provide insight into system-related events in a conversation. They are:
-
system.replica_joined: This is fired when the replica becomes ready for a conversation.
-
system.shutdown: This is fired when the room shuts down, for any of the following reasons:
max_call_duration reached,participant_left_timeout reached,participant_absent_timeout reached,internal error occurred at step x. -
Application Callbacks
These callbacks are to inform developers about logical events that take place. They are:
- application.transcription_ready: This is fired after ending a conversation, where the chat history is saved and returned.
- application.recording_ready: This is fired if you had enabled recording on, set up a custom S3 bucket for recording and started a recording inside the room at any point. This will point to the key at which your new recording lies, useful for serving recordings through a CDN.