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 newevent events – see Availability section near end of page for details

References

ReferenceTypeEvent(s)DescriptionVer

Attachments

These references are available in events arising from changes to page or blog post attachments.

See also: @type@ in Content section.

@comment@Text

attachmentschanged

attachmentadded

attachmentremoved

attachmentversionremoved

attachmentupdated

Comment associated with the attachment.

  • Can be set when uploading attachment via web form
  • Can be edited from the attachment properties screen


@name@
or @filename@
Text

attachmentschanged

attachmentadded

attachmentremoved

attachmentversionremoved

attachmentupdated

The filename of the attachment, including extension.


@size@Number

attachmentschanged

attachmentadded

attachmentremoved

attachmentversionremoved

attachmentupdated

The file size, in bytes.


Content

These references are available in all events, and relate to the content associated with the workflow event.

@author@
or @creator@
Usernameall 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@Linkall events

A link (looks like: Content title) to the page or blog post for either:

  • most recent published state version, or
  • most recent unrestricted state version

See also: Publishing, Status Indicator Circles


@pageid@Numberall events

The ID of the page or blog post

See also: How to get a Page ID (Atlassian)


@pagelatest@Linkall 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@Textall events

The title (looks like: Content title) of the page (or blog post?)

4.9.4

AWP-3193 Unavailable in pagecreated event from v4.17.4 → v5.0.8 (fixed in v5.1)

@type@Textall events

The content type, either:

  • page – wiki pages
  • news – blog posts
  • attachment – file attachment (only in attachment-related events)


@version@

Numberall events

The version number of the page or blog post

See also: Page history (Atlassian)

5.1

Content Reviews

These references are only available in events arising from Approving or Rejecting content during Reviews.

See also: Attribute References

@approval@
or @approvalname@

Text

pageapproved

pagerejected

newsapproved

newsrejected

approvalassigned

approvalunassigned

The name of the the content review (as specified in the associated {approval} macro) which the event relates to.



@approvalassignees@List of
Username

pageapproved

pagerejected

newsapproved

newsrejected

approvalassigned

approvalunassigned

List of usernames assigned to the content review which the event relates to.
@approvalcomment@Text

pageapproved

pagerejected

newsapproved

newsrejected

The note that was added whilst Approving or Rejecting during a content review (event name determines which situation occurred).

See also: comment and taskcomment references


@approvaldate@Text

pageapproved

pagerejected

newsapproved

newsrejected

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

pageapproved

pagerejected

newsapproved

newsrejected

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

approvalassigned

approvalunassigned

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 @approvalassignees@ instead.

Username of assigned reviewer.

Deprecated
from 3.2
@selectedapprovers@List of
Username

DEPRECATED Use @approvalassignees@ instead.

List of assigned reviewer usernames.

Deprecated
from 3.2

Event

These references relate specifically to the event itself.

@date@Textall 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@Textall 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@Textall events

If an action fails, in a trigger that defines a newevent, this reference will contain the error message in triggers that handle the new event.


@user@Usernameuser-initiated events

The username of the person responsible for initiating the event.


@userfullname@Textuser-initiated events

The full name of the person responsible for initiating the event.

Note: Their username is specified by the @user@ reference.


Labels

These references are only available in events arising from adding or removing Labels.

@addedlabel@TextlabeladdedName of the label which was added
@removedlabel@TextlabelremovedName of the label which was removed
@label@Text

labeladded

labelremoved

Name of the label which was added or removed (as applicable to the event)


PDF Export

These references relate to events arising from PDF export with the K15t Scroll PDF Exporter app

@attachmentURL@Textpdf-export-success

The URL of the newly exported PDF that has been attached to the page

6.14
@errormessage@Textpdf-export-error

Details of the error returned by the K15t Scroll PDF Exporter app if the export action fails

6.14

States

These references relate to the current workflow state.

@comment@Text

statechanged

pagestatechanged

newsstatechanged

If specified, the note that was added whilst selecting a state to transition to.

@duedate@
or @expirydate@

Text

statechanged

pagestatechanged

newsstatechanged


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.

@state@ or @awpState@

Textall events

The name of the current workflow state, as defined by the {state} macro.

Please note when referencing this workflow state value through the markup please use either


Tasks

These references are available in events arising from Tasks.

@duedate@Textany 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@
Textany task eventThe name of the task.
@taskassignee@UsernametaskassignedThe username of the person who is currently assigned to the task.
@taskassigner@UsernametaskassignedThe username of the person who assigned the task.
@taskcompleter@UsernametaskcompletedThe username of the person who completed the task.
@taskcreator@Usernameany task eventThe username of the person who created the task.
@taskcomment@Text

taskassigned

taskcompleted

The note associated with a task:

  • assignment note, if event is taskassigned
  • completion note, if event is taskcompleted

Read Confirmation

These references are available in events arising from Read Confirmations.

@readassignees@Usernameconfirmationrequested

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

confirmationcompleted

confirmationacknowledged

A comma-separated list of usernames who have confirmed they have read the content.
@pendingreaders@Usernameconfirmationrequested

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.


Workflow

These references relate to the workflow associated with the content.

@pageactivity@Linkall 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@Textall eventsThe 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 availabilityUse in custom events?
all events(tick)
specific event(s)(error)

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

See also