> For the complete documentation index, see [llms.txt](https://docs.ixhello.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ixhello.com/knowledge-bot/functional-documentation/functional-capabilities/data-sources/integrations/confluence-configuration.md).

# Confluence Configuration

Confluence integration required app registration in [Developer console](https://developer.atlassian.com/console/myapps/)

This is the Atlassian dashboard menu:

<figure><img src="/files/fvxJ0CVxm6AfIDk9aGom" alt=""><figcaption></figcaption></figure>

### Authorization <a href="#authorization" id="authorization"></a>

Navigate to **Authorization** and enable **OAuth 2.0 (3LO)**.

Configure the following:

* **Callback URL** – The URL where Atlassian redirects users after authorization.
  * Example: `https://kbot-preprod.concentrix.com/connectors/oauth/callback`

<figure><img src="/files/JHzLsu7lTGp76y7Gt3x1" alt=""><figcaption></figcaption></figure>

### Permissions <a href="#permissions" id="permissions"></a>

Navigate to **Permissions → Confluence API**.

#### Classic Scopes <a href="#classic-scopes" id="classic-scopes"></a>

Classic scopes provide broad access to Confluence resources and are the recommended option for most integrations because they are simpler to configure and maintain.

Required classic scopes:

<figure><img src="/files/kYKg6xIgeIuWPd1Karxy" alt=""><figcaption></figcaption></figure>

```
read:confluence-space.summary
read:confluence-props
read:confluence-content.all
read:confluence-content.summary
search:confluence
read:confluence-content.permission
read:confluence-user
read:confluence-groups
readonly:content.attachment:confluence
```

#### Granular Scopes <a href="#granular-scopes" id="granular-scopes"></a>

Granular scopes allow you to grant access to individual operations instead of broad capabilities. They follow the principle of least privilege but require selecting and maintaining a larger number of permissions.

Required Granular scopes:

<figure><img src="/files/XTaMIV4w7D4AuvuSzxa1" alt=""><figcaption></figcaption></figure>

| **Scope Name**                        | **Code**                         |
| ------------------------------------- | -------------------------------- |
| View pages                            | read:page:confluence             |
| View folders                          | read:folder:confluence           |
| View and download content attachments | read:attachment:confluence       |
| View content summaries                | read:content.metadata:confluence |
| View spaces                           | read:space:confluence            |

Callback:

US instance:\
`https://us.knowledge.ixhello.com/connectors/oauth/callback`

EU instance:

`https://eu.knowledge.ixhello.com/connectors/oauth/callback`

### **Distribution** <a href="#distribution" id="distribution"></a>

You need to select to be **Sharing** and also add the **vendor name** and **Privacy policy**

<figure><img src="/files/05MOBWYXRNePX1skCCuC" alt=""><figcaption></figcaption></figure>

### Credentials <a href="#credentials" id="credentials"></a>

After saving the configuration, copy the following values from the **Settings** page:

* Client ID
* Client Secret

These credentials are required by the application to complete the OAuth 2.0 authorization flow and exchange authorization codes for access tokens.

### Confluence Knowledge Bot Reporting and Analytics

The **Reporting** section provides insights into Knowledge Bot (K-Bot) usage, user interactions, feedback, token consumption, and operational costs. This information helps administrators monitor bot performance and evaluate the quality of generated responses.

{% hint style="info" %}
**Access Control:** Reporting data is available only to users with **Admin** or **Super Admin** roles. Access is governed through role-based permissions.
{% endhint %}

### Configure a Confluence Data Source

To connect a Confluence instance as a knowledge source:

1. Navigate to the **Data Source Configuration** page.
2. Enter the required **Client ID** and **Client Secret** credentials.
3. Save the configuration.

These credentials allow the system to securely connect to Confluence and retrieve content for ingestion.

<figure><img src="/files/0guo5laoJV5du3EXJgC0" alt="" width="558"><figcaption></figcaption></figure>

#### Viewing Ingested Knowledge Data

1. Save the configuration.
2. The system automatically retrieves and processes the content.
3. Once processing is complete, the ingested content is divided into searchable **chunks** and made available to the Knowledge Bot.

<figure><img src="/files/jHlDACPA6LdJwGTsoBju" alt=""><figcaption></figcaption></figure>

### Ingest Content from a Confluence Page

After configuring the Confluence data source:

1. Go to the **Upload** section.
2. Enter the **URL of the Confluence page** you want to ingest.
3. Save the configuration.

The system will begin processing the page and extracting its content.

<figure><img src="/files/y8aIIXP3cpPUBvzy7OQH" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/BydaeBXP1YqP4xubkOMi" alt="" width="563"><figcaption></figcaption></figure>

#### Processing Results

Once ingestion is complete, you can:

* View the ingested content chunks.
* Verify that the page content has been successfully processed.
* Confirm that the data is available for use by the Knowledge Bot.

<figure><img src="/files/3QlD7vTLnJUjFACTELKc" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/viSmqcSL7v5S2gVFpizC" alt=""><figcaption></figcaption></figure>

### Querying the Knowledge Bot

After the content has been ingested:

1. Open the **Chatbot** page.
2. Select the Knowledge Bot associated with the uploaded data.
3. Ask questions related to the ingested documentation.

#### Source References

Each response includes:

* The generated answer.
* A reference to the source document used to generate the response.

This helps users verify where the information originated.

<figure><img src="/files/wN7ezj8jOlrqumYl1Jh2" alt=""><figcaption></figcaption></figure>

### Providing Feedback

Users can provide feedback on chatbot responses directly from the chat interface.

Feedback helps evaluate response quality and improve the effectiveness of the knowledge base.'

<figure><img src="/files/0nBITfPg9aAs5rC5JyKU" alt=""><figcaption></figcaption></figure>

## Reporting

The **Reporting** section provides analytics and usage insights for Knowledge Bots.

### Available Metrics

Reporting includes:

* Total requests
* Positive and negative feedback
* Total token usage
* Model costs
* Request statistics
* Other usage-related metrics

<figure><img src="/files/hta9S9Qek0R0o7KMTzFQ" alt=""><figcaption></figcaption></figure>

Users can review detailed information for each interaction, including:

* User question
* Generated response
* Rephrased question
* Model usage information

![](/files/jP873X2YXEKYq01882gN)

![](/files/wMazUuUwPlVJzmQSfG1x)

### Question Rephrasing Details

For each query, the system may generate a rephrased version of the user's question to improve retrieval quality.

Reporting displays:

* Original question
* Rephrased question
* Embedding model used (for example, Text Embedding 3 Large)
* Associated processing details

<figure><img src="/files/To427gP7JKS16ErIfnHf" alt=""><figcaption></figcaption></figure>

***

## Chat Logs

The **Chat Logs** section provides a detailed history of conversations.

For each conversation, administrators can view:

* User questions
* Bot responses
* Response formatting
* Conversation details
* Associated metadata

This enables troubleshooting, auditing, and review of chatbot interactions.

<figure><img src="/files/tBXQqZFEn2Jnks7FOGMn" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/2cUkryy3HRS48DafLtev" alt=""><figcaption></figcaption></figure>

***

## Exporting Chat Logs

Chat logs can be exported for external analysis and record keeping.

#### Export Process

1. Open the **Chat Logs** section.
2. Select **Export**.
3. The export is processed asynchronously.
4. Once processing is complete, the file becomes available for download.

<figure><img src="/files/HRpofZn4LfrR0mrW0hRW" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/AJA5tdcV67Bbus7fQGqc" alt=""><figcaption></figcaption></figure>

#### Exported Data

The exported file may include:

* Feedback details
* Bot responses
* Original questions
* Rephrased questions
* Language information
* Timestamps
* Knowledge Bot name
* Chat Log ID
* Other conversation metadata

<figure><img src="/files/80xOgITtQNI6yblZXGK1" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/yT086yQQKsu1kiP5QLYY" alt=""><figcaption></figcaption></figure>

***

## Access Control

**Role-Based Access**

Access to reporting and analytics features is controlled through role-based permissions.

#### Users with Access

The following roles can access the **Reporting** and **Chat Log** sections:

| Role        | Reporting Access |
| ----------- | ---------------- |
| User        | No               |
| Admin       | Yes              |
| Super Admin | Yes              |

#### Note

Super Admins have access to all platform features by default. Since application-level Admins can also access Reporting and Chat Logs, this access behavior should be documented as part of the platform's role-based access model.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.ixhello.com/knowledge-bot/functional-documentation/functional-capabilities/data-sources/integrations/confluence-configuration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.