trigger macro

1 Where to use it? | 2 Parameters | 3 Example | 4 All examples | 5 See also

Overview

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

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	Required	Default	Notes	Ver

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. You can filter to a specific state using the state parameter if you have more than one approval with the same name but in different states. 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. This parameter is primarily used to perform one-time initialization 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, 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 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 actions are likely to 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.
`state`		Filter to a specific active state of the workflow.
`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 handle an error in an action (for example, failure of remote publishing).
`task`		Filter to a specific `task` name.

Example

The workflow has two triggers, each 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 display the event and event filter for each trigger. To change a trigger, you must edit the trigger markup.

trigger macro

Overview

Where to use it?

Parameters

Filter by label

Filter by label

Example

All examples

See also