Confluence Agent

Overview

The Confluence Agent allows you to integrate your Atlassian Confluence workspace with Junet, enabling you to search through your organization's documentation, wiki pages, and knowledge base directly from the chat interface.

---

Prerequisites

Before you begin, make sure you have:

• Confluence Cloud or Server instance with access permissions
• Atlassian account with permission to create API tokens
• Your Atlassian Base URL (e.g., https://your-company.atlassian.net)
• Space Key of the Confluence space you want to search

---

Step 1: Generate an Atlassian API Token

1. Go to Atlassian Account Settings
2. Log in with your Atlassian account
3. Click Create API token
4. Enter a label for your token (e.g., "Junet Confluence Integration")
5. Click Create
6. Copy the token immediately - you won't be able to see it again

---

Step 2: Find Your Confluence Space Key

The Space Key is a unique identifier for each Confluence space:

1. Go to your Confluence workspace
2. Navigate to the space you want to integrate
3. Look at the URL - it contains the space key:

   https://your-company.atlassian.net/wiki/spaces/PROJ/overview
                                                      ^^^^
                                                   Space Key
   

4. The Space Key is usually 2-10 uppercase characters (e.g., PROJ, DEV, DOCS)

---

Step 3: Enable the Confluence Agent

1. Open Junet and navigate to the chat interface
2. Click on the Agent Settings icon (puzzle piece) in the top navigation
3. Find Confluence in the list of available agents
4. Toggle the switch to Enabled

---

Step 4: Add a Confluence Connection

1. In the Confluence Agent settings, click Add Connection
2. Fill in the connection details:

Connection Name

Enter a descriptive name for this connection (e.g., "Company Wiki" or "Engineering Docs")

Description (Optional)

Add a description to help users understand what this connection provides access to (e.g., "Main company documentation and internal wiki")

Atlassian Base URL

Enter your Confluence instance URL:

https://your-company.atlassian.net

Atlassian Username

Enter the email address associated with your Atlassian account:

user@company.com

Atlassian API Key

Paste the API token you generated in Step 1.

Space Key

Enter the Space Key from Step 2 (e.g., PROJ):

---

Step 5: Configure User Groups (Optional)

If you want to restrict access to specific user groups:

1. Click the User Groups dropdown
2. Select one or more groups that should have access to this Confluence space
3. Leave empty to allow all users

---

Step 6: Configuration Options

Set as Default

Enable this option if you want this connection to be used by default when multiple Confluence connections exist.

Enabled

Make sure this toggle is ON to activate the connection.

---

Step 7: Save and Test

1. Click Create Connection
2. The connection will be validated automatically
3. If successful, you'll see a confirmation message
4. The connection now appears in the list with status Enabled

---

Using the Confluence Agent

Once configured, you can ask questions about your documentation:

• "Find documentation about our deployment process"
• "Search for API guidelines in Confluence"
• "What's the onboarding process for new employees?"
• "Show me pages about the authentication system"
• "Find meeting notes from last month"
• "What are our coding standards?"

The agent will search your connected Confluence space and return relevant pages with links.

---

Managing Multiple Spaces

You can add multiple Confluence connections for different spaces:

1. Click Add Connection again
2. Configure each connection with the same Atlassian credentials but different Space Keys
3. Use Set as Default to choose which space is searched first
4. The agent will indicate which space was used for each query

Example Setup

• Connection 1: Engineering Docs (Space Key: ENG)
• Connection 2: Product Documentation (Space Key: PROD)
• Connection 3: Company Wiki (Space Key: WIKI)

---

Search Results Format

The agent returns:

• Page Title: Name of the Confluence page
• Excerpt: Relevant text snippet from the page
• Link: Direct URL to the page in Confluence
• Space: Which Confluence space the page is in
• Last Updated: When the page was last modified

---

Troubleshooting

Authentication Failed

Problem: "Unable to authenticate with Atlassian"

Solutions:

• Verify your email address is correct
• Regenerate your API token and update the connection
• Check that your account has access to the Confluence instance
• Ensure the Base URL is correct (no trailing slash or /wiki path)

Space Not Found

Problem: "Space key not found" or "Access denied"

Solutions:

• Verify the Space Key is correct (case-sensitive)
• Check that your account has permission to view the space
• Ensure the space exists and hasn't been archived
• Try accessing the space directly in Confluence first

No Results Found

Problem: Queries return no results

Solutions:

• Verify pages exist in the specified space
• Check your Confluence permissions - you can only see what you have access to
• Try a broader search query
• Ensure the connection is set to Enabled
• Check if the space has any published content

Connection Timeout

Problem: "Request timed out"

Solutions:

• Check your internet connection
• Verify the Atlassian Base URL is accessible
• Try again in a few minutes - the Atlassian API may be temporarily unavailable
• Check if your organization has firewall rules blocking the connection

Wrong Space Searched

Problem: Agent searches the wrong Confluence space

Solutions:

• Check which connection is set as Default
• Verify the Space Key in your connection settings
• Disable connections you're not currently using
• Specify the space name in your query if needed

---

Best Practices

Organize Connections by Purpose

Create separate connections for different types of documentation:

• Engineering: Technical documentation, architecture diagrams
• Product: Product specs, roadmaps, feature documentation
• Company: HR policies, onboarding, company wiki
• Support: Customer support articles, troubleshooting guides

Keep Space Keys Updated

• If a space is renamed or migrated, update the Space Key
• Regularly review which spaces are connected
• Archive old connections for deprecated spaces

Manage User Access

• Use User Groups to restrict sensitive documentation
• Create department-specific connections
• Regularly audit who has access to each space

Optimize Search Queries

• Use specific terms from your documentation
• Include page titles or section headings
• Reference specific projects or product names
• Try different phrasings if results aren't relevant

---

Security Best Practices

Rotate API Tokens Regularly

1. Generate a new API token every 90 days
2. Update all connections using the old token
3. Revoke the old token in Atlassian settings

Limit User Access

• Use User Groups to restrict sensitive Confluence spaces
• Create separate connections for different teams or departments
• Regularly audit who has access to each connection

Monitor Usage

• Check the Confluence Agent logs for unusual activity
• Review API token usage in Atlassian settings
• Disable unused connections

---

Permissions

The Confluence Agent respects your Confluence permissions:

• You can only search spaces you have access to
• Page visibility follows your Confluence space permissions
• Restricted pages are only shown if you have permission
• Draft pages are not searchable (only published content)

---

API Rate Limits

Atlassian enforces rate limits on API requests:

• Confluence Cloud: ~200 requests per minute per user
• Confluence Server: Depends on your configuration

If you hit rate limits, the agent will notify you. Wait a few minutes before trying again.

---

Data Privacy

• API tokens are stored encrypted in the Junet database
• No Confluence data is cached permanently
• Search results are only visible to the user who made the request
• Confluence data is fetched in real-time for each query
• Page content is not stored in Junet

---

Supported Content Types

The agent can search:

• ✅ Pages (published)
• ✅ Blog posts
• ✅ Comments (if enabled)
• ✅ Page attachments (filenames and metadata)
• ❌ Draft pages (not published)
• ❌ Archived spaces
• ❌ Attachment contents (PDF, Word, etc.)

---

Advanced Features

Search Multiple Spaces

Create connections for each space you want to search. The agent can search across all enabled connections.

Restrict by User Group

Limit access to sensitive documentation by assigning specific user groups to connections.

Default Space

Set a primary space as default for general queries. Users can still access other spaces if needed.

---

Updating a Connection

To modify an existing connection:

1. Click the Edit icon next to the connection
2. Update any fields (URL, username, API key, Space Key, etc.)
3. Click Save
4. The connection will be re-validated

---

Deleting a Connection

To remove a connection:

1. Click the Delete icon next to the connection
2. Confirm the deletion
3. The connection and its configuration are permanently removed

---

Limitations

• Each connection can only access one Confluence space
• Only published pages are searchable (drafts are excluded)
• Search is limited by Confluence API capabilities
• Large spaces may have slower search performance
• Attachment contents (PDF, Word) are not searchable
• API rate limits may restrict heavy usage

---

Common Use Cases

Onboarding

"Find onboarding documentation for new developers"

Technical Documentation

"Show me the API documentation for the payment service"

Policies and Procedures

"What's our vacation policy?"

Meeting Notes

"Find meeting notes from the Q4 planning session"

Troubleshooting

"How do I reset a user's password?"

Product Information

"What are the features of our enterprise plan?"

---

Support

If you encounter issues not covered in this guide:

• Contact your Junet administrator
• Check the Atlassian API documentation
• Review Confluence Agent logs for error details
• Verify your permissions in Confluence directly