addCalendar

Opens the default calendar of the user's device and shows a pre-filled "add new event" view with the provided data. Depending on the operating system and its version, this could manifest as just an in-app overlay or a complete switch to the calendar app.

note

On Android, this uses an intent mechanism and therefor does not require additional permissions, while on Apple devices, the user is prompted to allow access to the calendar on first execution. See requestPermission to manually request permission beforehand.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	Adds a new event to the user's calendar with the specified metadata.	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"endDate" (required)	String	The end time of the calendar entry. ISO 8601 format yyyyMMdd'T'hhmmss .	null
"location"	String	The location of the calendar entry	null
"notes"	String	The note added to the calendar entry	null
"startDate" (required)	String	The start time of the calendar entry. ISO 8601 format yyyyMMdd'T'hhmmss .	null
"title"	String	The title of the calendar entry	null
"url"	String	The URL that is added to the calendar entry.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Create a calendar entry

Goal: Create a calendar entry including a note and address.

To achieve this the following code can be used:

{
  "type": "addCalendar",
  "params": {
    "title": "Event n° 1",
    "notes": "First events of the day!",
    "url": "https://www.fabrik19.de/",
    "location": "Bahnhofstraße 82-86, 35390 Gießen",
    "startDate": "20240501T123000",
    "endDate": "20240501T220000"
  }
}

The values for the fields startDate and endDate are formatted according to ISO 8601.

Result:

An addCalendar action has been created.