Jira Rules
AutoPage - Jira Rule Configuration
Section titled “AutoPage - Jira Rule Configuration”AutoPage streamlines documentation by keeping Jira and Confluence in sync. This guide walks you through configuring AutoPage rules within Jira.
Accessing Rule Configuration
Section titled “Accessing Rule Configuration”After installing AutoPage on your cloud instance, you can access the configuration via the upper-left cog icon (“Apps”) or the Project left-side panel.
To create a new rule, simply click the “Create rule” button to open the creation dialog. An AutoPage rule consists of four essential blocks that need to be configured, and we will guide you through each step.
1. Create Trigger
Section titled “1. Create Trigger”Multiple options are available to trigger a rule, and you can combine them by activating them with the toggle.
Issue Events
Section titled “Issue Events”The following Jira events can be used as triggers:
- ISSUE CREATED
- ISSUE UPDATED
- ISSUE ASSIGNED
- ISSUE MENTIONED
- ISSUE COMMENTED
You can choose to use only one event, all events, or any combination.
Incoming Webhook
Section titled “Incoming Webhook”AutoPage rules can also be triggered by incoming webhooks, allowing you to fire a REST-API-Call with any method. This trigger is ideal for integrating with Jira Automation, supporting more use cases with its powerful rule engine (e.g., Version released, Sprint finished, Pull request approved, etc.).
- See how to set up AutoPage with Jira Automation in this example.
- Tip: If integrating with a custom REST-API-Call, remember to include the issue-ID in the call.
Example Screenshots of the “Create Trigger” section with “Issue events” and “Incoming webhook” options.
2. Create Condition
Section titled “2. Create Condition”The condition acts as a filter to specify which issues should trigger the rule.
- This condition uses JQL (Jira Query Language) to filter issues based on certain criteria.
- If you are unfamiliar with JQL, it is recommended to review the official Atlassian documentation.
- A simple JQL example is
project DEV AND issueType Bug
. This would limit the rule to only “Bugs” from the “DEV” project.
Example Screenshot of the “Create Condition” section with the JQL condition input field.
3. Create Action
Section titled “3. Create Action”The third part of the rule setup is defining the action. In this step, you will define the title, the source template, and the destination of the created Confluence page.
Page Title
Section titled “Page Title”The page title can be plain text or dynamically generated using Jira Smart Values.
- The format used is
${key}
(which evaluates to the Jira issue key). - A complete list of supported smart values can be found [here] (A link to the full list of smart values would go here).
Confluence Settings
Section titled “Confluence Settings”The bottom part of this section defines the Confluence settings.
- On the left, you’ll select the Confluence space containing your template and the specific template page.
- On the right, you configure the destination for the new page.
- The first dropdown defines the space where the new page should be created.
- The second dropdown defines the parent page within that space’s page tree.
Example Screenshot of the “Create Confluence page” section within the “Create Action” settings.
4. Rule Details
Section titled “4. Rule Details”Finally, you need to enter some details for your rule.
- A name for the rule is required.
- A short description is recommended to help your teammates identify the rule’s purpose.
- Optionally, you can activate or deactivate the rule using a toggle.
After configuring all details, simply hit “Save,” and your rule will be ready.
Example Screenshot of the “Rule details” section with name, description, and activate/deactivate options.