Skip to main content

Calendar Actions

Calendar actions are built-in event actions that operate on a connected calendar. They let content read and modify meetings — get, create, start, end, cancel, extend, and suspend — directly from an event, without configuring a generic Call API action for each calendar operation.

Requires a calendar datasource

Calendar actions operate on a calendar datasource (Google, Microsoft, or iCalendar). Set up the calendar credential and datasource first — see Calendar credential. On the Meeting Room app, the calendar bound to My dataset is the one these operations act on.

The operations​

There are seven operations. Each acts on the connected calendar datasource.

OperationWhat it does
Get meetingsReads meetings from the calendar for an optional time window
Create meetingAdds a new meeting to the calendar
Start meetingMarks an existing meeting as started, recording who started it
End meetingEnds an existing meeting, closing it earlier than scheduled
Cancel meetingCancels an existing meeting
Extend meetingAdds time to an existing meeting
Suspend meetingSuspends an existing meeting for a set duration
Time values are in milliseconds

All timestamps (startDate, endDate, from, to) and durations are expressed in milliseconds since the Unix epoch (or millisecond length for durations). If a required value is missing or invalid, the operation is ignored and a warning is logged.

Get meetings​

Reads meetings from the connected calendar for an optional time window.

  • From (optional) — window start (from).
  • To (optional) — window end (to).

If both are left empty, the range defaults to roughly one day ago through one month ahead. The result is returned as a got-meetings event.

Create meeting​

Adds a new meeting to the calendar.

  • Start — meeting start (startDate).
  • End — meeting end (endDate).
  • Title — meeting title (title).
  • Description (optional) — meeting description (description).

Start meeting​

Marks an existing meeting as started, recording who started it.

  • Event ID — the target meeting's identifier (eventId).
  • Started by — the user or device that started the meeting (startedBy).

End meeting​

Ends an existing meeting, closing it earlier than its scheduled end.

  • Event ID — the target meeting's identifier (eventId).
  • End (optional) — new end time (endDate). If left empty, the meeting is closed immediately.

Cancel meeting​

Cancels an existing meeting.

  • Event ID — the target meeting's identifier (eventId).

Extend meeting​

Adds time to an existing meeting.

  • Event ID — the target meeting's identifier (eventId).
  • Duration — how much time to add (duration).

Suspend meeting​

Suspends an existing meeting for a set duration.

  • Event ID — the target meeting's identifier (eventId).
  • Duration — how long to suspend it for (duration).
How to obtain the Event ID

The Event ID is the unique identifier of a meeting in the underlying calendar provider (Google, Microsoft, iCalendar). Read it from the bound calendar datasource's event list, or from the Get meetings result.

Triggering Calendar actions​

Calendar actions are initiated the same way as any other action — from a widget's touch actions, or from Sensor, Data Source, Time-Based, and Page Change events under Content > External Events. For the full list of trigger sources and how to configure them, see Action Triggers.

Notes​

  • Calendar actions act on the connected calendar datasource — make sure a valid calendar datasource is bound before triggering any operation.
  • The modify operations (create, start, end, cancel, extend, suspend) require the calendar provider to grant write access to the connecting account. Read-only calendars support Get meetings only.
  • These built-in actions replace the previous approach of configuring a generic Call API action to reach the calendar.
Last updated on