setLocalReminder

Sets a reminder with the specified title and text to be displayed at the specified time.

note

This message is presented to the user in a similar way to a push notification. Depending on the operating system and personal system settings, it is possible for these messages to be received after the intended point in time.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"channel"	String	The channel for the notification.	null
"id"	String	The ID of the reminder.	null
"image"	String	The image for the notification.	null
"notificationSound"	String	The sound for the notification.	null
"payload"	Object	The action to perform when this notification is tapped.	null
"text" (required)	String	The text of the reminder.	null
"time" (required)	String	The time of the reminder.	null
"title" (required)	String	The title of the reminder.	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 local reminder with dynamic params

Show ExampleHide Example

Set a local reminder for 5 seconds in the future.

{
  "type": "setLocalReminder",
  "leadingDelimiter": "{$",
  "trailingDelimiter": "$}",
  "dynamicParams": {
    "dynamicTime": {
      "left": {
        "left": {
          "context": "date"
        },
        "transform": "add",
        "right": {
          "value": 5000
        }
      },
      "transform": "formatDate",
      "right": "YYYY-MM-dd HH:mm:ss"
    }
  },
  "params": {
    "id": "demonstration",
    "title": "Your Reminder",
    "text": "Forgot someting?",
    "time": "{$dynamicTime$}"
  }
}

Example 1: Create a local reminder with a static time

Show ExampleHide Example

Set a local reminder for a specific time.

{
  "type": "setLocalReminder",
  "params": {
    "id": "meetingReminder",
    "title": "Meeting",
    "text": "in the conference room",
    "time": "2026-07-28 15:00:00"
  }
}