calendar
calendar.check_availability
Check Calendar Availability
Effects: read, requires channel google_calendar
Check when you have free time in the connected calendar (Google or Outlook). Shows busy periods and free slots in a given time range. Useful for finding meeting times or checking schedule conflicts.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
account_id | integer | no | Calendar account to use when the workspace has several (Google or Outlook). OMIT to use the default one; every answer names the account and channel used. |
calendar_id | string | no | Calendar ID to check. OMIT to use the agent's configured default calendar (or primary). |
end_time | string | no | End date/time to check availability (YYYY-MM-DD or ISO 8601). Defaults to end of start_time day, or 7 days from now. |
min_duration_minutes | integer | no | Minimum duration in minutes for free slots. Filters out short gaps. Default: 30 minutes. (default 30) |
start_time | string | no | Start date/time to check availability (YYYY-MM-DD or ISO 8601). Defaults to start of today. |
timezone | string | no | IANA timezone (e.g. 'Asia/Bishkek') that start_time/end_time WITHOUT an offset are in, and that the free slots are reported in. OMIT for UTC. |
working_hours_only | boolean | no | If true, only show free slots during working hours (9 AM - 6 PM). OMIT to show all free time (the default). |
calendar.create_event
Create Calendar Event
Effects: schedule, external_api, requires channel google_calendar
Create a new event in the connected calendar (Google or Outlook). Specify the title, start time, end time, and optionally invite attendees. Use ISO 8601 format for dates (e.g., 2024-12-15T14:00:00).
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
account_id | integer | no | Calendar account to use when the workspace has several (Google or Outlook). OMIT to use the default one; every answer names the account and channel used. |
add_google_meet | boolean | no | Old name of add_online_meeting (kept for existing agents). OMIT; use add_online_meeting. |
add_online_meeting | boolean | no | If true, the event gets a video meeting link of its own: Google Meet on a Google calendar, Microsoft Teams on an Outlook calendar. OMIT to skip the link. |
attendees | array | no | List of attendee email addresses to invite. |
calendar_id | string | no | Calendar ID to create the event in. OMIT to use the agent's configured default calendar (or primary). |
conference_data | object | no | Conference data for Google Meet. Alternative to add_google_meet flag. |
description | string | no | Event description/notes. |
end | string | no | Event end time in ISO 8601 format. If not provided, defaults to 1 hour after start. Also accepts 'end_time' as alias. |
end_time | string | no | Alias for end - event end time. |
location | string | no | Event location (physical address or virtual meeting link). |
send_notifications | boolean | no | Whether to email the attendees about the new event. true (default) sends the invitations; false saves the event silently. On Outlook calendars a silent save is refused when the event has guests. (default True) |
start | string | no | Event start time in ISO 8601 format (e.g., 2024-12-15T14:00:00). Also accepts 'start_time' as alias. |
start_time | string | no | Alias for start - event start time in ISO 8601 format. |
summary | string | no | Event title/summary. Required. Also accepts 'title' as alias. |
timezone | string | no | IANA timezone (e.g. 'Asia/Bishkek') that start/end WITHOUT an offset are in: the zone of the person the time was agreed with. OMIT only when that is the calendar's own zone, which is what an event with no timezone gets. |
title | string | no | Alias for summary - event title. |
calendar.delete_event
Delete Calendar Event
Effects: delete, external_api, requires channel google_calendar
Delete an event from the connected calendar (Google or Outlook). This action cannot be undone. Use with caution.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
account_id | integer | no | Calendar account to use when the workspace has several (Google or Outlook). OMIT to use the default one; every answer names the account and channel used. |
calendar_id | string | no | Calendar ID containing the event. OMIT to use the agent's configured default calendar (or primary). |
event_id | string | yes | ID of the event to delete. Required. |
send_notifications | boolean | no | Whether to send cancellation notifications to attendees. (default True) |
calendar.list_events
List Calendar Events
Effects: read, requires channel google_calendar
List events from the connected calendar (Google or Outlook). Shows upcoming events by default. Can filter by date range and search query.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
account_id | integer | no | Calendar account to use when the workspace has several (Google or Outlook). OMIT to use the default one; every answer names the account and channel used. |
calendar_id | string | no | Calendar ID to list events from. OMIT to use the agent's configured default calendar (or primary). |
date_from | string | no | Start date/time to query (YYYY-MM-DD or ISO 8601 format). Defaults to now. Alias: time_min. |
date_to | string | no | End date/time to query (YYYY-MM-DD or ISO 8601 format). Defaults to 7 days from now. Alias: time_max. |
max_results | integer | no | Maximum number of events to return. (default 25) |
query | string | no | Free text search query to filter events. |
calendar.meet_policy
Calendar Meet Auto-Join Policy
Effects: write, requires channel google_calendar
Read or change whether a meeting bot joins the Google Meet calls of a connected Google Calendar. With no setting given it only READS the current policy: auto_join_enabled, auto_join_transcribe_only, default_meet_agent_id, meet_caption_language. Settings given are changed, the rest stay. auto_join_enabled=true needs auto_join_transcribe_only=true (the bot only writes the transcript, never speaks) or a default_meet_agent_id (the agent the bot acts as). Changing needs the editor, admin or owner role and is written to the workspace access journal.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
account_id | integer | no | The Google Calendar account (from channels.list). OMIT to use the default one; the answer names the account used. |
auto_join_enabled | boolean | no | Switch the bot's auto-join on or off. OMIT to leave as is. |
auto_join_transcribe_only | boolean | no | The bot joins with no agent: writes the transcript, never speaks. OMIT to leave as is. |
default_meet_agent_id | integer | no | The agent the bot acts as (agents.list). OMIT to leave as is. |
meet_caption_language | string | no | Caption language, ISO-639-1 code such as en or ru. OMIT to leave as is. |
calendar.update_event
Update Calendar Event
Effects: schedule, external_api, requires channel google_calendar
Update an existing event in the connected calendar (Google or Outlook). Can modify title, time, location, description, and attendees, add a Google Meet link to an event that has none, and move the event to another calendar of the same account. Only specified fields will be updated.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
account_id | integer | no | Calendar account to use when the workspace has several (Google or Outlook). OMIT to use the default one; every answer names the account and channel used. |
add_google_meet | boolean | no | Old name of add_online_meeting (kept for existing agents). OMIT; use add_online_meeting. |
add_online_meeting | boolean | no | If true, gives the event a video meeting link of its own when it has none (Google Meet on a Google calendar, Microsoft Teams on an Outlook calendar); an event that already has one keeps it. OMIT to leave the event's link as it is. |
attendees | array | no | New list of attendee emails. Replaces existing attendees. |
calendar_id | string | no | Calendar ID containing the event. OMIT to use the agent's configured default calendar (or primary). |
description | string | no | New event description. Optional. |
end | string | no | New end time in ISO 8601 format. Optional. |
event_id | string | yes | ID of the event to update. Required. |
location | string | no | New event location. Optional. |
move_to_calendar | string | no | Move the event to another calendar of the same Google account, named by its id or its name, case-insensitive (e.g. a separate calendar kept for one project, so it can be shown or hidden on its own). The event keeps its id, Meet link and attendees, and the move itself notifies nobody (a field changed in the same call still notifies the attendees, as any update does). Calendar auto-join reads the primary calendar only, so the meeting bot does not join an event moved out of it. OMIT to leave the event where it is. |
send_notifications | boolean | no | Whether to email the attendees about the change. true (default) notifies them; false saves the change silently. On Outlook calendars a silent save is refused when the event has guests. Moving an event to another calendar never notifies the guests. (default True) |
start | string | no | New start time in ISO 8601 format. Optional. |
summary | string | no | New event title/summary. Optional. |