Page Comparison

Table of Contents

minLevel	1
maxLevel	6
outline	false
type	flat
separator	pipe
printable	true

Overview

A trigger action that displays a custom screen notification. The message can be customized with a title, message content, and notification style.

Image Added

When the workflow trigger event occurs, the trigger checks that any required conditions are met, and if met they are, the "set-message" action displays an inon-app screen notification message.

Info
One or more trigger actions can be set for a named event in the workflow.

`"set-message"`

Excerpt

The trigger action "set-message" creates a message notification and can include a message title and a body.

Info
Can It can be set as info, warning, or error and set to auto-close after a specified period or require user acknowledgementacknowledgment.

action (set-message)
- type
(enum)
- ❗️ Indicator of the level of the message
  - info
  - warning
  - error
- title
(string)
- For adding a title to the message
body (string) ❗️
- body❗️ For adding the content for the body of the message
tags (enum). is used as a tag for the message to record the current state when the action occurred.
- state
mode (enum) Message mode
- ack (default)
  - a user must acknowledge message to close it
- autoClose
  - disappears after 10s

❗️ indicates a mandatory parameter - the set-message "type" parameter value and the

❗️ Mandatory parameters

type

The "type" parameter value must be included.

body

The "body" parameter value are requiredmust be included.

Trigger example

Code Block

"triggers":
[
	{"event": "on-change-state",
	"conditions":
	[
		{"state":"Expired"}
	],
	"actions":
	[
		{"action": "set-message",
			"type": "info",
			"title": "Stale content",
			"body": "Content may be out of date",
			"tags": "state",
			"mode": "autoClose"}
	]}
]

Info
If When adding the JSON trigger using using the workflow builder visual editor, there is no need to include the opening `"triggers":` JSON markup notation, ; it is added automatically by the workflow builder.

The above trigger listens for a state change event to the Expired state and displays an on-screen message notification on the change of state.oImage Removed