Confluence
Connect Clearly AI to Confluence.
Getting started
To configure the Confluence integration, generate an API token in Atlassian that allows Clearly AI to read and write pages, comments, and attachments in your Confluence instance.
Clearly AI acts on behalf of the user who generates the credentials. For shared use, we recommend creating a dedicated Clearly AI bot service account and generating the token under that account.
Prerequisites
- A Clearly AI account with access to the Integrations page
- A Confluence Cloud instance
- (Recommended) A dedicated service account in Atlassian for Clearly AI
Ensure email visibility
The email on the account used for the token must be visible. Set visibility to Anyone under Personal Settings and Visibility at id.atlassian.com/manage-profile/profile-and-visibility.
Generate an API token
- Go to your Atlassian account security page at id.atlassian.com/manage-profile/security.
- Under API tokens, click Create and manage API tokens.
- Create a new API token with the scopes listed below.
- Set an appropriately long expiry (maximum 1 year).
- Copy the token.
Required scopes
| Scope | Purpose |
|---|---|
read:me | Identify the authenticated user |
read:confluence-content.all | Read all Confluence content |
read:confluence-space.summary | Read space summaries |
read:confluence-user | Read Confluence user profiles |
read:page:confluence | Read pages |
read:content:confluence | Read content |
read:attachment:confluence | Read attachments |
read:content-details:confluence | Read content details and metadata |
read:space:confluence | Read space information |
read:hierarchical-content:confluence | Read page hierarchies |
write:page:confluence | Create and update pages |
write:content:confluence | Create and update content |
write:comment:confluence | Add and edit comments |
write:attachment:confluence | Upload attachments |
write:confluence-content | Write Confluence content |
Configure Clearly AI
- In Clearly AI, go to Integrations and select Confluence.
- Paste your Confluence instance URL in Base URL (e.g.,
https://mycompany.atlassian.net/wiki). - Enter the email of the account that generated the token in User Email.
- Paste the API token in Personal Key.
- Click Save.
- Click Test to verify the connection. A success message confirms the integration is working.
Related
- Jira — Connect Clearly AI to Jira
- Integrations — Auth patterns and credential scope