Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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"

Excerpt

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 message "type" parameter value  and the "body" parameter value are required

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

(info) If adding the JSON trigger using workflow builder there is no need to include the opening "triggers": JSON markup notation, since it will be added by workflow builder.

(green star) All messages can be removed using the "clean-messages" trigger action.

(blue star) Custom email notifications can be sent using the "send-email" trigger action.


Related Pages

List of trigger actions

Child pages (Children Display)
pageJSON Trigger actions