Skip to main content

​
Overview

When you provide a callback_url in your bot creation request, the API will send POST requests to notify you about various bot status changes. This allows you to track the bot’s progress in real-time.

​
Event Types

​
Bot Joining Event

Sent when the bot begins the process of joining the meeting. 
{
  "bot_id": "5b0ff6e7-3cea-4c9f-a6b4-851c5f11cf4f",
  "bot_status": "joining",
  "message": "Bot is joining the meeting",
  "status_code": 102
}

​
Bot Successfully Joined Event

Sent when the bot has successfully joined the meeting. 
{
  "bot_id": "5b0ff6e7-3cea-4c9f-a6b4-851c5f11cf4f",
  "message": "Successfully joined the meeting",
  "bot_status": "InMeeting",
  "status_code": 200
}

​
Bot Stopped Event

Sent when the bot has exited the meeting or encountered an error. 
{
  "bot_id": "5b0ff6e7-3cea-4c9f-a6b4-851c5f11cf4f",
  "message": "Bot exited and step function was triggered",
  "bot_status": "Stopped",
  "status_code": 500
}

​
Audio Processing Completed Event

Sent when audio processing has been completed successfully. 
{
  "bot_id": "5b0ff6e7-3cea-4c9f-a6b4-851c5f11cf4f",
  "audio_status": "Success",
  "message": "Audio processing completed successfully",
  "status_code": 200
}

​
Transcript Processing Completed Event

Sent when transcript processing has been completed successfully. 
{
  "bot_id": "5b0ff6e7-3cea-4c9f-a6b4-851c5f11cf4f",
  "transcript_status": "Success",
  "message": "Transcript processing completed successfully",
  "status_code": 200
}

​
Video Processing Completed Event

Sent when video processing has been completed successfully. 
{
  "bot_id": "5b0ff6e7-3cea-4c9f-a6b4-851c5f11cf4f",
  "video_status": "Success",
  "timestamp": "2024-01-15T14:30:00Z",
  "message": "Video processing completed successfully",
  "status_code": 200
}

​
Data Deletion Event

Sent when bot data has been deleted (either manually or through automatic retention policies). 
{
  "bot_id": "5b0ff6e7-3cea-4c9f-a6b4-851c5f11cf4f",
  "event": "data_deletion",
  "status": "success",
  "message": "Bot data deleted successfully",
  "deleted_objects": 5,
  "timestamp": "2024-01-15T14:30:00Z",
  "status_code": 200
}
Data Deletion Event Fields:
  • event: Always set to "data_deletion"
  • status: "success" if deletion completed successfully, or "failed" if an error occurred
  • deleted_objects: Number of objects/files deleted (audio, video, transcripts, etc.)
  • timestamp: ISO 8601 formatted timestamp of when the deletion occurred
  • status_code: 200 for successful deletion, 500 for failed deletion
This event is triggered when:
  • Data is manually deleted via the Delete Data API
  • Automatic data retention policies expire and delete the data
  • Scheduled data cleanup processes run

​
Event Fields

FieldTypeDescription
bot_idstringThe unique identifier of the bot
bot_statusstringCurrent status of the bot (joining, InMeeting, Stopped)
messagestringHuman-readable status message
status_codeintegerHTTP-style status code indicating the event type
audio_statusstringStatus of audio processing (Success)
transcript_statusstringStatus of transcript processing (Success)
video_statusstringStatus of video processing (Success)
eventstringEvent type identifier (e.g., data_deletion)
statusstringOperation status (success, failed)
deleted_objectsintegerNumber of objects deleted (data_deletion event only)
timestampstringISO 8601 formatted timestamp of the event

​
Status Codes

  • 102: Bot is in the process of joining the meeting
  • 200: Successful operation (joined meeting, audio/transcript/video processing completed, data deletion succeeded)
  • 500: Bot has stopped/exited the meeting, or data deletion failed

​
Implementation Notes

  • All events are sent as POST requests to your specified callback_url
  • The request body contains JSON data with the event details
  • Your endpoint should return a 200 status code to acknowledge receipt
  • Events may be sent multiple times for reliability
  • The bot_id field can be used to identify which bot the event belongs to