Confluence Toolkit Integration Guide¶

Introduction¶

This guide is your definitive resource for integrating and utilizing the Confluence toolkit within ELITEA. It provides a comprehensive, step-by-step walkthrough, from generating a Confluence API token to configuring the toolkit in ELITEA and effectively using it within your Agents. By following this guide, you will unlock the power of automated knowledge management, streamlined collaboration workflows, and enhanced information access, all directly within the ELITEA platform. This integration empowers you to leverage AI-driven automation to optimize your Confluence-driven workflows using the combined strengths of ELITEA and Confluence.

Brief Overview of Confluence

Confluence is Atlassian's powerful collaboration and documentation platform that helps teams create, organize, and share knowledge effectively. It serves as a centralized hub for modern knowledge management, offering features for:

Centralized Knowledge Management: Confluence provides a structured platform for creating, storing, and organizing all types of organizational knowledge, including project documentation, meeting notes, processes, and best practices.
Collaborative Content Creation: Enables real-time collaborative editing of pages, allowing teams to work together simultaneously on documents, plans, and other content, fostering teamwork and co-creation.
Organized Spaces and Pages: Confluence uses a hierarchical structure of Spaces and Pages to organize information logically. Spaces can represent teams, projects, or departments, while Pages within spaces hold specific content, making navigation and information discovery efficient.
Rich Content Creation and Formatting: Confluence provides a powerful editor with various formatting options, templates, and macros, allowing users to create visually appealing and informative pages with diverse content types, including text, images, tables, and multimedia.
Advanced Search and Discovery: Confluence offers robust search functionality with filtering and labeling capabilities, enabling users to quickly find relevant information across all spaces and pages, improving knowledge retrieval and content discoverability.

Integrating Confluence with ELITEA brings these powerful knowledge management capabilities directly into your AI-driven workflows. Your ELITEA Agents can then intelligently interact with your Confluence spaces and pages to automate knowledge-related tasks, enhance documentation processes, and improve information accessibility through intelligent automation, making your knowledge management workflows smarter and more efficient.

Toolkit's Account Setup and Configuration in Confluence¶

Integration with ELITEA

The credentials you create in this section will be used when creating your Confluence credential in ELITEA (Step 1 of the integration process).

Account Setup¶

If you do not yet have a Confluence account, please follow these steps to create one:

Visit Atlassian Website: Open your web browser and navigate to the official Atlassian website.
Sign Up for Confluence: Click on the "Try Confluence free" or "Get it free" button to start the sign-up process.
Create an Atlassian Account: Follow the prompts to create an Atlassian account. You can sign up using your email address, Google account, or Apple account. For professional use, it's recommended to use your company email address.
Choose a Workspace Name: During the signup process, you will be asked to choose a workspace name for your Confluence site. Enter a suitable name for your workspace.
Set Up Your Workspace: Follow the remaining onboarding steps to set up your Confluence workspace, including defining its purpose and inviting team members if needed.
Explore Confluence Features: Once your workspace is set up, explore the onboarding tips and familiarize yourself with Confluence features, spaces, pages, and navigation.

Generate an API Token¶

For secure integration with ELITEA, it is essential to use a Confluence API token for authentication. This method is more secure than using your primary Confluence account password directly and allows you to control access permissions.

Follow these steps to generate an API token in Confluence:

Log in to Confluence: Access your Confluence workspace by navigating to your Confluence URL (e.g., your-workspace.atlassian.net/wiki) and logging in with your credentials.
Access Account Settings: Click on your profile avatar in the top right corner of the Confluence interface. From the dropdown menu, select "Manage account".
Navigate to Security Settings: In the Atlassian account settings page, navigate to the "Security" section in the left-hand sidebar.
Access API Tokens: Within the "Security" settings, locate the "API tokens" section and click on "Create and manage API tokens".
Create API Token: On the "API tokens" page, click the "Create API token" button.
Name Your Token: In the "Create API token" dialog, enter a descriptive Label for your token, such as "ELITEA Integration Token" or "ELITEA Agent Access." This label will help you identify the purpose of this token later. You can also set an optional expiration date if needed.
Create Token: Click the "Create" button to generate the API token.
Securely Copy and Store Your API Token: Immediately copy the generated API token that is displayed in the pop-up window. This is the only time you will see the full token value. Store it securely in a password manager or, preferably, ELITEA's built-in Secrets feature for enhanced security within ELITEA. You will need this API token to configure the Confluence toolkit in ELITEA.

System Integration with ELITEA¶

To integrate Confluence with ELITEA, you need to follow a three-step process: Create Credentials → Create Toolkit → Use in Agents. This workflow ensures secure authentication and proper configuration.

Step 1: Create Confluence Credentials¶

Before creating a toolkit, you must first create Confluence credentials in ELITEA:

Navigate to Credentials Menu: Open the sidebar and select Credentials.
Create New Credential: Click the + Create button.
Select Confluence: Choose Confluence as the credential type.
Configure Credential Details:
- Display Name: Enter a descriptive name (e.g., "Confluence - Knowledge Base")
- Base URL: Enter the base URL of your Confluence instance (e.g., https://yourcompany.atlassian.net/wiki for Confluence Cloud or https://kb.epam.com/ for Epam Confluence)
- Authentication Method: Choose your preferred authentication method:
  - Basic: Enter your username and API key
  - Bearer: Enter your token
Test Connection: Click Test Connection to verify that your credentials are valid and ELITEA can successfully connect to Confluence
Save Credential: Click Save to create the credential. After saving, your Confluence credential will be added to the credentials dashboard and will be ready to use in toolkit configurations. You can view, edit, or delete it from the Credentials menu at any time.

Security Recommendation

It's highly recommended to use Secrets for API keys and tokens instead of entering them directly. Create a secret first, then reference it in your credential configuration.

Step 2: Create Confluence Toolkit¶

Once your credentials are configured, create the Confluence toolkit:

Navigate to Toolkits Menu: Open the sidebar and select Toolkits.
Create New Toolkit: Click the + Create button.
Select Confluence: Choose Confluence from the list of available toolkit types.
Configure Basic Information:
- Toolkit Name: Enter a descriptive name for your toolkit (e.g., "Confluence - Documentation Hub" or "Confluence - Team Space")
- Description: (Optional) Add a brief description of the toolkit's purpose and what it will be used for (e.g., "Access and manage documentation in the DOCS space")
Configure Credentials:
- In the Configuration section, select your previously created Confluence credential from the Credentials dropdown
Configure Advanced Options:
- PgVector Configuration: Select a PgVector connection for vector database integration
- Embedding Model: Select an embedding model for text processing and semantic search capabilities
Configure Confluence Settings:
- Space: Enter the Space key for the Confluence space you want to access (e.g., DOCS, TEAM)
- Hosting Option: Select the appropriate hosting option:
  - Cloud: For Confluence Cloud (e.g., atlassian.net)
  - Server: For self-hosted Confluence Server or Data Center instances (e.g., https://kb.epam.com/)
- Advanced Settings:
  - Limit: Pages limit per request, set the maximum number of pages to retrieve per request (default: 5)
  - Labels: Specify labels to filter content retrieval (optional, comma-separated list e.g., meeting-notes, documentation)
  - Max pages: Define the maximum number of pages to retrieve in total (default: 10)
  - Number of retries: Specify how many times the tool should retry after a failure (default: 2)
  - Min retry, sec: Set the minimum number of seconds to wait before retrying (default: 10)
  - Max retry, sec: Set the maximum number of seconds to wait before retrying (default: 60)
  - Custom Headers: (Optional) Add custom HTTP headers for API requests in JSON format (e.g., {"X-Custom-Header": "value"}) to support additional authentication or routing requirements
Enable Desired Tools: In the "Tools" section, select the checkboxes next to the specific Confluence tools you want to enable. Enable only the tools your agents will actually use to follow the principle of least privilege
- Make Tools Available by MCP - (optional checkbox) Enable this option to make the selected tools accessible through the external MCP clients to use the toolkit's capabilities
Save Toolkit: Click Save to create the toolkit

Available Tools:¶

The Confluence toolkit provides the following tools for interacting with Confluence spaces and pages, organized by functional categories:

Tool Category	Tool Name	Description	Primary Use Case
Search & Discovery
	Site search	Performs a search across the entire Confluence site	Find content across all spaces and pages based on keywords
	Search by title	Searches for pages based on their title	Locate specific pages by title within the workspace
	Search pages	Searches for pages within a specified space based on keywords	Find relevant pages within a specific space or project
	Get page id by title	Retrieves the page ID using the page title	Get page ID when you only know the page title
Content Access
	Read page by id	Retrieves the content of a page using its unique ID	Access specific page content for analysis or processing
	Get pages with label	Retrieves pages within a space that have a specific label	Access related content organized by labels
	List pages with label	Lists titles of pages within a space that have a specific label	Get overview of pages categorized by labels
	Get page tree	Retrieves the hierarchical structure of pages within a space	Understand content organization and page relationships
	Get page attachments	Retrieves attachments from a specific page	Access files and documents attached to pages
	Get page with image descriptions	Retrieves page content with image descriptions	Access pages with detailed image information
Content Management
	Create page	Creates a new page within a specified space	Generate new documentation, meeting notes, or project pages
	Create pages	Creates multiple pages within a space in bulk	Efficiently create large sets of related documentation
	Update page by id	Updates content of a page using its unique ID	Modify specific page content programmatically
	Update page by title	Updates content of a page using its title	Update pages when you know the title but not the ID
	Update pages	Updates content of multiple pages in bulk	Efficiently modify large sets of related pages
	Delete page	Deletes a specific page identified by its ID	Remove outdated or obsolete content
Organization & Metadata
	Update labels	Adds or removes labels from a specific page	Categorize and organize content for better discoverability
Indexing & Search
	Index data	Creates searchable indexes of Confluence content	Enable advanced search and discovery across pages
	List collections	Lists available indexed collections	View and manage indexed data collections
	Remove index	Removes previously created search indexes	Clean up and manage indexed content
	Search index	Performs searches across indexed content	Find specific content across indexed pages
	Stepback search index	Performs advanced contextual searches with broader scope	Execute sophisticated searches with expanded context
	Stepback summary index	Creates comprehensive summaries of indexed content	Generate intelligent summaries of page information
Advanced Operations
	Execute generic confluence	Sends custom HTTP requests to Confluence API	Access any Confluence API endpoint not covered by specific tools

Vector Search Tools

The tools Index data, List collections, Remove index, Search index, Stepback search index, and Stepback summary index require PgVector configuration and an embedding model. These enable advanced semantic search capabilities across your Confluence spaces and pages.

Testing Toolkit Tools¶

After configuring your Confluence toolkit, you can test individual tools directly from the Toolkit detailed page using the Test Settings panel. This allows you to verify that your credentials are working correctly and validate tool functionality before adding the toolkit to your workflows.

General Testing Steps:

Select LLM Model: Choose a Large Language Model from the model dropdown in the Test Settings panel
Configure Model Settings: Adjust model parameters like Creativity, Max Completion Tokens, and other settings as needed
Select a Tool: Choose the specific Confluence tool you want to test from the available tools
Provide Input: Enter any required parameters or test queries for the selected tool
Run the Test: Execute the tool and wait for the response
Review the Response: Analyze the output to verify the tool is working correctly and returning expected results

Key benefits of testing toolkit tools:

Verify that Confluence credentials and connection are configured correctly
Test tool parameters and see actual responses from your Confluence instance
Debug tool behavior and understand output formats
Optimize tool settings before integrating with agents or pipelines

For detailed instructions on how to use the Test Settings panel, see How to Test Toolkit Tools.

Step 3: Add Confluence Toolkit to Your Workflows¶

Now you can add the configured Confluence toolkit to your agents, pipelines, or use it directly in chat:

In Agents:¶

Navigate to Agents: Open the sidebar and select Agents.
Create or Edit Agent: Either create a new agent or select an existing agent to edit.
Add Confluence Toolkit:
- In the "TOOLKITS" section of the agent configuration, click the "+Toolkit" icon
- Select your configured Confluence toolkit from the dropdown list
- The toolkit will be added to your agent with the previously configured tools enabled

Your agent can now interact with Confluence using the configured toolkit and space.

In Pipelines:¶

Navigate to Pipelines: Open the sidebar and select Pipelines.
Create or Edit Pipeline: Either create a new pipeline or select an existing pipeline to edit.
Add Confluence Toolkit:
- In the "TOOLKITS" section of the pipeline configuration, click the "+Toolkit" icon
- Select your configured Confluence toolkit from the dropdown list
- The toolkit will be added to your pipeline with the previously configured tools enabled

In Chat:¶

Navigate to Chat: Open the sidebar and select Chat.
Start New Conversation: Click +Create or open an existing conversation.
Add Toolkit to Conversation:
- In the chat Participants section, look for the Toolkits element
- Click the "Add Tools" Icon to open the tools selection dropdown
- Select your configured Confluence toolkit from the dropdown list
- The toolkit will be added to your conversation with all previously configured tools enabled
Use Toolkit in Chat: You can now directly interact with your Confluence spaces and pages by asking questions or requesting actions that will trigger the Confluence toolkit tools.

Example Chat Usage:

"Show me the project documentation from the DOCS space."
"Create a new meeting notes page for today's standup."
"Search for pages about the authentication feature."
"Update the project overview page with latest milestones."

Instructions and Prompts for Using the Confluence Toolkit¶

To effectively instruct your ELITEA Agent to use the Confluence toolkit, you need to provide clear and precise instructions within the Agent's "Instructions" field. These instructions are crucial for guiding the Agent on when and how to utilize the available Confluence tools to achieve your desired automation goals.

Instruction Creation for OpenAI Agents¶

When crafting instructions for the Confluence toolkit, especially for OpenAI-based Agents, clarity and precision are paramount. Break down complex tasks into a sequence of simple, actionable steps. Explicitly define all parameters required for each tool and guide the Agent on how to obtain or determine the values for these parameters. OpenAI Agents respond best to instructions that are:

Direct and Action-Oriented: Employ strong action verbs and clear commands to initiate actions. For example, "Use the 'read_page_by_id' tool...", "Create a page named...", "Search for pages containing...".
Parameter-Centric: Clearly enumerate each parameter required by the tool. For each parameter, specify:
- Its name (exactly as expected by the tool)
- The format or type of value expected
- How the Agent should obtain the value – whether from user input, derived from previous steps in the conversation, retrieved from an external source, or a predefined static value
Contextually Rich: Provide sufficient context so the Agent understands the overarching objective and the specific scenario in which each Confluence tool should be applied within the broader workflow. Explain the desired outcome or goal for each tool invocation.
Step-by-Step Structure: Organize instructions into a numbered or bulleted list of steps for complex workflows. This helps the Agent follow a logical sequence of actions.
Add Conversation Starters: Include example conversation starters that users can use to trigger this functionality. For example, "Conversation Starters: 'Show me the project documentation', 'What's in the meeting notes?', 'Search for information about the new feature'"

When instructing your Agent to use a Confluence toolkit tool, adhere to this structured pattern:

State the Goal: Begin by clearly stating the objective you want to achieve with this step. For example, "Goal: To retrieve the content of the 'Project Overview' page."
Specify the Tool: Clearly indicate the specific Confluence tool to be used for this step. For example, "Tool: Use the 'read_page_by_id' tool."
Define Parameters: Provide a detailed list of all parameters required by the selected tool. For each parameter:
Parameter Name: <Parameter Name as defined in tool documentation>
Value or Source: <Specify the value or how to obtain the value. Examples: "user input", "from previous step", "hardcoded value 'DOCS'", "value of variable X">
Describe Expected Outcome (Optional but Recommended): Briefly describe the expected result or outcome after the tool is successfully executed. For example, "Outcome: The Agent will provide the content of the 'Project Overview' page."
Add Conversation Starters: Include example conversation starters that users can use to trigger this functionality. For example, "Conversation Starters: 'Show me the project overview', 'What's in the project documentation?', 'Display the project summary'"

Example Agent Instructions

Basic Pattern - Reading a Confluence Page: Content Management Pattern - Creating and Updating Pages:

You are a Confluence content manager. Help users create and maintain documentation efficiently.

## Content Creation Workflow

### Creating New Pages
- **Tool**: create_page
- **Parameters**:
    - space_key: Target Confluence space (ask if not specified)
    - title: Page title (generate from context or ask user)
    - body: Page content in Confluence storage format
    - parent_id: (Optional) Parent page ID for hierarchy
- **Process**:
    1. Confirm space and title with user
    2. Generate appropriate content structure (use templates when relevant)
    3. Create page with proper formatting
    4. Return page URL and ID for future reference
    5. Suggest adding relevant labels for organization
- **Best Practices**:
    - Use clear, descriptive titles
    - Include standard sections (Overview, Details, Resources)
    - Add creation date and owner information
    - Link to related pages when applicable

### Updating Existing Pages
- **Tools**: update_page_by_id or update_page_by_title
- **Parameters**:
    - page_id or title: Target page identifier
    - body: New content (preserve existing content if partial update)
    - version: Current version number + 1
- **Process**:
    1. Read current page content first
    2. Merge or replace content as needed
    3. Preserve important sections unless explicitly asked to remove
    4. Update version number appropriately
    5. Confirm successful update with user
- **Safety Guidelines**:
    - Always read page before updating to avoid data loss
    - Confirm major changes with user before executing
    - Preserve page structure and formatting

### Organizing with Labels
- **Tool**: update_labels
- **Parameters**:
    - page_id: Target page
    - labels: Array of label names to add
- **Process**:
    1. Suggest relevant labels based on content
    2. Add labels to categorize and improve discoverability
    3. Confirm labels were applied successfully
- **Label Strategy**:
    - Use consistent naming conventions (lowercase, hyphenated)
    - Apply categories: project, team, status, type
    - Examples: "project-alpha", "meeting-notes", "archived", "documentation"

## Conversation Starters
- "Create a new meeting notes page for today's standup"
- "Update the project overview with latest milestones"
- "Add labels to page 123456"
- "Create a documentation page about [topic]"

Chat Usage Examples by Tool Category¶

The following examples demonstrate how to interact with the Confluence toolkit in ELITEA Chat, organized by functional categories. Each example shows the user request and the expected agent behavior.

Search & Discovery - Site Search

Chat Example:

User: "Search for any documentation about the authentication system in our Confluence."

Agent Response: [Agent uses site_search tool]

🔍 **Search Results for "authentication system"**:

**📄 Found 4 relevant pages**:

1. **"User Authentication Guide"** (DOCS space)
   - **Summary**: Comprehensive guide covering login processes and security protocols
   - **Last Updated**: 3 days ago
   - **URL**: https://yourcompany.atlassian.net/wiki/spaces/DOCS/pages/123456

2. **"API Authentication Documentation"** (DEV space)
   - **Summary**: Technical documentation for API authentication methods
   - **Last Updated**: 1 week ago
   - **URL**: https://yourcompany.atlassian.net/wiki/spaces/DEV/pages/789012

Would you like me to read the content of any specific page for more details?

Content Access - Read Page by ID

Chat Example:

User: "Can you show me the content of page 123456 from our Confluence?"

Agent Response: [Agent uses read_page_by_id tool]

📄 **Page Content - "Project Alpha Overview"**:

# Project Alpha Overview

## Project Objectives
- Develop a new customer portal with enhanced user experience
- Implement real-time analytics dashboard
- Integrate with existing CRM systems

## Current Status
✅ **Phase 1**: Requirements gathering (Complete)
🔄 **Phase 2**: Design and prototyping (In Progress)
⏳ **Phase 3**: Development (Planned for Q2)

## Team Members
- **Project Manager**: Sarah Johnson
- **Lead Developer**: Mike Chen
- **UX Designer**: Emily Rodriguez


The page was last updated 2 days ago by Sarah Johnson.

Content Management - Create Page

Chat Example:

User: "Create a new meeting notes page for today's project standup in the TEAM space."

Agent Response: [Agent uses create_page tool]

✅ **Page Created Successfully!**

**📄 New Page Details**:
- **Title**: "Project Standup - September 10, 2025"
- **Space**: TEAM
- **Page ID**: 987654
- **URL**: https://yourcompany.atlassian.net/wiki/spaces/TEAM/pages/987654

**📝 Initial Content Added**:
```markdown
# Project Standup - September 10, 2025

## Attendees
- [ ] Add attendee names

## Agenda
1. Sprint progress review
2. Blockers and challenges
3. Next sprint planning
4. Action items

## Discussion Notes
(Add notes here during the meeting)


The page is ready for your team to add meeting notes and action items!

Organization & Metadata - Update Labels

Chat Example:

User: "Add the labels 'archived' and 'project-alpha' to page 123456."

Agent Response: [Agent uses update_labels tool]

🏷️ **Labels Updated Successfully!**

**Page 123456** now has the following labels:
- ✅ **archived** (newly added)
- ✅ **project-alpha** (newly added)
- 📋 **documentation** (existing)
- 📋 **meeting-notes** (existing)

Indexing & Search - Index Data

Chat Example:

User: "Create a searchable index of all documentation in our DOCS space so we can find information more easily. Set collection suffix 'doc' "

Agent Response: [Agent uses index_data tool]

🔍 **Data Indexing Complete!**

**📊 Indexing Summary**:
- **Space Indexed**: DOCS
- **Pages Processed**: 45 pages
- **Content Types**: Documentation, guides, procedures, meeting notes
- **Index Status**: Successfully created
- **Search Capabilities**: Full-text search, semantic search, content relationships


Your DOCS space content is now fully indexed and searchable! You can use the search tools to find specific information quickly across all documentation.

Advanced Operations - Generic Request

Chat Example:

User: "Can you get the list of all spaces in our Confluence instance?"

Agent Response: [Agent uses generic_request tool]

🏢 **Confluence Spaces Overview**:

**📊 Total Spaces**: 8

**Active Spaces**:
1. **DOCS** - "Documentation Hub"
   - **Type**: Global space
   - **Pages**: 45 pages
   - **Last Activity**: Today

2. **TEAM** - "Team Collaboration"
   - **Type**: Team space  
   - **Pages**: 23 pages
   - **Last Activity**: 2 hours ago

3. **DEV** - "Development Resources"
   - **Type**: Project space
   - **Pages**: 67 pages
   - **Last Activity**: Yesterday

**📈 Activity Summary**: Your Confluence instance shows healthy usage with regular content updates across all active spaces.

Troubleshooting¶

Credential Not Appearing in Toolkit Configuration

Problem: When creating a toolkit, your Confluence credential doesn't appear in the credentials dropdown.

Troubleshooting Steps:

Check Credential Scope: Ensure you're working in the same workspace/project where the credential was created. Private credentials are only visible in your Private workspace, while project credentials are visible within the specific team project.
Verify Credential Creation: Go to the Credentials menu and confirm that your Confluence credential was successfully saved.
Credential Type Match: Ensure you selected "Confluence" as the credential type when creating the credential.

Connection Errors

Problem: ELITEA Agent fails to establish a connection with Confluence, resulting in errors during toolkit execution.

Troubleshooting Steps:

Verify Confluence URL: Ensure that the Base URL field in the credential configuration is correctly set to your Confluence instance URL (e.g., https://yourcompany.atlassian.net/wiki for Cloud or https://kb.epam.com/ for Server). Avoid modifying this URL format unless necessary.
Check API Token: Double-check that the API Token you have provided is accurate, has not expired, and is valid for your Confluence account and the target space. Carefully re-enter or copy-paste the token to rule out typos.
Verify Authentication Method: Review the authentication method selected in your credential configuration. Ensure it matches the type of credentials you've provided (Basic for username+API key, Bearer for token).
Network Connectivity: Confirm that both your ELITEA environment and the Confluence service are connected to the internet and that there are no network connectivity issues, firewalls, or proxies blocking the integration.

Authorization Errors (Permission Denied/Unauthorized)

Problem: Agent execution fails with "Permission Denied" or "Unauthorized" errors when attempting to access or modify Confluence resources, even with a seemingly valid token.

Troubleshooting Steps:

Re-verify API Token Validity: Ensure that the API token is valid and has not been revoked in your Atlassian account settings. Generate a new token if necessary.
Space Access Permissions: Confirm that the Confluence account associated with the API token has the necessary access permissions to the specified space. Verify that the account can access, view, and modify content in the space you're targeting.
Hosting Option Verification: Double-check that you have selected the correct Hosting option (Cloud or Server) in the toolkit configuration. Using the wrong hosting option can lead to authentication and connection errors.
Space Key Accuracy: Ensure you're using the correct Space key (not the space name) in your toolkit configuration. Space keys are typically short codes like "DOCS" or "TEAM".

Incorrect Space or Page Names

Problem: Agent tools fail to operate on the intended space or page, often resulting in "Space not found" or "Page not found" errors.

Troubleshooting Steps:

Double-Check Space Key: Carefully verify that you have entered the correct Confluence Space key in the toolkit configuration. Pay close attention to capitalization and exact spelling. Space keys are typically short codes like "DOCS", "TEAM", or "DEV".
Verify Page Titles and IDs: Ensure that you are using the correct page titles or page IDs when referencing Confluence pages. Page titles are case-sensitive and must match exactly. When using page IDs, ensure you are using the correct numerical ID for the intended page.
Page Existence: Confirm that the specified page actually exists in your Confluence space. It's possible the page name is correct but the page was deleted or moved.

Toolkit Configuration Issues

Problem: The toolkit fails to load or shows configuration errors after creation.

Troubleshooting Steps:

Verify Space Key Format: Ensure the space key follows the correct format: a short alphanumeric code (e.g., "DOCS", "TEAM"). Do not use the full space name or special characters.
Check Hosting Option: Verify that the hosting option matches your Confluence instance type (Cloud for *.atlassian.net, Server for self-hosted instances).
Credential Selection: Ensure you have selected the correct credential from the dropdown in the toolkit configuration.

Support Contact¶

If you encounter issues not covered in this guide or need additional assistance with Confluence integration, please refer to Contact Support for detailed information on how to reach the ELITEA Support Team.

FAQ¶

Can I use my regular Confluence password for the ELITEA integration?

While ELITEA supports password authentication, using a Confluence API token is strongly recommended for security. API tokens provide a significantly more secure and controlled method for granting access to external applications like ELITEA, without exposing your primary account credentials. You can configure this in the credential's authentication method selection.

What permissions are absolutely necessary for the Confluence API token to work with ELITEA?

Confluence API tokens have a fixed scope and provide access to the Confluence REST API. The specific permissions depend on what your ELITEA Agent will be doing:

For basic read-only access (e.g., using read_page_by_id, site_search), standard API access is sufficient.
For modifications (e.g., create_page, update_page_by_id), ensure your Confluence account has write permissions to the target spaces.

Always adhere to the principle of least privilege and grant only the permissions that are strictly necessary for your Agent's intended functionalities.

What is the correct format for specifying the Confluence Space key in the ELITEA toolkit configuration?

The Confluence Space key must be entered as the short alphanumeric code assigned to the space (e.g., "DOCS", "TEAM", "DEV"). Do not use the full space name or special characters. You can find the space key in your Confluence space settings or in the URL when viewing the space.

How do I switch from the old Agent-based configuration to the new Credentials + Toolkit workflow?

The new workflow is:

Create a Confluence credential with your authentication details
Create a Confluence toolkit that uses this credential
Add the toolkit to your agents, pipelines, or chat

This provides better security, reusability, and organization compared to configuring authentication directly in agents.

Can I use the same Confluence credential across multiple toolkits and agents?

Yes! This is one of the key benefits of the new workflow. Once you create a Confluence credential, you can reuse it across multiple Confluence toolkits, and each toolkit can be used by multiple agents, pipelines, and chat sessions. This promotes better credential management and reduces duplication.

Why am I consistently encountering 'Permission Denied' errors, even though I believe I have configured everything correctly?

If you are still facing "Permission Denied" errors despite careful configuration, systematically re-examine the following:

API Token Validity: Double-check that the API token is still valid and has not been revoked in your Atlassian account settings.
Space Access Verification: Explicitly verify that the Confluence account associated with the API token has the necessary access rights to the specific target space within Confluence itself. Confirm space membership, permissions, and assigned roles within the Confluence space settings.
Hosting Option Match: Double-check that you have selected the correct "Hosting option" (Cloud or Server) in the toolkit configuration, especially for self-hosted or enterprise Confluence instances.
Credential Configuration: Carefully review the credential configuration in ELITEA, especially the authentication method selection and token/password fields for any hidden typographical errors or accidental whitespace.

If, after meticulously checking all of these points, you still encounter "Permission Denied" errors, please reach out to ELITEA Support with detailed information for further assistance.

Why do I get 'Permission Denied' when using EPAM Confluence (https://kb.epam.com), even though my token worked before?

This is a known EPAM Confluence behavior and is not an ELITEA bug.

Root cause (confirmed by EPAM Support): floating license management

EPAM Confluence licenses are limited and shared across employees.
If your account is inactive for a period (often ~30 minutes), your license can be automatically reallocated to another active user.
How quickly this happens can depend on how many other users become active after your last session.
When this happens, your API token can effectively stop working and the toolkit can start returning Permission Denied/Unauthorized errors.
Logging in via browser reclaims an active license, after which the toolkit typically works again.

What you can do

Before running agents/pipelines that use Confluence toolkit, open a browser and log in to https://kb.epam.com/.
For stable automation, request a dedicated service account and coordinate with support to assign a permanent Confluence license to that account.

Service account request form: Managing service accounts

What are some best practices for using the Confluence toolkit effectively?

Test Integration Thoroughly:

After setting up the Confluence toolkit and incorporating it into your Agents, thoroughly test each tool you intend to use to ensure seamless connectivity, correct authentication, and accurate execution of Confluence actions.

Monitor Agent Performance:

Regularly monitor the performance of Agents utilizing Confluence toolkits. Track metrics such as task completion success rate, execution time, and error rates to identify any potential issues or areas for optimization.

Follow Security Best Practices:

Use API Tokens instead of your main account password for integrations
Grant only the minimum necessary permissions (principle of least privilege)
Securely Store Credentials using ELITEA's Secrets Management feature

Provide Clear Instructions:

Craft clear and unambiguous instructions within your ELITEA Agents to guide them in using the Confluence toolkit effectively. Use the prompt examples provided in this guide as a starting point.

Start Simple:

Begin by implementing Confluence integration for simpler automation tasks, such as retrieving page content or searching spaces, and gradually progress to more complex workflows as you gain experience.

Leverage Vector Search:

Configure PgVector and embedding models to enable advanced semantic search capabilities across your Confluence spaces, making information discovery more intelligent and efficient.

What are common use cases for Confluence toolkit integration?

The Confluence toolkit enables a wide range of automation and AI-powered knowledge management scenarios. Here are the most common and impactful use cases:

1. Intelligent Knowledge Discovery & Q&A - Create AI assistants that answer questions by searching and analyzing Confluence documentation - Enable natural language queries like "How do we handle customer refunds?" that automatically search spaces and retrieve relevant content - Build chatbots that provide instant access to onboarding guides, policies, and procedures

2. Automated Documentation Management - Auto-generate meeting notes pages from calendar events or meeting transcripts - Create standardized documentation pages based on templates (project plans, technical specs, retrospectives) - Bulk update pages with consistent formatting, headers, or updated information - Automatically archive or label outdated content based on age or relevance

3. Content Monitoring & Notifications - Set up agents to monitor specific pages or spaces for changes and send notifications - Track documentation updates and create summaries of changes - Alert teams when critical documentation is modified or created

4. Knowledge Base Indexing & Semantic Search - Index entire Confluence spaces to enable advanced semantic search capabilities - Create searchable knowledge bases that understand context and meaning, not just keywords - Build recommendation systems that suggest related documentation based on user queries

5. Cross-Platform Integration - Sync information between Confluence and other tools (Jira, Slack, GitHub, etc.) - Create Confluence pages from Jira tickets, GitHub issues, or other data sources - Update Confluence documentation automatically when external systems change

6. Compliance & Audit Support - Generate compliance reports by extracting and analyzing content from specific spaces - Create audit trails by tracking page creation, updates, and access patterns - Ensure documentation standards are met across all spaces

7. Onboarding & Training Automation - Build interactive onboarding assistants that guide new employees through documentation - Create personalized learning paths based on role or department - Generate training materials and quizzes from existing documentation

8. Content Analytics & Insights - Analyze documentation gaps by identifying topics with insufficient coverage - Generate summaries and insights from large documentation sets - Track content freshness and identify stale or outdated pages

These use cases can be implemented individually or combined to create sophisticated knowledge management workflows that significantly reduce manual effort and improve information accessibility across your organization.

Elitea Documentation and Guides

How to Use Chat Functionality - Complete guide to using ELITEA Chat with toolkits for interactive Confluence operations.
Create and Edit Agents from Canvas - Learn how to quickly create and edit agents directly from chat canvas for rapid prototyping and workflow automation.
Create and Edit Toolkits from Canvas - Discover how to create and configure Confluence toolkits directly from chat interface for streamlined workflow setup.
Create and Edit Pipelines from Canvas - Guide to building and modifying pipelines from chat canvas for automated Confluence workflows.
Indexing Overview - Comprehensive guide to understanding ELITEA's indexing capabilities and how to leverage them for enhanced search and discovery.
How to Index Confluence Data - Complete guide for indexing your Confluence spaces and pages to enable advanced search and AI-powered analysis capabilities.
Secrets Management - Best practices for securely storing API tokens and sensitive credentials.
AI Configuration - Essential settings and configurations for optimizing AI performance with integrations.

External Confluence Resources

Atlassian Account Settings - Navigate to your Atlassian account settings to manage API tokens and other security configurations.
Confluence API Tokens - Directly access the section in Atlassian settings to manage your API tokens for secure integrations.
Confluence REST API Documentation - Explore the official Confluence API documentation for detailed information on API endpoints, authentication, data structures, and developer guides.
Atlassian Community - Access the official Atlassian Community for comprehensive articles, FAQs, best practices, and troubleshooting guides on all aspects of Confluence usage.