trigger macro

Overview

The trigger macro listens for Events, then, after filtering and confirming any prerequisite requirements, performs the actions contained in the macro body.

Where to use it?

Optional.

One or more trigger macros can be put in a workflow macro.

can be added as markup in workflow builder
if added using the markup editor, the trigger(s) must be placed after the state macro(s)

Parameters

Parameter	Default	Notes	Ver
unnamed first parameter		The event to listen to – see: Events
macro body		One or more actions to process when the trigger is activated – see: Actions
`description`		The description for the trigger: plain text can use any character set supported by your Confluence server – except some reserved characters	5.7+
conditions		Optionally apply further conditions to filter events – see: Conditions
`approval`		Required for all events relating to the approval macro. Filter to a specific `approval` name. If you have more than one approval with same name but in different states, you can also filter to a specific state using the `state` parameter. Page: Add, remove and set page restrictions using a workflow trigger Page: How can I fast-track a single rejection or a single approval decision Page: Publish to another instance using advanced remote-space publishing Page: Publishing to another space in the same instance - different-space publishing Page: Require Parameters on a state transition Page: Restricting drafts to specific users using the add-restriction macro
`initial`	`false`	Only applies to `statechanged` event, for each page or blog post the workflow is applied to. `true` – only listen for the first time the workflow transitions to the state specified by the `state` parameter. `false` – listen to every time the workflow transitions to the state specified by the `state` parameter. The primary use of this parameter is to perform one-time initialisation actions for a given piece of content. For example, on the first review of a piece of content you might want to send out additional emails, or set some metadata. Filter by label There are no items with the selected labels at this time.	3.0.1+
`label`		Only applies to `labeladded` and `labelremoved` events. Value is the name of the label that was added or removed. Page: Space mode workflow application
`newevent`		If this value is set, then a custom event identified by this value will be published when the actions are executed, and will contain a flag `success` set to `true` or `false` depending on the outcome Page: Publish to another instance using advanced remote-space publishing Page: Publishing to another space in the same instance - different-space publishing
`parameter`		Required for the `pageparameterupdate` event The name of the parameter to monitor. Filter by label There are no items with the selected labels at this time.
`partial`	`false`	Only applicable to for the following events: `pageapproved`, `pagerejected`, `newsapproved` and `newsrejected` `true` – process each individual Approve or Reject `false` – wait until all reviewers agree on either Approve or Reject Page: How can I fast-track a single rejection or a single approval decision
`queue`	`false`	Should actions be queued? `true` – Yes, queue them `false` – No, run them immediately If there is a chance that actions will take a long time to process, for example when remote publishing content, they should be queued so the end user doesn't have to wait for them to finish before continuing with their work. Page: Publish to another instance using advanced remote-space publishing Page: Publishing to another space in the same instance - different-space publishing
`state`		Required for the following events: `pagestatechanged` `statechanged` `newsstatechanged` Filter to a specific active state of the workflow. Only a single state can be specified, and it can't be negated. Page: Message notification styles Page: Publish to another instance using advanced remote-space publishing Page: Publishing to another space in the same instance - different-space publishing Page: State expiry dates
`success`	`true`	This setting is used to listen for the outcome of a custom event (set by the `newevent` parameter in a separate trigger macro). This setting can be used to handle an error in an action (for example, failure of remote publishing). Page: Publish to another instance using advanced remote-space publishing Page: Publishing to another space in the same instance - different-space publishing
`task`		If not specified, the trigger will listen for all tasks rather than a specific task. Filter to a specific `task` name. Filter by label There are no items with the selected labels at this time.

Example

The workflow has two triggers with each trigger is listening for a different approval event for the Content Review approval in the Review state.

These are

a pageapproved event trigger
a pagerejected event trigger

{workflow:Example Trigger Workflow}
   {state:Editing|submit=Review}
   {state}
   {state:Review|approved=Published|rejected=Editing}
      {approval:Content Review}
   {state}
   {state:Published|final=true|updated=Editing}
   {state}
   {trigger:pageapproved|approval=Content Review}
      {set-message:style=success}This page has been approved!{set-message}
   {trigger}
   {trigger:pagerejected|approval=Content Review}
      {set-message:style=error}This page was rejected, please make requested changes.{set-message}
   {trigger}
{workflow}

You can view and edit a workflow in workflow builder.

In workflow builder, the trigger is added to the workflow using markup.

Once added to the workflow each trigger is displayed as a non-editable workflow Rule.

Rules simply displays the event and event filter for each trigger. To change a trigger you must edit the trigger markup.

All examples

Page:

Add workflow review information to a header for inclusion in a page export — Use the workflow to add a header containing details of the workflow review to comply with a records retention policy for exported approved page PDFs
Page:

Add, remove and set page restrictions using a workflow trigger
Page:

Adding page activity to email — Include page activity report, or a link to it, in custom email notifications
Page:

Dynamic page header using a metadata value and triggers — Use a trigger to display a different page header for each state in the workflow. Page header content is set as a metadata value.
Page:

How can I fast-track a single rejection or a single approval decision — How to require everyone to approve, but only need one person to reject
Page:

Message notification styles — Test the style parameter of the {set-message} macro
Page:

Publish to another instance using advanced remote-space publishing
Page:

Publishing to another space in the same instance - different-space publishing
Page:

Require Parameters on a state transition — Require workflow parameter values to be set before moving into a workflow state.
Page:

Restricting drafts to specific users using the add-restriction macro
Page:

Selecting a workflow using content labels
Page:

Space mode workflow application
Page:

State expiry dates — Using state expiry dates, defining them with metadata, and making them editable
Page:

Stiltsoft Handy Status Macro for Confluence
Page:

Stiltsoft Talk app
Page:

Use attachment events in workflow triggers — Triggering events when attachments are created, updated, or removed.
Page:

Use blog post events in a workflow trigger — Workflow events associated with blog posts
Page:

Using set-message and metadata to display different information for the draft and published content — Using the view parameter of the set-message macro to display a different metadata when users view the draft or published versions

trigger macro

Overview

Where to use it?

Parameters

Filter by label

Filter by label

Filter by label

Example

All examples

See also