​
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
}

​
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)

​
Status Codes

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

​
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