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 "send-email" action sends an email to one or more specified recipients.

"send-email"

Excerpt

The trigger action "send-email" sends a custom email to one or more specified recipients. 

  • action (send-email)

  • recipients (array) ❗️Recipients to send the email to (at least one recipient value must be added). A comma separated list of one or more recipients or Confluence groups is added using:

    • one or more Atlassian userIDs

    • one or more user type workflow parameter references

    • one or more Atlassian groupIDs

    • one or more Atlassian groupNames

    • one or more group type workflow parameter references

    • one or more Email addresses

    • One or more of the following value references can also be added as a value for the "send-email" action "recipients"

      • @watchers (info) Note that @watchers refers to the watchers set at a document level, not including the watchers of the space

      • @lastUpdatedBy

      • @creator

  • notification (object) ❗️

     Notification

     Notification holder. Can include the following as a comma-separated list within curly brackets:

    • the email "subject"

    • "title"

    • "body"

  • emailContext (object)

     Email

     Email context object: ${content.title} | ${content.link} | ${content.space} 

    • These can be used in the "subject", "title" and "body" parameter values. You must include an email "subject" value and "body" value

❗️Mandatory parameters - at least one value for for "recipients" must  must be specified and the the "notification" holder  holder must include at least one of of "subject", "title", or or "body"

Code Block
"triggers":
[
	{"event": "on-change-state",
	"conditions":
	[
		{"state": "Review"}
	],
	"actions":
	[
		{"action": "send-email",
			"recipients":
			[
				"@creator",
				"@watchers",
				"@lastUpdatedBy",
				"@document_user_reviewers@",
				"@document_group_reviewers@"
			],
			"notification": {"subject": "${content.title} is In Review State",
				"title": "${content.title} is In Review State",
				"body": "Hello, ${content.link} in the ${content.space} space is in approval state and needs to be reviewed"}}
	]}
]

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

(green star) On-screen notification messages can be created using the "set-message" trigger action.

List of trigger Trigger actions

Child pages (Children Display)
pageJSON Trigger actions