Event references
Overview
Event references 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 workflow events
Limitations apply to custom newevent
events – see Availability section below.
References
Reference | Type | Event(s) | Description | Ver |
---|---|---|---|---|
AttachmentsThese references are available in events arising from changes to page or blog post attachments. See also: | ||||
| Text |
| Comment associated with the attachment.
| |
|
|
| The filename of the attachment, including extension. | |
|
|
| The file size, in bytes. | |
ContentThese references are available in all events, and relate to the content associated with the workflow event. | ||||
|
| 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. | |
|
| all events | A link (looks like: <content title>) to the page or blog post. Will include workflow state status indicator circle. See also: Publishing, State Status Indicator Circles | |
|
| all events | The ID of the page or blog post See also: How to get a Page ID (Atlassian) | |
|
| 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) | |
|
| all events | The title (looks like: <content title>) of the page (or blog post?) | 4.9.4 |
AWP-3193 Unavailable in | ||||
|
| Comala Publishing snapshot publishing events only | The snapshot document url for a snapshot created using the snapshot-page macro in a workflow trigger. See also: Snapshot document publishing Requires Comala Publishing v3.0+ and Comala Document Management v6.17.6+ | 6.17.6+ |
|
| all events | The content type, either:
| |
|
| 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 | ||||
|
|
| The name of the the content review (as specified in the associated approval macro) which the event relates to. | |
|
One or more in a list |
| List of one or more usernames assigned to the content review that the event relates to. | |
|
|
| The note that was added whilst Approving or Rejecting during a content review (event name determines which situation occurred). See also: | |
|
|
| 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. | |
|
|
| The username of the person who Approved or Rejected, resulting in the event being sent. | |
If using | ||||
|
|
| A note made during a content review while assigning a reviewer, or unassigning a reviewer (event name determines which situation occurred). | |
|
| Deprecated Use Username of assigned reviewer. | Deprecated | |
|
One or more in a list | Deprecated Use List of one or more assigned reviewer usernames. | Deprecated | |
EventThese references relate specifically to the event itself. | ||||
|
| 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 |
|
| 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 |
|
| all events | If an action fails, in a trigger that defines a | |
|
| user-initiated events | The username of the person responsible for initiating the event. | |
|
| user-initiated events | The full name of the person responsible for initiating the event. | |
LabelsThese references are only available in events arising from adding or removing Labels. | ||||
|
|
| Name of the label which was added | |
|
|
| Name of the label which was removed | |
|
|
| 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 | ||||
|
|
| The URL of the newly exported PDF that has been attached to the page | 6.14 |
|
|
| Details of the error returned by the K15t Scroll PDF Exporter app if the export action fails | 6.14 |
StatesThese references relate to the current workflow state. | ||||
|
|
| If specified, the note that was added whilst selecting a state to transition to. | |
|
|
| 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 | ||||
|
| all events | The name of the current workflow state, as defined by the state macro. |
|
TasksThese references are available in events arising from Tasks. | ||||
|
| 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. | |
|
| any task event | The name of the task. | |
|
|
| The username of the person who is currently assigned to the task. | |
|
|
| The username of the person who assigned the task. | |
|
|
| The username of the person who completed the task. | |
|
| any task event | The username of the person who created the task. | |
|
|
| The note associated with a task:
| |
WorkflowThese references relate to the workflow associated with the content. | ||||
|
| all events | A link (looks like: <page activity>) to the Activity Report for the page or blog post. | |
App configuration settings may prevent view-only users from accessing the Document Activity Report - Content. | ||||
|
| all events | The name of the workflow, as defined by the |
|
Availability in custom event triggers
Custom events are created with the newevent
parameter on the trigger macro (see: Triggers for details).
Reference availability | Use in custom events? |
---|---|
all events | |
specific event(s) |
In cases where a reference will not be available, use the set-metadata macro in the original event trigger to store the value as metadata.
This value is then retrieved in the custom event trigger using Metadata references. Alternatively, you could use another type of value reference, such as Attribute References or Supplier References, to retrieve the data by other means.
The possibility of an event occurring again is a particularly important consideration when using queued trigger actions.
If there is a risk of this happening, you need to take measures to prevent the original event from happening until after the custom event trigger has been processed.
For example,
use the set-state macro in the original event trigger to transition to a temporary state with no transitions
then use it again as the last action in the custom event trigger to transition back to the normal workflow
All examples
See also