Fresh terminology for automation rules and components

An automation ‘rule’ is now a ‘flow', and a ‘component’ is now a 'step’. You may notice some inconsistencies in the documentation while we make this change. Read more about the updates in Automation

Create automation flows in Confluence

Flows allow you to automate actions in your system based on criteria you define.

Automation flows are made up of three steps: triggers that kick off the flow, conditions that refine the flow, and actions that perform tasks in your site.

To create a flow, administrators will first need to navigate to Confluence automation in the location where the flow will function:

Site admins and Confluence admins can create and enable flows that function across Confluence in Global automation.

Space admins can create and enable flows for individual spaces in Space automation.

While you may not think of yourself as an administrator, if you have a personal space you’re an admin of your space!

To navigate to Global automation:

Only site admins and Confluence admins can view Global automation.

  1. Select the wheel icon () in the top-right corner to open Confluence administration.

  2. Find Admin tools in the left-hand navigation.

  3. Select Automation.

 

To navigate to space automation (space admins):

Only space admins can view Space automation.

  1. Go to the space where you’d like to create a flow.

  2. From the sidebar, select Automation.

  3. Select Flows from the Automation card.

To access space Automation from a page (space admins):

  1. Go to a space where you're an admin.

  2. Open a page in view mode.

  3. On the top right toolbar, select the lightning bolt icon or press a.

Menu shows lightning bolt icon for automation at the top of a published page

If you don’t see Automation in Confluence administration or Space settings, this might be why:

  • You're on the Space Overview page, a whiteboard, or a database. The automation icon appears only on pages in view mode.

  • You’re not an admin of the space you’re in (for Space automation).

  • You’re not a site admin or Confluence admin (for Global automation).

  • Your team has Cloud Standard or Cloud Free – automation is a premium feature in Confluence.

Once you’re in Global automation or Space automation, there are two ways to create flows:

  • Create a flow with Rovo

  • Start with a template

  • Create a flow from scratch

Create a flow with Rovo

To create a flow with Rovo:

  1. Select Create with Rovo in the top right of automation.

  2. Describe the flow you’d like to create, including a trigger and action. You can also use one of the examples provided by selecting Show me an example.

  3. Select Preview flow to see how the flow works.

  4. Optionally, rename the flow and configure the flow details.

  5. Use the flow summary on the left to make edits:

    1. Select each step in the flow chain to view and configure it.

    2. Select Add step to add more conditions, branches, or actions.

    3. Select Flow details to change the name and default functionality settings (like Owner and Actor).

  6. When your flow is complete, select the Turn it on button (at the top) to save and enable it.

More on creating flows with Rovo in Confluence

Create a flow from a template

Screenshot of the different templates you can use to create an automation rule in Confluence

A flow template functions similarly to a page template: It provides a starting point with appropriate steps pre-selected and arranged in the flow chain on the left.

To create a flow from a template:

  1. Select the Create flow button in the top-right of automation. A dropdown will appear.

  2. Select Use a template.

  3. Select a flow template.

  4. Optionally, rename the flow and configure the flow details.

  5. Use the flow summary on the left to make edits:

    1. Select each step in the flow chain to view and configure it.

    2. Select Add step to add more conditions, branches, or actions.

    3. Select Flow details to change the name and default functionality settings (like Owner and Actor).

  6. When your flow is complete, select the Turn it on button (at the top) to save and enable it.

The flow chain contains the instructions for the flow. Once your flow is enabled, steps will run in the order they appear from top to bottom.

Drag and drop to reorder them. Hover and select the X to remove them.

Although the feature allows you to add steps in any order, they won’t necessarily work in any order.

After you enable your flow, confirm that it runs successfully by viewing Status in the automation audit log.

After you turn on your flow, you’ll see a green toggle switch turned ON, indicating that the flow is enabled. You can toggle the switch off to disable the flow at any time. Alternatively, select Return to flow to go back to the automation Flows tab. The name of your new flow will appear in the flows table, in alphabetical order. Find the row with your flow's name and toggle the Enabled switch to off. If you add a new step after enabling, you’ll need to select Update to apply any new changes to the flow.

Create a flow from scratch

Screenshot of how it looks to create an automation rule from scratch

The flow builder lets you build a new flow from scratch (instead of using a template from the Library). It guides you through adding and configuring steps, starting with a triggering event. Each step you save will appear in a flow chain on the left.

To create a flow from scratch:

  1. Select the Create flow button in the top-right of automation. A dropdown will appear.

  2. Select Create from scratch.

  3. Select a trigger.

  4. Optionally, add conditions to your trigger. Edit it (if needed) and select Next.

  5. Select the step type (condition, branch, or action) you’d like to add next.

    1. Note: You must add an action to complete the flow.

  6. Continue adding steps until your flow is complete.

  7. Select Flow details to change any of the following default functionality settings:

    1. Name: Give your flow a name.

    2. Description: Add a description to your flow.

    3. Scope: Select which spaces the flow can run in.

    4. Owner: Determine who will receive the emails about the flow.

    5. Actor: The user the flow uses when it runs (example: Actor created the page).

    6. Notify on error: Select how often the owner should be notified when the flow fails.

  8. Select the Turn on flow button to save and enable your flow.

The flow chain contains the instructions for the flow. Once your flow is enabled, the steps will run in the order they appear from top to bottom.

Drag and drop to reorder the steps, and hover over the trash can () to delete them.

Although the feature lets you add steps in any order, they may not work in that order.

After enabling your flow, confirm it runs successfully by viewing Status in the automation audit log.

After you turn on your flow, you’ll see a green toggle switch turned ON, indicating that the flow is enabled. You can toggle the switch off to disable the flow at any time. Alternatively, select Return to flow to go back to the automation Flows tab. The name of your new flow will appear in the flows table, in alphabetical order. Find the row with your flow's name and toggle the Enabled switch to off. If you add a new step after enabling, you’ll need to select Update to apply any new changes to the flow.

Learn more about automation in Confluence.

Still need help?

The Atlassian Community is here for you.