set-message trigger action

Overview

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

When the workflow trigger event occurs the trigger will check that any required conditions are met, and if met the "set-message" action displays an in-app notification message.

"set-message"

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

It can be set as info, warning or error and can be set to auto-close after a specified period or require a read confirmation.

• 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. By default, "ack", a user will have to acknowledge it, while with "autoClose", it'll disappear after 10s.

  • ack

  • autoClose

❗️ 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"}
	]}
]

The above trigger listens for a state change event to the Expired state and will display 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