set-message trigger action
Overview
When the workflow trigger event occurs the trigger checks that any required conditions are met, and if met the "set-message"
action displays an in-app notification message.
One or more trigger actions can be set for a named event in the workflow.
"set-message"
The trigger action "set-message"
creates a message notification and can include a message title and a body.
Can be set as info, warning or error and set to auto-close after a specified period or require user acknowledgement.
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) ❗️ For adding 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 "body"
parameter value are required
"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"}
]}
]
If adding the JSON trigger using workflow builder there is no need to include the opening "triggers":
JSON markup notation, it is added automatically by 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.
o
If the "set-messsage"
action parameter is "type":"warning"
the displayed notification is
o
If the "set-messsage"
action parameter is "type":"error"
the displayed notification is
o