"triggers:" [ {"event": "on-change-state", "conditions": [ {"state": "Rejected"} ], "actions": [ {"action":"set-message", "type":"info", "title":"Hey My Wonderful design and Tech Team", "body":"We have some work to do ... it was rejected!!!"} ] } ]
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.
If the action includes a "user"
parameter, the users can only be added using the userId
. The "group"
parameter value can be added as either groupId
or groupName
. Both the "user"
and the "group"
parameters accept workflow parameters.
"change-state"
The trigger action ❗️ indicates a mandatory parameter - the state parameter and the destination state must be added for the trigger action The destination state must be specified."change-state"
causes a change of the state to the specified state if the provided parameters are valid."triggers":
[
{"event": "on-change-state",
"conditions":
[
{"final": true}
],
"actions":
[
{"action": "change-state",
"state": "Review"}
]}
]
If adding the JSON trigger using workflow builder there is no need to include the opening "t
riggers":
JSON markup notation, since it will be added by workflow builder.
"publish-page"
Publishes a single page to a different space using Comala Publishing for Cloud app. The trigger action is only available when the Comala Publishing for Cloud app is installed and the current space has been enabled as a draft space for publishing to target public space. The target space for publishing the page is configured in the Comala Publishing space settings."triggers":
[
{"event": "on-change-state",
"conditions":
[
{"final": true}
],
"actions":
[
{"action": "publish-page"}
]}
]
If adding the JSON trigger using workflow builder there is no need to include the opening "t
riggers":
JSON markup notation, since it will be added by workflow builder.
"approve"
The trigger action " ❗️ no mandatory parameter - only the The Atlassian user Identification Number (approve"
causes an approved decision to occur for a named approval if the provided parameters are valid.userID
of the approverapprove
action is required. If no named approval
, the action uses the default approval in the workflow. "triggers":
[
{"event": "on-change-state",
"conditions":
[
{"final": true}
],
"actions":
[
{"action": "approve",
"approval": "Sign-off",
"user":"5d52a37ef0f22a0da2d6f070"}
]}
]
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.
userId
) is visible in the URL when viewing the User Profile
"reject"
The trigger action ❗️ no mandatory parameter - only the The Atlassian user Identification Number ("reject"
causes a rejected decision to occur for a named approval if the provided parameters are valid.userID
of the approver"reject"
action is required. If no named approval
is not specified, the action uses the default approval in the workflow."triggers":
[
{"event": "on-change-state",
"conditions":
[
{"final": true}
],
"actions":
[
{"action": "reject",
"approval": "Sign-off",
"user":"5d52a37ef0f22a0da2d6f070"}
]}
]
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.
userId
) is visible in the URL when viewing the User Profile
"assign" and "unassign"
The trigger action ❗️ indicates a mandatory parameter - the assignee To assign members of a Confluence group as reviewers instead of a single user include At least one assignee must be specified - either a user or a group or one of each. The Atlassian user Identification Number (userId) is visible in the URL when viewing the User Profile The trigger action"assign"
will assign a user to a named approval.user
ID
from the assigneruser
ID
for the assigneegroupID
or groupName
for assignees"user"
parameter value must be specified with at least one user or instead specify at least one group "triggers":
[
{"event": "on-change-state",
"conditions":
[
{"final": true}
],
"actions":
[
{"action": "assign",
"approval": "Triagereview",
"user": "5d52a37ef0f22a0da2d6f070",
"group": "qa_reviewers"}
]}
]
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.
"group":"qa_reviewers".
The "group"
parameter can use both the groupID
and the Confluence groupName.
"unassign"
can be used to remove a specified user from a named approval. You can only assign one user and/or one group in a single
"assign"
action. You cannot add multiple values for "user"
or "group"
.
"set-expiration"
" ❗️ indicates a mandatory parameter - a The " An existing expiration period can be removed using set-expiration
" will set an expiry period for a state."dueDate"
parameter value must be specified"triggers":
[
{"event": "on-change-state",
"conditions":
[
{"final": true}
],
"actions":
[
{"action": "set-expiration",
"dueDate": "P6M"}
]}
]
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.
dueDate"
period is set using ISO 8601 format. For example "P6M3W5D"
will be 6 months, 3 weeks and 5 days from the date of transition into the state. This will override any existing expiration periods."clear-expiration".
"clear-expiration"
An existing expiration period can be removed using A new expiration date can be added using"clear-expiration".
"triggers":
[
{"event": "on-change-state",
"conditions":
[
{"final": true}
],
"actions":
[
{"action": "clear-expiration"}
]}
]
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.
"set-expiration".
"set-message"
The trigger action 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 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. mode (enum) Message mode. By default, ❗️ indicates a mandatory parameter - the message All messages can be removed using ""set-message"
creates a message notification and can include a message title and a body."ack",
user will have to acknowledge it, while with "autoClose"
, it'll disappear after 10s.ack
autoClose
"type"
parameter value and the "body" parameter value are required."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"}
]}
]
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.
clean-messages"
.
Custom email notifications can be sent using the
"send-email"
trigger action.
"clean-messages"
To remove all messages on the content simply add the A message can be set using "clean-messages"
action"triggers":
[
{"event": "on-change-state",
"conditions":
[
{"final": true}
],
"actions":
[
{"action": "clean-messages"}
]}
]
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.
"set-message"
.
"remove-restrictions"
The trigger action A useful instance would be remove all view and edit restrictions from the final state in a workflow. Space admins can configure a space workflow in the space tools Document Management dashboard to remove all page level restrictions on transition to the workflow final state."remove-restrictions"
will remove content view and edit restrictions for all users/groups."triggers":
[
{"event": "on-change-state",
"conditions":
[
{"final": true}
],
"actions":
[
{"action": "remove-restrictions"}
]}
]
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.
Only 'Confluence Cloud Standard, Premium and Enterprise Plans' enable Atlassian Confluence users to edit permissions, including global, space, and page permissions.
"send-email"
The trigger action one or more of the following value references can also be added in a comma separated list as a value for the send-email action recipients ❗️ indicates a mandatory parameter - at least one value for "recipients" must be specified and the "notification" holder must include at least one of "subject", "title", or "body" On screen notification messages can be created using the "set-message" trigger action."send-email"
sends a custom email to one or more specified recipients. userIDs
†groupIDs
‡groupNames
‡‡user type workflow parameter references
group type workflow parameter references
Email
addresses added in a comma separated list@watchers
Note that @watchers refers to the watchers set at a document level, not including the watchers of the space.
@lastUpdatedBy
@creator
subject
title
body
subject
, title
and body
parameter values. You must include an email subject
value and body
value."triggers":
[
{"event": "on-change-state",
"conditions":
[
{"state": "Review"}
],
"actions":
[
{"action": "send-email",
"recipients":
[
"@creator",
"@watchers",
"@lastUpdatedBy",
"@group_type_parameter_1@",
"@group_type_parameter_2@",
"@user_type_parameter_1@"
"@user_type_parameter_2@",
"email_1@email.com",
"email_2@email.com",
{"user": "user_ID_One"
},
{"user": "user_ID_Two"
},
{"group": "group_ID_One"
},
{"group": "group_ID_Two"
},
{"group": "group_Name_Users1"
}
{"group": "group_Name_Users2"
}
],
"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"}}
]}
]
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.
Workflow trigger-generated email 'failure to send' errors are included in the Confluence log.