Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
List of trigger

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

      Email addresses

    • one or more user

      type workflow parameter references

      objects by specifying the Atlassian userIDs

    • one

      one or more group objects by specifying Atlassian groupIDs

      or

      more

      the Atlassian groupNames‡‡

    • one or more

      group

      user type

       

      parameters (see workflow parameter references)

    • one or more

      Email addresses

      group type parameters (see workflow parameter references)

    • 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

      • @lastUpdatedBy

      • @creator

Info

@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


    You must include at least an email "subject" and "body" as a comma-separated list within curly brackets

    :
  • the email "subject"
  • "

    . The "title"

  • "body"
  • emailContext (object) Email context object

    is optional.
    You can embed any of the following as part of the notification text: ${content.title} | ${content.link} | ${content.space}

     These can be used in the

    ) as values in any of the following parameters

    • "subject"

      ,

    • "title"

       and

    • "body"

       parameter values. You must include an email "subject" value and "body" value
❗️Mandatory parameters - 

❗️Mandatory parameters

  • at least one value for

 
  • "recipients"

 
  • must be specified

and
  • the

 
  • "notification"

 
  • holder must include at least one of

 
  • "subject",

 
  • "title", or "body"

Panel
bgColor#EAE6FF

Each Confluence user must be specified individually using {"user":"userID"}. Add multiple Confluence users in a comma-separated list {"user":"userID_One"},{"user":"userID_Two"}, ...

‡  & ‡‡ 

"body"

Each Confluence group must be specified individually using {"group":"groupID"} and/or {"group":"groupName"}. Add multiple Confluence groups in a comma-separated list {"group":"groupID_One"},{"group":"groupID_Two"},{"group":"groupName_Users1"},{"group":"groupName_Users2"}, ...

Code Block
"triggers":"
[
	  {"event": "on-change-state",
	    "conditions":
	[
		    [
      {"state": "Review"}
    	],
	    "actions":
  	  [
		      {"action": "send-email",
			
        "recipients":
			[
				        [
          "@creator",
				"@watcher",
				          "@watchers",
          "@lastUpdatedBy",
				"@document_user_reviewers@",
				"@document_group_reviewers@"
			],
			"notification": 
          "@user_type_parameter_1@",
          "@user_type_parameter_2@",
          "@group_type_parameter_1@",
          "@group_type_parameter_2@",
          "email_1@email.com",
          "email_2@email.com",
          {"user": "user_ID_1"},
          {"user": "user_ID_2"},
          {"group": "group_ID_1"},
          {"group": "group_ID_2"},
          {"group": "group_Name_1"},
          {"group": "group_Name_2"}
        ],
        "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 approvalreview 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  JSON markup notation, since It it will be added by workflow builder.

Tip
(green star) On

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

Related Pages

Workflow trigger-generated email 'failure to send' errors are included in the Confluence log.

Trigger actions

Child pages (Children Display)
pageJSON Trigger actions