> ## Documentation Index
> Fetch the complete documentation index at: https://hc.saas-manager.biz.nuro.jp/llms.txt
> Use this file to discover all available pages before exploring further.

# Confluence Integration

> Connect Confluence as a knowledge source so the AI agent can search and reference Confluence pages when answering inquiries

Connecting Confluence as a knowledge source lets the AI agent search and reference Confluence pages when answering employee inquiries.

## Connection types

Two connection types are available for Confluence.

| Type                     | Description                                                        | Best for                                                                 |
| ------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| **Confluence (OAuth)**   | Connect a Confluence Cloud workspace via Atlassian OAuth           | Getting started quickly with Confluence Cloud                            |
| **Confluence (API Key)** | Connect by entering your Confluence base URL, email, and API token | Confluence Server / Data Center, or fine-grained control with API tokens |

<Note>
  Both types allow the AI agent to search Confluence after connection.
</Note>

## Prerequisites

<Info>
  * **Admin** role in AI Helpdesk is required
  * **Confluence (OAuth)**: Confluence Cloud admin rights required
  * **Confluence (API Key)**: Requires the ability to generate an API token in Atlassian account settings ([Atlassian security settings](https://id.atlassian.com/manage-profile/security/api-tokens))
</Info>

## Connect via Confluence (OAuth)

Connect a Confluence Cloud workspace using Atlassian OAuth.

<Steps>
  <Step title="Open Knowledge Integration settings">
    Select **Settings** from the left navigation, then open the **Integration** tab.
    Click **Add Integration** in the **Knowledge Integration** section and select **Confluence (OAuth)**.
  </Step>

  <Step title="Authenticate with Atlassian">
    You are redirected to the Atlassian OAuth page.
    Log in with your Atlassian account and grant access to AI Helpdesk.
  </Step>

  <Step title="Confirm connection">
    Once authentication succeeds, a connected Confluence (OAuth) card appears in the **Knowledge Integration** section.
    Confirm the card status shows **Connected**.
  </Step>
</Steps>

### Narrow the crawl scope (optional)

By default, all spaces, pages, and blog posts are crawled. To restrict crawling to specific entities, configure the following.

1. Click the **Configure (gear icon)** on the connected card
2. Enter the URLs of the spaces, pages, or blog posts to crawl in the **Entity URLs** field, one URL per line (up to 100 URLs)
3. Select at least one content type to index under **Object Types to Crawl** (Space / Page / BlogPost / Attachment / Comment)
4. Click **Save**

## Connect via Confluence (API Key)

Connect by entering your Confluence base URL, email address, and API token.

### Required information

| Field                   | Description                                       | Example                                  |
| ----------------------- | ------------------------------------------------- | ---------------------------------------- |
| **Confluence Base URL** | URL of your Confluence instance                   | `https://yourcompany.atlassian.net/wiki` |
| **Email**               | Email of the account that generated the API token | `bot@example.com`                        |
| **API Token**           | Token generated in Atlassian account settings     | —                                        |

<Steps>
  <Step title="Open Knowledge Integration settings">
    Select **Settings** from the left navigation, then open the **Integration** tab.
    Click **Add Integration** in the **Knowledge Integration** section and select **Confluence (API Key)**.
  </Step>

  <Step title="Generate an API token">
    Open [Atlassian account security settings](https://id.atlassian.com/manage-profile/security/api-tokens) and click **Create API token**.
    Copy the generated token.

    <Note>
      API tokens can only be viewed immediately after creation. If you miss it, generate a new one.
    </Note>
  </Step>

  <Step title="Enter connection details">
    Fill in the **Confluence Base URL**, **Email**, and **API Token** in the connection form.

    Click **Save**. A connection test runs automatically.
  </Step>

  <Step title="Confirm connection">
    When the test succeeds, a connected card appears in the **Knowledge Integration** section.
    Confirm the status shows **Connected**.

    <Warning>
      If the status shows **Error**, verify the URL, email, and API token.
    </Warning>
  </Step>
</Steps>

### Narrow the crawl scope (optional)

After connecting, all spaces, pages, and blog posts are crawled by default. To restrict crawling to specific entities, configure the following.

1. Click the **Configure (gear icon)** on the connected card
2. Enter the URLs of the spaces, pages, or blog posts to crawl in the **Entity URLs** field, one URL per line (up to 100 URLs)
3. Select at least one content type to index under **Object Types to Crawl** (Space / Page / BlogPost / Attachment / Comment)
4. Click **Save**

## Using Confluence with the AI Agent

Once connected, the AI agent includes Confluence in knowledge searches automatically.

To explicitly reference Confluence in a Playbook step, use the `{{document_search}}` tool.

```markdown theme={null}
### Step 2: Search internal documents

Use {{document_search}} to find relevant procedures.
Include the Confluence IT space in the search.
```

## Disconnect Confluence

<Steps>
  <Step title="Open Knowledge Integration settings">
    Go to **Settings** > **Integration** tab and open the **Knowledge Integration** section.
  </Step>

  <Step title="Disconnect">
    Click the trash icon on the Confluence card you want to disconnect.
    Click **Delete** in the confirmation dialog.

    <Warning>
      After disconnecting, the AI agent will no longer search Confluence.
    </Warning>
  </Step>
</Steps>

## Troubleshooting

**Status remains "Error"**

* Confluence (OAuth): Click the **Reconnect** button to re-run the OAuth flow
* Confluence (API Key): The token may be expired or revoked. Generate a new token in Atlassian account settings and update the configuration

**Certain pages do not appear in search results**

If entity URLs are configured, only those spaces, pages, and blog posts are searched. Check the entity URL configuration and confirm the correct URLs are included.

## Related pages

* [Integration overview](/en/ai-helpdesk/integrations/index)
* [Add knowledge](/en/ai-helpdesk/knowledge/adding)
* [Register Playbooks](/en/ai-helpdesk/playbooks/creating)