trigger macro

Owned by Robert Alexander Marshall
Last updated: Oct 22, 2024
4 min read
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.

Parameters

Parameter

Required

Default

Notes

Ver

Parameter

Required

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.

 

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.