Bot data model

Updated:

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.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoDisplay name for the bot in the meeting
meeting_urlstringNoURL of the meeting to join
event_idstringNoReference to calendar_event if scheduled via calendar (reference to CalendarEvent)
statusenumNo (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_changesCalendarBotStatusChange[]NoHistory of status changes (read-only)
status_changes[].statusenumNoValues: 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_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
status_changes[].sub_codestringNoPlatform-specific status sub-code
status_changes[].messagestringNoHuman-readable status message
join_atstring (date-time)NoWhen to join the meeting (for scheduled bots) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
started_atstring (date-time)NoWhen the bot actually joined (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only)
ended_atstring (date-time)NoWhen the bot left (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only)
recording_configobjectNo
recording_config.record_videobooleanNo
recording_config.record_audiobooleanNo
recording_config.record_transcriptbooleanNo
recording_config.record_chatbooleanNo
recording_config.record_screensharebooleanNo
recording_config.transcriptionCalendarBot_recording_config_transcriptionNo
recording_config.transcription.providerenumNoValues: MEETING_CAPTIONS
recording_config.transcription.modeenumNoValues: PRIORITIZE_ACCURACY, PRIORITIZE_LOW_LATENCY
recording_config.transcription.languagestringNoISO language code (e.g., 'en-US')
recording_config.transcription.enable_speaker_labelsbooleanNoWhether to identify speakers in transcript
recording_config.transcription.enable_word_timestampsbooleanNoWhether to include word-level timestamps
automatic_leaveobjectNo
automatic_leave.waiting_room_timeoutnumberNoSeconds to wait in waiting room before leaving (default: 1200)
automatic_leave.no_participants_timeoutnumberNoSeconds to wait when no other participants before leaving (default: 2)
automatic_leave.detect_botsbooleanNoWhether to leave if only bots remain
meeting_metadataobjectNo (read-only)
meeting_metadata.titlestringNo
meeting_metadata.platformstringNo'zoom', 'webex', 'google_meet', etc.
meeting_metadata.host_namestringNo
meeting_metadata.host_emailstringNo
meeting_metadata.meeting_identifierstringNoPlatform-specific meeting identifier (not a unified object ref)
meeting_metadata.started_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
meeting_metadata.ended_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
meeting_metadata.participant_countnumberNo
participantsCalendarBotParticipant[]No (read-only)
participants[].idstringNo
participants[].namestringNo
participants[].emailstringNo
participants[].is_hostbooleanNo
participants[].is_cohostbooleanNo
participants[].joined_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
participants[].left_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
participants[].platformstringNoPlatform-specific participant identifier
participants[].is_botbooleanNoWhether this participant is a bot
participants[].is_selfbooleanNoWhether this participant is the current bot
participants[].speakingbooleanNoWhether participant is currently speaking
participants[].webcam_onbooleanNoWhether participant's webcam is on
participants[].screenshare_onbooleanNoWhether participant is sharing screen
participants[].platform_metadataobjectNoPlatform-specific metadata
recording_idstringNoReference to calendar_recording when ready (read-only)

TypeScript

TypeScript
export type CalendarBot = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // Display name for the bot in the meeting
	meeting_url?: string; // URL of the meeting to join
	event_id?: string; // Reference to calendar_event if scheduled via calendar (reference to CalendarEvent)
	status?: '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?: []; // History of status changes
	join_at?: string-time; // When to join the meeting (for scheduled bots) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	started_at?: string-time; // When the bot actually joined (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	ended_at?: string-time; // When the bot left (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	recording_config?: {
		record_video?: boolean; 
		record_audio?: boolean; 
		record_transcript?: boolean; 
		record_chat?: boolean; 
		record_screenshare?: boolean; 
		transcription?: any; 
	};
	automatic_leave?: {
		waiting_room_timeout?: number; // Seconds to wait in waiting room before leaving (default: 1200) 
		no_participants_timeout?: number; // Seconds to wait when no other participants before leaving (default: 2) 
		detect_bots?: boolean; // Whether to leave if only bots remain 
	};
	meeting_metadata?: {
		title?: string; 
		platform?: string; // 'zoom', 'webex', 'google_meet', etc. 
		host_name?: string; 
		host_email?: string; 
		meeting_identifier?: string; // Platform-specific meeting identifier (not a unified object ref) 
		started_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) 
		ended_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) 
		participant_count?: number; 
	};
	participants?: [];
	recording_id?: string; // Reference to calendar_recording when ready
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodCalendarBot = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("Display name for the bot in the meeting"),
	meeting_url: z.string().optional().describe("URL of the meeting to join"),
	event_id: z.string().optional().describe("Reference to calendar_event if scheduled via calendar (reference to CalendarEvent)"),
	status: z.enum("READY", "JOINING_CALL", "IN_WAITING_ROOM", "IN_CALL_NOT_RECORDING", "RECORDING_PERMISSION_ALLOWED", "RECORDING_PERMISSION_DENIED", "IN_CALL_RECORDING", "CALL_ENDED", "DONE", "FATAL").optional(),
	status_changes: z.array().optional().describe("History of status changes"),
	join_at: z.string-time().optional().describe("When to join the meeting (for scheduled bots) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	started_at: z.string-time().optional().describe("When the bot actually joined (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	ended_at: z.string-time().optional().describe("When the bot left (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	recording_config: z.object({
			record_video: z.boolean().optional(),
			record_audio: z.boolean().optional(),
			record_transcript: z.boolean().optional(),
			record_chat: z.boolean().optional(),
			record_screenshare: z.boolean().optional(),
			transcription: z.unknown().optional()
}).optional(),
	automatic_leave: z.object({
			waiting_room_timeout: z.number().optional().describe("Seconds to wait in waiting room before leaving (default: 1200)"),
			no_participants_timeout: z.number().optional().describe("Seconds to wait when no other participants before leaving (default: 2)"),
			detect_bots: z.boolean().optional().describe("Whether to leave if only bots remain")
}).optional(),
	meeting_metadata: z.object({
			title: z.string().optional(),
			platform: z.string().optional().describe("'zoom', 'webex', 'google_meet', etc."),
			host_name: z.string().optional(),
			host_email: z.string().optional(),
			meeting_identifier: z.string().optional().describe("Platform-specific meeting identifier (not a unified object ref)"),
			started_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
			ended_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
			participant_count: z.number().optional()
}).optional(),
	participants: z.array().optional(),
	recording_id: z.string().optional().describe("Reference to calendar_recording when ready"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class CalendarBotStatus(str, Enum):
	READY = 'READY'
	JOINING_CALL = 'JOINING_CALL'
	IN_WAITING_ROOM = 'IN_WAITING_ROOM'
	IN_CALL_NOT_RECORDING = 'IN_CALL_NOT_RECORDING'
	RECORDING_PERMISSION_ALLOWED = 'RECORDING_PERMISSION_ALLOWED'
	RECORDING_PERMISSION_DENIED = 'RECORDING_PERMISSION_DENIED'
	IN_CALL_RECORDING = 'IN_CALL_RECORDING'
	CALL_ENDED = 'CALL_ENDED'
	DONE = 'DONE'
	FATAL = 'FATAL'

@dataclasses.dataclass
class PropertyCalendarBotRecording_config:
	record_video: Optional[bool]
	record_audio: Optional[bool]
	record_transcript: Optional[bool]
	record_chat: Optional[bool]
	record_screenshare: Optional[bool]
	transcription: Optional[PropertyCalendarBotTranscription]

@dataclasses.dataclass
class PropertyCalendarBotAutomatic_leave:
	"""Seconds to wait in waiting room before leaving (default: 1200)"""
	waiting_room_timeout: Optional[int]
	"""Seconds to wait when no other participants before leaving (default: 2)"""
	no_participants_timeout: Optional[int]
	"""Whether to leave if only bots remain"""
	detect_bots: Optional[bool]

@dataclasses.dataclass
class PropertyCalendarBotMeeting_metadata:
	title: Optional[str]
	"""'zoom', 'webex', 'google_meet', etc."""
	platform: Optional[str]
	host_name: Optional[str]
	host_email: Optional[str]
	"""Platform-specific meeting identifier (not a unified object ref)"""
	meeting_identifier: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	started_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	ended_at: Optional[str]
	participant_count: Optional[int]

@dataclasses.dataclass
class CalendarBot:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Display name for the bot in the meeting"""
	name: Optional[str]
	"""URL of the meeting to join"""
	meeting_url: Optional[str]
	"""Reference to calendar_event if scheduled via calendar (reference to CalendarEvent)"""
	event_id: Optional[str]
	status: Optional[CalendarBotStatus]
	"""History of status changes"""
	status_changes: Optional[PropertyCalendarBotStatus_changes]
	"""When to join the meeting (for scheduled bots) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	join_at: Optional[str]
	"""When the bot actually joined (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	started_at: Optional[str]
	"""When the bot left (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	ended_at: Optional[str]
	recording_config: Optional[PropertyCalendarBotRecording_config]
	automatic_leave: Optional[PropertyCalendarBotAutomatic_leave]
	meeting_metadata: Optional[PropertyCalendarBotMeeting_metadata]
	participants: Optional[PropertyCalendarBotParticipants]
	"""Reference to calendar_recording when ready"""
	recording_id: Optional[str]
Are we missing anything? Let us know
Was this page helpful?