Overview
Event references are are only available during workflow Events.
Many of them are context-sensitive, and some are limited to specific events.
Where can they be used?
You can use predefined references in the following situations:
- Triggers and Actions, which are initiated by Events
- Limitations apply to custom
neweventevents – see Availability section near end of page for details
References
| Reference | Type | Event(s) | Description | Ver |
|---|---|---|---|---|
AttachmentsThese references are available in events arising from changes to page or blog post attachments. See also: | ||||
@comment@ | Text |
| Comment associated with the attachment.
| |
@name@or @filename@ | Text |
| ||
@size@ | Number |
| ||
ContentThese references are available in all events, and relate to the content associated with the workflow event. | ||||
@author@or @creator@ | Username | all events | The username of the person who created the page or blog post. Specifically, it returns the username of the person who clicked the Publish button when the page or blog post was first created.
| |
@page@ | Link | all events | A link (looks like: Content title) to the page or blog post for either:
See also: Publishing, Status Indicator Circles | |
@pageid@ | Number | all events | The ID of the page or blog post See also: How to get a Page ID (Atlassian) | |
@pagelatest@ | Link | all events | A link (looks like: Content title) to the latest version of a page or blog post, irrespective of workflow state.
See also: Page history (Atlassian) | |
@pagetitle@ | Text | all events | 4.9.4 | |
AWP-3193 Unavailable in | ||||
@type@ | Text | all events | The content type, either:
| |
| Number | all events | The version number of the page or blog post See also: Page history (Atlassian) | 5.1 |
Content ReviewsThese references are only available in events arising from Approving or Rejecting content during Reviews. See also: Attribute References | ||||
| Text |
| The name of the the content review (as specified in the associated | |
@approvalassignees@ | List ofUsername |
| List of usernames assigned to the content review which the event relates to. | |
@approvalcomment@ | Text |
| The note that was added whilst Approving or Rejecting during a content review (event name determines which situation occurred). See also: | |
@approvaldate@ | Text |
| The date and time on which the page or blog post was Approved or Rejected (event name determines which situation occurred). Format of the date is defined by the Date Format setting in Confluence General Configuration. | |
@approvaluser@ | Username |
| The username of the person who Approved or Rejected, resulting in the event being sent. | |
If using partial=true on the {trigger} macro, it will be the username of the current user who triggered the event, otherwise it will be the user who gave the deciding vote. | ||||
@comment@ | Text |
| A note made during a content review while assigning a reviewer, or unassigning a reviewer (event name determines which situation occurred). | |
@selectedapprover@ | Username | DEPRECATED Use Username of assigned reviewer. | Deprecated from 3.2 | |
@selectedapprovers@ | List ofUsername | DEPRECATED Use List of assigned reviewer usernames. | Deprecated from 3.2 | |
EventThese references relate specifically to the event itself. | ||||
@date@ | Text | all events | Date on which the event occurred Format of the date is defined by the Date Format setting in Confluence General Configuration. | 4.4 |
@datetime@ | Text | all events | Date and time on which the event occurred Format of the date is defined by the Date Time Format setting in Confluence General Configuration. | 4.4 |
@errormessage@ | Text | all events | If an action fails, in a trigger that defines a
| |
@user@ | Username | user-initiated events | ||
@userfullname@ | Text | user-initiated events | The full name of the person responsible for initiating the event. Note: Their username is specified by the | |
LabelsThese references are only available in events arising from adding or removing Labels. | ||||
@addedlabel@ | Text | labeladded | Name of the label which was added | |
@removedlabel@ | Text | labelremoved | Name of the label which was removed | |
@label@ | Text |
| Name of the label which was added or removed (as applicable to the event)
| |
PDF ExportThese references relate to events arising from PDF export with the K15t Scroll PDF Exporter app | ||||
@attachmentURL@ | Text | pdf-export-success | The URL of the newly exported PDF that has been attached to the page
| 6.14 |
| Text | pdf-export-error | 6.14 | |
StatesThese references relate to the current workflow state. | ||||
@comment@ | Text |
| If specified, the note that was added whilst selecting a state to transition to. | |
| Text |
| The due date for the current workflow state, if defined. Format of the date is defined by the Date Format setting in Confluence General Configuration. | |
For task-related events, the @duedate@ reference denotes the due date for the task, not the state. | ||||
| Text | all events | The name of the current workflow state, as defined by the Please note when referencing this workflow state value through the markup please use either
| |
TasksThese references are available in events arising from Tasks. | ||||
@duedate@ | Text | any task event | The due date for the task, if defined. Format of the date is defined by the Date Format setting in Confluence General Configuration. | |
@task@or @taskname@ | Text | any task event | The name of the task. | |
@taskassignee@ | Username | taskassigned | The username of the person who is currently assigned to the task. | |
@taskassigner@ | Username | taskassigned | The username of the person who assigned the task. | |
@taskcompleter@ | Username | taskcompleted | The username of the person who completed the task. | |
@taskcreator@ | Username | any task event | The username of the person who created the task. | |
@taskcomment@ | Text |
| The note associated with a task:
| |
Read ConfirmationThese references are available in events arising from Read Confirmations. | ||||
@readassignees@ | Username | confirmationrequested | A comma-separated list of usernames who have been assigned to read the content. If the read confirmation is added to the final state without assigned readers then this may be empty. | |
@confirmedreaders@ | Username |
| A comma-separated list of usernames who have confirmed they have read the content. | |
@pendingreaders@ | Username | confirmationrequested | A comma-separated list of usernames who have NOT confirmed they have read the content. This will only include users who have been assigned as readers for the read confirmation or need to reconfirm a read confirmation. | |
WorkflowThese references relate to the workflow associated with the content. | ||||
@pageactivity@ | Link | all events | A link (looks like: Page Activity) to the Activity Report for the page or blog post.
| |
App configuration setings may prevent view-only users from accessing the Activity Report - Content. An alternative would be to use the {pageactivity} macro in a message or email. | ||||
@pageworkflowname@ | Text | all events | The name of the workflow, as defined by the name parameter of the {workflow} macro | |
Availability in custom event triggers
Custom events can be created with the newevent parameter on the {trigger} macro (see: Triggers for details). Availability of event references in custom events (their triggers and actions) depends on whether the reference is event specific or not.
| Reference availability | Use in custom events? |
|---|---|
| all events |  |
| specific event(s) |  |
In cases where a reference will not be available, you could use the {set-metadata} macro in the original event trigger to store the value as metadata, and then retrieve it in the custom event trigger using Metadata references. Alternatively, you could use other types of value reference, such as Attribute References or Supplier References, to retrieve the data by ohter means.
Be mindful of the possibility that the original event could occur again, causing the previous value to change prior to the custom event trigger being able to process it. This is a particularly important consideration when using queued trigger actions. If there is a risk of this happening, you should take measures to prevent the original event from happening until after the custom event trigger has been processed. For example, you could use the {set-state} macro in the original event trigger to transition to a temporary state with no Transitions, and then use it again as the last action in the custom event trigger to transition back to the normal workflow.
All examples
-
Adding page activity to email — Include page activity report, or a link to it, in custom email notifications
-
Attachment events — Triggering events when attachments are created, updated or removed.