Bot data model
Note
Meeting bots are coming soon. No integrations support them yet.
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | Display name for the bot in the meeting |
meeting_url | string | No | URL of the meeting to join |
event_id | string | No | Reference to calendar_event if scheduled via calendar (reference to CalendarEvent) |
status | enum | No | (read-only)Values: READY, JOINING_CALL, IN_WAITING_ROOM, IN_CALL_NOT_RECORDING, RECORDING_PERMISSION_ALLOWED, RECORDING_PERMISSION_DENIED, IN_CALL_RECORDING, CALL_ENDED, DONE, FATAL |
status_changes | CalendarBotStatusChange[] | No | History of status changes (read-only) |
status_changes[].status | enum | No | Values: READY, JOINING_CALL, IN_WAITING_ROOM, IN_CALL_NOT_RECORDING, RECORDING_PERMISSION_ALLOWED, RECORDING_PERMISSION_DENIED, IN_CALL_RECORDING, CALL_ENDED, DONE, FATAL |
status_changes[].changed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
status_changes[].sub_code | string | No | Platform-specific status sub-code |
status_changes[].message | string | No | Human-readable status message |
join_at | string (date-time) | No | When to join the meeting (for scheduled bots) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
started_at | string (date-time) | No | When the bot actually joined (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only) |
ended_at | string (date-time) | No | When the bot left (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only) |
recording_config | object | No | |
recording_config.record_video | boolean | No | |
recording_config.record_audio | boolean | No | |
recording_config.record_transcript | boolean | No | |
recording_config.record_chat | boolean | No | |
recording_config.record_screenshare | boolean | No | |
recording_config.transcription | CalendarBot_recording_config_transcription | No | |
recording_config.transcription.provider | enum | No | Values: MEETING_CAPTIONS |
recording_config.transcription.mode | enum | No | Values: PRIORITIZE_ACCURACY, PRIORITIZE_LOW_LATENCY |
recording_config.transcription.language | string | No | ISO language code (e.g., 'en-US') |
recording_config.transcription.enable_speaker_labels | boolean | No | Whether to identify speakers in transcript |
recording_config.transcription.enable_word_timestamps | boolean | No | Whether to include word-level timestamps |
automatic_leave | object | No | |
automatic_leave.waiting_room_timeout | number | No | Seconds to wait in waiting room before leaving (default: 1200) |
automatic_leave.no_participants_timeout | number | No | Seconds to wait when no other participants before leaving (default: 2) |
automatic_leave.detect_bots | boolean | No | Whether to leave if only bots remain |
meeting_metadata | object | No | (read-only) |
meeting_metadata.title | string | No | |
meeting_metadata.platform | string | No | 'zoom', 'webex', 'google_meet', etc. |
meeting_metadata.host_name | string | No | |
meeting_metadata.host_email | string | No | |
meeting_metadata.meeting_identifier | string | No | Platform-specific meeting identifier (not a unified object ref) |
meeting_metadata.started_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
meeting_metadata.ended_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
meeting_metadata.participant_count | number | No | |
participants | CalendarBotParticipant[] | No | (read-only) |
participants[].id | string | No | |
participants[].name | string | No | |
participants[].email | string | No | |
participants[].is_host | boolean | No | |
participants[].is_cohost | boolean | No | |
participants[].joined_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
participants[].left_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
participants[].platform | string | No | Platform-specific participant identifier |
participants[].is_bot | boolean | No | Whether this participant is a bot |
participants[].is_self | boolean | No | Whether this participant is the current bot |
participants[].speaking | boolean | No | Whether participant is currently speaking |
participants[].webcam_on | boolean | No | Whether participant's webcam is on |
participants[].screenshare_on | boolean | No | Whether participant is sharing screen |
participants[].platform_metadata | object | No | Platform-specific metadata |
recording_id | string | No | Reference to calendar_recording when ready (read-only) |
Are we missing anything? Let us know
Was this page helpful?