Jira Confluence
Introduction
Welcome to the documentation for the Automate integration with Jira Confluence! This guide aims to provide you with a comprehensive overview of how to utilize the powerful features available through this integration. Confluence, a document management platform, enables teams to create, edit, share, and collaborate on content seamlessly. With this integration, users can automate various tasks within Confluence, enhancing productivity and collaboration.
What is Jira Confluence?
Confluence is a robust document management platform that empowers teams to create, edit, and collaborate on a wide range of content types. From text documents and tables to images, videos, and files, Confluence offers a rich set of tools for creating and sharing information. Furthermore, Confluence seamlessly integrates with Jira, facilitating efficient collaboration between project management and documentation processes.
Key Features of Jira Confluence:
Document Collaboration: Teams can work together in real-time on documents, enabling seamless collaboration.
Rich Content Creation: Easily create various types of content, including text, images, videos, tables, and more.
Integration with Jira: Connects project management in Jira with documentation in Confluence for streamlined workflows.
Auto Mate Integration with Jira Confluence
The Automate integration with Jira Confluence offers a set of actions to automate common tasks within the Confluence app. Whether it's creating comments, retrieving content, or searching for specific information, these actions simplify document management and enhance team productivity.
Available Actions:
Create Comment
Create Content
Get Comments By Content ID
Get Content
Get Content By ID
Search Content
Using the Integration
To begin using the Automate-Jira Confluence integration, you'll need to define your credentials at Vault and configure the necessary inputs for each action. Let's explore how to use each action effectively:
Credentials
This guide explains how to create and configure a Confluence Cloud credential using OAuth 2.0 (Authorization Code Grant – 3LO), including how to define the required scopes.
Step 1: Open the Credential Creation Screen
Navigate to Application Credentials and click Add New Credential.
Step 2: Configure Basic Settings
Connector Name: Enter a clear and reusable name (e.g. Confluence Cloud – Prod)
Authentication Type: Select OAuth 2.0
Confluence Cloud URL: Enter your Confluence instance URL (e.g. https://your-domain.atlassian.net)
Step 3: Define Scopes
Enter scopes separated by spaces. Use classic scopes where possible and follow the least-privilege principle.
Read Access
Read & Write Access
Administrative Access (Optional)
For a full list of Confluence OAuth 2.0 scopes and descriptions, see the official Atlassian documentation: https://developer.atlassian.com/cloud/confluence/scopes-for-oauth-2-3LO-and-forge-apps/#scopes
The offline_access scope is required to obtain refresh tokens. If this scope is not included, the authorization flow may fail or the connection may expire, resulting in authentication errors.
Default Recommended Scopes
The following scopes are enabled by default and recommended to ensure full and stable functionality of the Confluence integration.
These scopes collectively enable:
Reading and managing Confluence content
Creating and updating pages and attachments
Accessing space-level metadata
Searching content across spaces
Maintaining long-lived authentication via refresh tokens
Step 4: Create the Credential
(Optional) Enable Set as default credential if this will be the primary Confluence connection. Click Connect & Create and complete the Atlassian authorization flow. The credential is successfully created and can be used for Confluence API operations based on the configured scopes.
How To Use Actions
Let's explore the available actions within the Automate-Jira Confluence integration and how to use them:
Create Comment
Description: Creates a comment on a specific piece of content in Confluence.
Purpose: Add commentary or notes to existing Confluence content.
Usage:
Provide the Space Key of the space where the comment will be created.
Specify the Content ID of the content to comment on.
Choose the Comment Type (e.g., inline, block).
Enter the Text of the comment.
Execute the action to create the comment.
Input:
Space Key: The key of the space where the comment will be created.
Content ID: The ID of the content to comment on.
Comment Type: Specify the type of comment (e.g., inline, block).
Text: The text of the comment.
Output:
The result after creating the comment.
Create Content
Description: Creates new content within a Confluence space.
Purpose: Generate new pages or blog posts in Confluence.
Usage:
Specify the Type of content to create (e.g., page, blog post).
Provide the Space Key of the space where the content will be created.
Enter the Title of the new content.
Add the Body, the main content of the new piece (supports rich text formatting).
Execute the action to create the content.
Input:
Type: The type of content to create (e.g., page, blog post).
Space Key: The key of the space where the content will be created.
Title: The title of the new content.
Body: The main body of the content (supports rich text formatting).
Output:
The result after creating the content.
Get Comments By Content ID
Description: Retrieves comments associated with a specific piece of content.
Purpose: Fetch comments related to a particular Confluence content.
Usage:
Provide the Content ID of the content to retrieve comments for.
Optionally, specify the Limit of comments to retrieve.
Execute the action to get the comments.
Input:
Content ID: The ID of the content to retrieve comments for.
Limit: The maximum number of comments to retrieve (optional).
Output:
The retrieved comments, including their IDs, text, and author information.
Get Content
Description: Retrieves content from a Confluence space based on specified criteria.
Purpose: Obtain content details such as pages or blog posts within a space.
Usage:
Specify the Type of content to retrieve (e.g., page, blog post).
Provide the Space Key of the space where the content is located.
Optionally, set the Limit for the maximum number of content items to retrieve.
Execute the action to get the content.
Input:
Type: The type of content to retrieve (e.g., page, blog post).
Space Key: The key of the space where the content is located.
Limit: The maximum number of content items to retrieve (optional).
Output:
The retrieved content, including its ID, title, body, and author information.
Get Content By ID
Description: Retrieves specific content by its unique ID.
Purpose: Fetch detailed information about a specific Confluence content.
Usage:
Provide the Content ID of the content to retrieve.
Execute the action to get the content details.
Input:
Content ID: The ID of the content to retrieve.
Output:
The retrieved content, including its ID, title, body, and author information.
Search Content
Description: Search for content within Confluence based on specified criteria.
Purpose: Find relevant content matching specific search parameters.
Usage:
Specify the Type of content to search for (e.g., page, blog post).
Enter the Title of the content to search for.
Optionally, set the Limit for the maximum number of search results to return.
Choose whether to Include Archived Spaces in the search.
Choose whether to Exclude Current Spaces in the search.
Optionally, provide an Excerpt of the content to include in search results.
Execute the action to search for the content.
Input:
Type: The type of content to search for (e.g., page, blog post).
Title: The title of the content to search for.
Limit: The maximum number of search results to return (optional).
Include Archived Spaces: Whether to include content from archived spaces in the search.
Exclude Current Spaces: Whether to exclude content from current spaces in the search.
Excerpt: An excerpt of the content to include in the search results (optional).
Output:
The search results, including IDs, titles, and excerpts of the matched content.
Additional Tips
Last updated