⚠️ Warning: This integration setup is for Atlassian Confluence Cloud only. If your set-up is not Cloud (Server or Data Center), please consult our Atlassian Application Tunnel Documentation.
1. How does SQAI Suite Leverage This Integration?
Connecting to Confluence allows SQAI to integrate your organization's knowledge base into the QA workflow:
Contextual Accuracy: SQAI reads your requirements, guides, and process documentation directly from your Confluence spaces to ensure generated test cases and scripts are aligned with the latest business logic.
Knowledge Grounding: Prevents SQAI from "hallucinating" or using generic information, ensuring all output is grounded in your organization's specific documentation.
Efficient Prompting: Provides the foundational knowledge necessary for the most effective use of all three Modes of Intelligence (Guide, Expert, and Coverage Mode).
2. Information Required from Your Confluence Account
To establish a secure, plug-and-play connection, we require five pieces of information:
Required Detail | Explanation | How to Find It |
API Key | A secure token generated in your Atlassian settings (either Classic or Scoped). | See Section 3. |
Username (Email) | The email address associated with the account used to generate the API key (can be a personal or service account). | Your Atlassian login email. |
Cloud Instance URL | The base URL of your Atlassian Cloud site. | Found in your browser: |
Space Home Page ID | The numerical ID of the specific Confluence Space you want SQAI to read from. (Requires a cURL command) | See Section 2.1 (Must be retrieved programmatically). |
Space Key | The short identifier for the space (e.g., | Found in your browser: |
2.1 Retrieving the Space Home Page ID (Advanced Step)
The Home Page ID cannot be found in the browser URL and must be retrieved using an API call, requiring Base64 encoding of your email and API key.
Encode Credentials: Combine your
username:apiKeyinto a single string (e.g.,[email protected]:123456789). Use a tool like https://www.base64encode.org/ to convert this string into a Base64 encoded value (e.g.,ZW1haWxAZW1haWwuY29tOjEyMzQ1Njc4OQ==).
Run cURL Command: Execute the following cURL command, replacing the placeholders with your encrypted credentials and URL:
curl --location 'https://<CLOUD_INSTANCE_URL>/wiki/api/v2/spaces' \ --header 'Authorization: Basic <base64-of-email:apiKey>'
Find the ID: The response will be a JSON object containing the
spaceIdyou need.Tip: You can also use Postman to perform this step, which automatically handles the Base64 encoding when you select Basic Auth.
3. Setting up the API Key
You can use either a Classic Token (legacy, full user scope) or a Scoped Token (recommended, least-privilege access).
For more info: Manage API tokens for your Atlassian account | Atlassian Support
3.1 Generating a Classic Token
This is the simplest method but grants broader access (full user permissions).
Navigate directly to your API token management page: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/.
Click Create API token and name it (e.g., "SQAI Integration").
Copy the generated token immediately.
3.2 Generating a Scoped Token (Recommended)
This method uses the newer Scoped Token framework to ensure the token only has the specific permissions SQAI needs to read content and space summaries.
Follow the steps in the Confluence UI to create a new Scoped Token.
Set the following minimal Read and Search scopes:
Required Scope | Description |
read:confluence-content.all | Allows reading all content across the instance. |
read:confluence-space.summary | Allows reading basic space metadata. |
read:content:confluence | Read access to content. |
read:content-details:confluence | Read access to content details. |
read:space-details:confluence | Read access to space details. |
read:space:confluence | Read access to space information. |
search:confluence | Allows SQAI to search content for context. |
3.3 Cloud ID Requirement (If using Scoped Tokens)
If you use a Scoped Token, you may also need to provide your Cloud ID for API calls. This is retrieved via another cURL command:
curl --location 'https://<CUSTOMERNAME>.atlassian.net/_edge/tenant_info' \ --header 'Authorization: Basic <base64-of-email:apiKey>'
4. Entering Details in SQAI Suite
Once you have secured your API Key and obtained the necessary IDs, you can complete the setup in the SQAI Suite platform.
Step 1: Navigate to Integrations Go to your SQAI Suite settings and select the Integrations page. Find and select the Atlassian Confluence configuration.
Step 2: Enter Details Insert the gathered information into the corresponding fields:
Username (Email)
API Key (Classic or Scoped Token)
Cloud Instance URL
Space Key
Space Home Page ID
Step 3: Save and Confirm Click "Save Configuration." If the set-up is successful, you will receive a success message and see a green indicator next to your Confluence integration.
5. Troubleshooting Confluence Integration
If SQAI reports an error or fails to connect, use this checklist to quickly identify and resolve the most common issues related to access and data retrieval.
Problem | Cause | Solution |
Connection Failed: "Unauthorized" or "Access Denied" | A. Missing/Incorrect Scopes: The API Key (especially Scoped Token) is missing one or more of the required Read scopes. | Verify Scopes: Check the API Key permissions against the list in Section 3.2. Ensure the key is active and not expired. |
"Cannot Find Space" Error | B. Incorrect Space Key: The Space Key entered is incorrect or the space is private. | Double-Check Key: Verify the Space Key exactly matches the one in your Confluence URL (e.g., |
Cannot Retrieve Home Page ID | C. cURL/Authentication Error: The Base64 encoding of the | Re-Encode Credentials: Carefully re-encode the |
SQAI Does Not Connect At All | D. IP Restriction/VPN: While Confluence Cloud is public, custom firewall rules or VPN may be interfering with the connection. | Check Network: Ensure there are no proxy settings or internal network security groups blocking external access to the Atlassian Cloud domain. In that case contact the SQAI team in case you need a fixed IP addres to whitelist. |
Token Expired | E. Token Expiration: Access Tokens are set to expire after a certain period. | Generate New Token: The original user must create a new API key/token with the required scopes and update the configuration in SQAI Suite. |