Jira Rules

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

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

Multiple options are available to trigger a rule, and you can combine them by activating them with the toggle.

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

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.).

Integrate with Jira Automation Open the Automation Integration HowTo

Tip

If integrating with a custom REST-API-Call, please include the Work Item ID into the call.

Webhook Details

When calling the AutoPage webhook endpoint from an external system, use the following configuration:

• Authentication Header: x-autopage-api-key — include the API key generated by AutoPage in this header.
• URL Format: {webTriggerUrl}?method=triggerRule&ruleId={ruleId}&issueId={issueId}

Note

The webhook URL and API key are displayed in the rule’s trigger configuration after saving.

External REST API Full API reference for external integrations

---

2. Create Condition

The condition acts as a filter to specify which issues should trigger the rule. AutoPage provides two ways to define conditions: dedicated dropdown fields for common criteria and a custom JQL field for advanced filtering.

Quick Filter Fields

The following dropdown fields allow you to quickly narrow down which issues should trigger the rule:

• Project — Select one or more Jira projects. Only issues from the selected projects will match.
• Issue Type — Select one or more issue types (e.g., Bug, Story, Epic). Only issues of the selected types will match.
• Status — Select one or more statuses (e.g., Open, In Progress, Done). Only issues in the selected statuses will match.

Combining Filters with AND/OR

When you use multiple quick filter fields together with a custom JQL condition, you can choose how they are combined:

• AND — All conditions must be true (default). The issue must match every filter field and the custom JQL.
• OR — At least one condition must be true. The issue needs to match either the quick filters or the custom JQL.

AutoPage builds the final JQL query automatically. For example, selecting Project “DEV”, Issue Type “Bug”, and Status “Open” with AND produces: project in ("DEV") AND issuetype in ("Bug") AND status in ("Open")

Custom JQL

For advanced use cases, you can write your own JQL (Jira Query Language) query to filter issues based on any criteria supported by Jira.

• 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.

Tip

You can use the quick filter fields for simple criteria and add a custom JQL condition for anything beyond that. Both will be combined using the selected operator (AND/OR).

---

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

The page title can be plain text or dynamically generated using AutoPage Placeholders.

• The format used is ${key} (which evaluates to the Jira issue key).

Available Placeholders See the complete list of Placeholders

Template Source

Select the Confluence space and the specific template page that will be used as the blueprint for the created page.

The template source supports two strategies:

• Fixed Page — Select a specific Confluence page directly. This is the most common approach.
• From Custom Field — The template page ID is read from a Jira custom field on the issue. This allows different issues to use different templates.

Parent Page (Destination)

Configure where the new page will be placed in the Confluence page tree.

• Space — Select the destination Confluence space.
• Parent Page Strategy:
  • Fixed Page — Select a specific parent page. All pages created by this rule will be placed under the same parent.
  • From Custom Field — The parent page ID is read from a Jira custom field on the issue. This allows dynamic placement in the page tree based on issue data.

Tip

The “From Custom Field” strategy is particularly useful for building hierarchical page trees. See the Page Tree HowTo for a step-by-step example.

Build a Page Tree Learn how to create a hierarchical page tree reflecting your Jira issue structure

Page Labels

You can assign labels to the created Confluence pages. Labels help organize and categorize pages in Confluence and can be used for searching and filtering.

• Add one or more labels in the Page Labels field.
• Labels are applied when the page is created and updated when the rule is re-triggered.

Copy Options

When a page is created from the template, AutoPage copies the template content to the new page. The following options control what additional content is copied:

Option	Description
Copy Attachments	Copies file attachments from the template page to the new page.
Copy Permissions	Copies page-level permissions from the template to the new page.
Copy Labels	Copies labels defined on the template page to the new page.
Copy Custom Contents	Copies custom content and macros from the template to the new page.

Caution

Copy options apply to content from the template page. Page Labels (see above) are applied in addition to any copied labels.

---

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.

---

Managing Rules

Global vs. Project Scope

AutoPage rules can be scoped to either a single project or all projects:

• Project Scope — The rule only applies to issues within a specific Jira project. This is the default when creating a rule from the project-level panel.
• Global Scope — The rule applies to issues across all projects. Global rules are useful for organization-wide documentation standards.

You can switch between scopes using the toggle in the rule overview. The toggle provides two options:

• Project (Board icon) — Show and manage rules for the current project.
• Global (Globe icon) — Show and manage rules that apply to all projects.

Note

Creating global rules requires Jira administrator permissions.

Permissions Required permissions for rule creation and execution.