Users
When using the "user"
parameter in a JSON trigger, it is only possible to include the userID
, and in limited cases a user type
workflow parameter.
A JSON trigger action does not accept the Confluence userName.
In the example below, the assign trigger action uses the Confluence userID
.
"triggers": [ {"event": "on-change-state", "conditions": [ {"state": "Review"} ], "actions": [ {"action": "assign", "approval": "Teamreview", "user": "5d52a37ef0f22a0da2d6f070"} ]} ]
In the example below, the approve trigger action specifies the approver using a Confluence userID
.
"triggers": [ {"event": "on-change-state", "conditions": [ {"state": "Review"} ], "actions": [ {"action": "approve", "approval": "Teamreview", "user": "5d52a37ef0f22a0da2d6f070"} ]} ]
The "user"
parameter is used in the following JSON trigger actions:
The userId
can also be added to the "recipients"
parameter in the send-email trigger action.
Groups
When using the "group"
parameter in a JSON trigger, you can include either the groupName
and/or the groupID
, and in some cases a group type
workflow parameter.
In the example below, the send-email trigger action uses the Confluence group name qa_reviewteam for the recipients of the custom email.
"triggers": [ {"event": "on-change-state", "conditions": [ {"state": "QAReview"} ], "actions": [ {"action": "send-email", "recipients": [ "qa_reviewteam" ], "notification": {"subject": "${content.title} is in the QAReview approval state", "title": "${content.title} is in the QAReview approval state", "body": "Hello, ${content.link} in the ${content.space} space is in the QAReview approval state and needs to be reviewed for publishing"}} ]} ]
For trigger actions, the "group"
parameter is only currently used in the
- assign trigger action as approval reviewers assignees
- send-email trigger action as a value for
"recipients"
Workflow parameters
Workflow parameters defined in the workflow can be added to some trigger actions using the enclosed in the "@"
operator.
For triggers, a user or group type workflow parameter is only currently valid for use in the send-email trigger action as a value for "recipients"
.
"triggers": [ {"event": "on-change-state", "conditions": [ {"state": "Approved"} ], "actions": [ {"action": "send-email", "recipients": [ "@creator", "@my_project_team@", "@my_QA_leader@" ], "notification": {"subject": "${content.title} is in the Approved published state", "title": "${content.title} is in the Approved published state", "body": "Hello, ${content.link} in the ${content.space} space is in the Approved published 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.