# 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:

* <mark style="color:orange;">**Document Collaboration:**</mark> <mark style="color:orange;"></mark><mark style="color:orange;">Teams can work together in real-time on documents, enabling seamless collaboration.</mark>
* <mark style="color:orange;">**Rich Content Creation:**</mark> <mark style="color:orange;"></mark><mark style="color:orange;">Easily create various types of content, including text, images, videos, tables, and more.</mark>
* <mark style="color:orange;">**Integration with Jira:**</mark> <mark style="color:orange;"></mark><mark style="color:orange;">Connects project management in Jira with documentation in Confluence for streamlined workflows.</mark>

## 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:

* <mark style="color:green;">Create Comment</mark>
* <mark style="color:green;">Create Content</mark>
* <mark style="color:green;">Get Comments By Content ID</mark>
* <mark style="color:green;">Get Content</mark>
* <mark style="color:green;">Get Content By ID</mark>
* <mark style="color:green;">Search Content</mark>

## Using the Integration

To begin using the Automate-Jira Confluence integration, you'll need to define your credentials at [Vault ](https://docs.autommate.com/userguide/product-features/management/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\
  \&#xNAN;*(e.g. Confluence Cloud – Prod)*
* **Authentication Type:** Select **OAuth 2.0**
* **Confluence Cloud URL:** Enter your Confluence instance URL\
  \&#xNAN;*(e.g.* [*https://your-domain.atlassian.net*](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:confluence-content.summary
read:confluence-space.summary
search:confluence
read:confluence-user
```

**Read & Write Access**

```
read:confluence-content.all
write:confluence-content
write:confluence-file
read:confluence-user
```

**Administrative Access (Optional)**

```
write:confluence-space
manage:confluence-configuration
read:confluence-groups
```

{% hint style="success" %}
**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>
{% endhint %}

{% hint style="danger" %}
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.
{% endhint %}

{% hint style="info" %}

#### Default Recommended Scopes

The following scopes are **enabled by default** and recommended to ensure full and stable functionality of the Confluence integration.

```
offline_access
write:confluence-content
read:confluence-space.summary
write:confluence-space
write:confluence-file
read:confluence-props
read:confluence-content.all
read:confluence-content.summary
search:confluence
read:confluence-user
readonly:content.attachment:confluence
write:page:confluence
manage:confluence-content
read:confluence-content
read:space:confluence
```

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
  {% endhint %}

#### 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

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2FrIN1lDxjLkICyoZBauMc%2Fimage.png?alt=media&#x26;token=9cab9afe-05f9-4dc2-9a23-02b1ee29bed8" alt=""><figcaption></figcaption></figure>

Let's explore the available actions within the Automate-Jira Confluence integration and how to use them:

### Create Comment

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2F17v7r3rBi2Z5y7HtjbYd%2Fimage.png?alt=media&#x26;token=dc44105f-b3b4-4e62-b54f-70a58326b56f" alt=""><figcaption></figcaption></figure>

**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: <mark style="color:green;">The key of the space where the comment will be created.</mark>
* Content ID: <mark style="color:green;">The ID of the content to comment on.</mark>
* Comment Type: <mark style="color:green;">Specify the type of comment (e.g., inline, block).</mark>
* Text: <mark style="color:green;">The text of the comment.</mark>

**Output:**

* The result after creating the comment.

***

### Create Content

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2FNhPgoF1gn5S6ZzaAkst7%2Fimage.png?alt=media&#x26;token=48abc5bb-3aee-44f7-bd51-656bf3fb2df8" alt=""><figcaption></figcaption></figure>

**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: <mark style="color:green;">The type of content to create (e.g., page, blog post).</mark>
* Space Key: <mark style="color:green;">The key of the space where the content will be created.</mark>
* Title: <mark style="color:green;">The title of the new content.</mark>
* Body: <mark style="color:green;">The main body of the content (supports rich text formatting).</mark>

**Output:**

* The result after creating the content.

***

### Get Comments By Content ID

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2Fv66pXX4nfK2U8ZgJ3uKe%2Fimage.png?alt=media&#x26;token=c8c89478-da6c-4623-926d-5ece6fed2a0a" alt=""><figcaption></figcaption></figure>

**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: <mark style="color:green;">The ID of the content to retrieve comments for.</mark>
* Limit: <mark style="color:green;">The maximum number of comments to retrieve (optional).</mark>

**Output:**

* The retrieved comments, including their IDs, text, and author information.

***

### Get Content

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2FM9aBCLs5auv2h7GzKmN7%2Fimage.png?alt=media&#x26;token=442d0367-4c45-40e3-9f23-911e4ab8ed53" alt=""><figcaption></figcaption></figure>

**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: <mark style="color:green;">The type of content to retrieve (e.g., page, blog post).</mark>
* Space Key: <mark style="color:green;">The key of the space where the content is located.</mark>
* Limit: <mark style="color:green;">The maximum number of content items to retrieve (optional).</mark>

**Output:**

* The retrieved content, including its ID, title, body, and author information.

***

### Get Content By ID

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2FL3BzhTSAQlqUjVN4JLKB%2Fimage.png?alt=media&#x26;token=77b07d88-4b6f-4fa6-a47a-555f775c5394" alt=""><figcaption></figcaption></figure>

**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: <mark style="color:green;">The ID of the content to retrieve.</mark>

**Output:**

* The retrieved content, including its ID, title, body, and author information.

***

### Search Content

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2F2L0yB5uFivHCAvgSSu93%2Fimage.png?alt=media&#x26;token=dd8ebbbb-469a-4fa3-8e9d-018c8e3bedf7" alt=""><figcaption></figcaption></figure>

**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: <mark style="color:green;">The type of content to search for (e.g., page, blog post).</mark>
* Title: <mark style="color:green;">The title of the content to search for.</mark>
* Limit: <mark style="color:green;">The maximum number of search results to return (optional).</mark>
* Include Archived Spaces: <mark style="color:green;">Whether to include content from archived spaces in the search.</mark>
* Exclude Current Spaces: <mark style="color:green;">Whether to exclude content from current spaces in the search.</mark>
* Excerpt: <mark style="color:green;">An excerpt of the content to include in the search results (optional).</mark>

**Output:**

* The search results, including IDs, titles, and excerpts of the matched content.

***

## Additional Tips

### [**Use Cases**](https://docs.autommate.com/userguide/use-cases)

### [FAQ](https://docs.autommate.com/userguide/faq)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.autommate.com/userguide/libraries/integration/jira-confluence.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.