---
title: "Bot data model"
url: "https://docs.unified.to/calendar/bot/model"
description: "The Bot data model object in Unified's Bot API: 16 fields, including created_at, updated_at and name, with types and enum values."
date: "2026-11-13T20:18:46.414Z"
updated: "2026-11-13T20:19:18.258Z"
---
# Bot data model

Updated: November 13, 2026

Note

 Meeting bots are supported by [Google Meet (meeting bot)](https://docs.unified.to/integrations/googlemeetmeetingbot.md), [Microsoft Teams (meeting bot)](https://docs.unified.to/integrations/microsoftteamsmeetingbot.md), [Webex (meeting bot)](https://docs.unified.to/integrations/webexmeetingbot.md) and [Zoom (meeting bot)](https://docs.unified.to/integrations/zoommeetingbot.md). See all [supported Calendar integrations](https://docs.unified.to/calendar/integrations.md). 

**What participants see.** No meeting bot joins as a participant, and the bot's `name` isn't sent to the meeting platform. On Zoom, participants see Zoom's notice that meeting content is being sent to an app, with your Zoom app's name, and the host may be asked to allow the app. Microsoft Teams, Webex and Google Meet show nothing in the meeting. On those three, recordings and transcripts exist only when someone turns on the platform's own recording or transcription, which shows that platform's own notice. See each integration's [setup guide](https://docs.unified.to/guides/how%5Fto%5Fbuild%5Fa%5Fmeeting%5Fbot%5Fwith%5Funified%5Fzoom%5Fmicrosoft%5Fteams%5Fwebex%5Fgoogle%5Fmeet.md) for details. 

 View field support, webhooks, and list parameters for each integration on the [Supported Integrations](https://docs.unified.to/calendar/integrations.md) 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)                                                                                                                                            |

## 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

```typescript
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]

```
