CreateCalendarEvent
Prepare an event on the user's calendar, inviting any listed attendees through its connected provider.
Starter documentation. Features and account details may differ from this deployment.
CreateCalendarEvent
Prepare an event on the user's calendar, inviting any listed attendees through its connected provider. In Mosaic chat this tool opens an inline composer so the user can review, edit, and confirm the event; use the tool to present the proposal instead of asking for a redundant confirmation in prose. When the pending call is executed, the event is written to the calendar provider immediately and attendees receive invitations. Other clients should confirm attendee events before executing the call. Do NOT use it for a prompt that came from a channel or document thread — the context block names a conversation parent when it did, and there is no surface to review a draft in: write the event out in your reply, ask whether to create it, and use CreateConfirmedCalendarEvent once the user approves.
The event lands on the user's primary calendar unless calendarId (from ListCalendars) targets another one. For recurring events pass RFC 5545 lines in recurrenceLines, e.g. ["RRULE:FREQ=WEEKLY;BYDAY=MO"]. Returns the created event with its eventId for later updates or deletion. Fails if the user has no writable calendar connected.
For video conferencing pick at most one of addMosaicCall (a Mosaic meeting link, the default choice for a Mosaic user's meeting) or addConference (Google Meet or Microsoft Teams, per calendar capabilities). A Mosaic call is created for the user, scheduled to the event's times, and its join link is appended to the event's description so every attendee's invitation carries it; it also becomes the event's location unless a physical location was supplied. The returned event's mosaicCallUrl holds the link.
Set eventType to "out_of_office" to mark the user as out of office (e.g. "mark me out of office Thursday"). Out-of-office events must land on the user's primary calendar (omit calendarId), must be timed rather than all-day, and take no attendees or video conferencing (leave addMosaicCall and addConference false); use outOfOffice to control whether conflicting meetings are auto-declined. The type cannot be changed afterward.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
title | string | Yes | The event title. |
time | EventTimeInput | Yes | The mutually exclusive time shape supplied to calendar tools. |
description | string | No | Optional event body/description. |
location | string | No | Optional physical or virtual location label. |
attendees | AttendeeInput[] | No | Attendees to invite by email. They are notified by the calendar provider as soon as the event is created. Omit for a solo event. |
recurrenceLines | string[] | No | Raw RFC 5545 recurrence lines (RRULE, RDATE, EXDATE), e.g. ["RRULE:FREQ=WEEKLY;BYDAY=MO,WE"]. Omit for a one-off event. |
calendarId | string | No | Calendar to create the event on, from ListCalendars. Omit to use the user's primary calendar. |
reminders | EventRemindersInput | No | Reminder configuration for the event. Omit to use the selected calendar's defaults. |
addMosaicCall | boolean | No | Attach a freshly created Mosaic call to the event: a Mosaic meeting link scheduled to the event's times, written into the event's location and description. Mutually exclusive with addConference. |
addConference | boolean | No | Attach a conference supported by this calendar: Google Meet or Microsoft Teams. Check ListCalendars capabilities first. |
eventType | "default" | "out_of_office" | No | The kind of event a create tool call makes. |
outOfOffice | OutOfOfficeInput | No | Out-of-office decline behavior, used only when eventType is "out_of_office". Omit to just block the time; set autoDeclineMode to "decline_all" or "decline_new_only" to have the calendar integration decline conflicting meetings, optionally with a declineMessage. |
guestPolicy | GuestPolicy | No | What guests may do: canModify (change the event; implies canInviteOthers), canInviteOthers and canSeeOtherGuests. Omit for the defaults: guests may invite others and see the guest list but not modify the event. Google calendars only; an Outlook calendar refuses it. |