Skip to main content
The Atlassian connector enables Omni to index and search content from your organization’s Confluence and JIRA instances.

​
Overview

​
What Gets Indexed

SourceContent
ConfluencePages, blog posts, comments, and attachments
JIRAIssues, comments, descriptions, and attachments

​
How It Works

  1. An API token with admin permissions accesses the Atlassian REST APIs
  2. The connector syncs content based on project and space permissions
  3. Permission inheritance ensures users only see content they have access to in Atlassian
The connector uses read-only access. Omni cannot modify any content in your Atlassian instance.

​
Prerequisites

Before setting up the Atlassian connector, ensure you have:
  • Atlassian Cloud account (Confluence and/or JIRA)
  • Admin access to your Atlassian organization
  • API token created from your Atlassian account

​
Setup

​
Step 1: Create an API Token

  1. Log in to your Atlassian account
  2. Go to Atlassian Account Settings
  3. Click Create API token
  4. Enter a label (e.g., Omni Integration)
  5. Click Create
  6. Copy the generated token immediately — you won’t be able to see it again
Store this API token securely. It provides access to your Atlassian data and should be treated like a password.

​
Step 2: Gather Your Atlassian Details

You’ll need the following information:
FieldDescriptionExample
Admin EmailThe email address of the Atlassian admin who created the API token[email protected]
API TokenThe token you created in Step 1ATATT3xFf...
Atlassian DomainYour Atlassian Cloud domainyour-company.atlassian.net
Your Atlassian domain is the URL you use to access Confluence or JIRA, without the https:// prefix.

​
Step 3: Connect to Omni

  1. Navigate to Settings → Integrations in Omni
  2. Find Atlassian and click Connect
  3. Enter your details:
    • Admin Email: The email of the admin who created the API token
    • API Token: The token you created in Step 1
    • Atlassian Domain: Your Atlassian Cloud domain (e.g., your-company.atlassian.net)
  4. Click Connect

​
Step 4: Configure Sources

After connecting, you need to configure which Atlassian products to index:
  1. Click Configure next to Confluence or JIRA
  2. Choose which spaces (Confluence) or projects (JIRA) to include or exclude
  3. Select specific users to include or exclude if needed
  4. Click Save Configuration
  5. Wait for the initial sync to complete
Your Atlassian connector is now configured. Initial indexing may take a while depending on the amount of content in your Confluence and JIRA instances.

​
Managing the Integration

​
Viewing Sync Status

Navigate to Settings → Integrations → Atlassian to view:
  • Last sync time
  • Number of indexed documents (pages, issues)
  • Any sync errors

​
Rotating API Tokens

It’s recommended to rotate API tokens periodically for security.
  1. Create a new API token in Atlassian Account Settings
  2. Update the token in Omni settings
  3. Revoke the old token in Atlassian

​
Removing the Integration

  1. Navigate to Settings → Integrations → Atlassian
  2. Click Disconnect
  3. Revoke the API token in Atlassian Account Settings

​
Troubleshooting

Common causes:
  • API token was copied incorrectly — create a new one and try again
  • Admin email doesn’t match the account that created the token
  • Token has been revoked or expired
Verify your credentials by testing the API directly:
curl -u "[email protected]:YOUR_API_TOKEN" \
  "https://your-company.atlassian.net/wiki/rest/api/space"
Ensure you’re using the correct Atlassian Cloud domain:
  • Use your-company.atlassian.net (without https://)
  • Check that you’re using Atlassian Cloud, not a self-hosted Data Center instance
If some content isn’t appearing:
  • Verify the space or project is included in your configuration
  • Check that the admin account has access to the content
  • Archived spaces and projects may need to be explicitly included
  • Wait for the sync cycle to complete (check sync status)
The API token inherits the permissions of the user who created it:
  • Ensure the admin has access to all spaces and projects you want to index
  • Consider using a dedicated service account with broad read access
Initial sync duration depends on:
  • Number of Confluence pages and JIRA issues
  • Amount of attachments
  • API rate limits
For large instances (10,000+ items), initial sync may take several hours. Monitor progress in the Omni admin panel.

​
Security Considerations

  • Read-only access: The API token only provides read access when used by Omni
  • Permission inheritance: Users only see content they can access in Atlassian
  • Token security: API tokens should be treated like passwords
  • Token rotation: Rotate tokens periodically (recommended every 90 days)
  • Audit logging: Monitor API token usage in Atlassian’s admin panel

​
What’s Next

Search Your Data

Learn how to search across Confluence and JIRA content

AI Assistant

Ask questions about your documentation and issues

Add More Connectors

Connect additional data sources