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

"send-email"

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 is added using:

  • one or more Atlassian userIDs†

  • one or more Atlassian groupIDs‡

  • one or more groupNames‡‡

  • one or more Email addresses

  • one or more user objects by specifying the Atlassian userIDs

  • one or more group objects by specifying Atlassian groupIDs or the Atlassian groupNames

  • one or more user type parameters (see workflow parameter references)

  • one or more 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

    • @lastUpdatedBy

    • @creator

• notification (object) ❗️ Notification holder.
  You must include at least an email "subject" and "body" as a comma-separated list within curly brackets. The "title" is optional.
  You can embed any of the following as part of the notification text: ${content.title} | ${content.link} | ${content.space}) as values in any of the following parameters

  • "subject"

  • "title"

  • "body"

❗️Mandatory parameters

• at least one value for "recipients" must be specified

• the "notification" holder must include at least one of "subject", "title", or "body"

"triggers":
[
  {"event": "on-change-state",
    "conditions":
    [
      {"state": "Review"}
    ],
    "actions":
    [
      {"action": "send-email",
        "recipients":
        [
          "@creator",
          "@watchers",
          "@lastUpdatedBy",
          "@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 review state."
        }
      }
    ]
  }
]

  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.