Connect external apps to Katalon AI Assistant
This document explains how to connect external apps — Jira, Azure DevOps, GitHub, Google Drive, Figma, and Confluence — to Katalon AI Assistant in Katalon True Platform, so the assistant can use content from those apps as context for your testing workflows.
For example, after connecting the apps your team uses, you can ask the assistant to generate test cases from a Confluence requirement page or a Jira issue's acceptance criteria, summarize an Azure DevOps work item and its attachments, read a GitHub PR diff to find impacted tests, import a PRD stored in Google Drive, or export Figma screens for UI test coverage.
Most apps connect through OAuth (you sign in and grant access). Figma is the exception: it currently supports a personal access token (PAT) only — you paste a token instead of signing in through an authorization dialog. Jira and Confluence share the same Atlassian OAuth connection. See Connect an app below.
External app connectors are available only for Katalon True Platform.
- Access to Katalon AI Assistant in your Katalon True Platform project.
- An account on the external app with permission to view the content you want the assistant to use. The assistant accesses each app on your behalf and can only see what your account can see.
Supported apps
| App | Auth | What the assistant can do |
|---|---|---|
| Jira | OAuth (Atlassian) | Search issues by JQL, read issue detail, changelog, transitions, and accessible projects; generate test cases from an issue's acceptance criteria; create and edit issues, add comments, transition issues, and link related issues. |
| Azure DevOps | OAuth | Search and read work items, Test Plans, pipeline builds, pull requests, and attachments; generate test cases from work item acceptance criteria; create and update work items, open PRs, add PR comments, and create test runs. |
| GitHub | OAuth | Read repositories, pull requests and diffs, issues, code search, file contents, and branches; suggest tests impacted by a PR diff; create issues, PRs, branches, and comments, and update issues (within your OAuth scope). |
| Google Drive | OAuth | Search, list, and read files and folders; download and auto-extract text from Docs, Sheets, Slides, and PDFs (images inline); import PRDs, checklists, and requirement documents; read sharing permissions. |
| Figma | Personal access token (PAT) | Read the file tree and specific nodes, list project files, read designer comments, and export frames as PNG/SVG for UI test authoring; add and reply to comments. |
| Confluence | OAuth (Atlassian) | Search content via CQL, read pages, child pages, spaces, and attachments; generate test cases from requirement pages and specs; create and update pages, add comments, and add labels. |
The capabilities above are the full connector reference, but write actions are temporarily restricted while an in-chat approve/reject step is being finalized. Available now: the assistant can add comments, labels, issue links, and attachments, and create folders and files in Google Drive. Not available yet: creating or editing issues, work items, or pages; opening or updating pull requests; transitioning tickets; and moving, sharing, or changing sharing on files. These return to the assistant once the approval step ships. All reads listed above are available today.
Connect an app
-
In your project, open Katalon AI Assistant and start a new chat.
-
In the row of icons under the message box, click Connect apps.
The connector list opens, showing each app with a Connect link.
-
Click Connect next to the app you want to add.
-
Authorize the connection:
-
For OAuth apps (Jira, Azure DevOps, GitHub, Google Drive, Confluence), sign in to the external app in the authorization dialog and grant the requested permissions. Connecting either Jira or Confluence uses the same Atlassian OAuth, so authorizing one also covers the other.
-
For Figma, which currently supports a personal access token (PAT) only, paste a Figma personal access token when prompted. Generate the token in Figma under Settings → Account → Personal access tokens, and grant it these scopes so the assistant can read designs and comments:
- File content — read-only (
file_content:read) - Comments — read and write (
file_comments:read,file_comments:write) - Projects — read-only (
project_metadata:read) - Current user — read-only (
current_user:read)
Copy the token into the connector. Store it securely; treat it like a password. A token missing any of these scopes fails to connect with a scope-mismatch error.
- File content — read-only (
After the authorization completes, the app shows an enabled toggle in the connector list, and its icon appears under the message box. The assistant can now use that app in the current chat.
-
Connecting GitHub with your account gives the assistant access to public repositories only. To reach private repositories in an organization, the Katalon GitHub App must be installed on that organization (an org owner grants this once). Public repositories work with your user authorization alone.
If your account belongs to more than one Azure DevOps organization, name the organization in your request; the assistant auto-selects it only when you have exactly one.
You connect each app once per user. The connection stays available across your chats until you disconnect it.
Use a connected app in a chat
Reference the content you want the assistant to work with directly in your message — by URL, by ID, or by name. The assistant only reads from a connected app when your request calls for it; it does not sync or scan the app in the background. If your request needs an app that isn't connected yet, the assistant tells you and points you to the Connect apps panel.
Example prompts
Generate test cases from this requirement page: <Confluence page URL>
With Confluence connected, the assistant reads the page, including attachments and open comments, and drafts test cases for you to review. It can save the test cases you approve to your project and turn open questions in page comments into explicit test scenarios.
Check out this example video: Generate test case from requirement page.
Summarize Azure DevOps work item 5924 and list its attachments
With Azure DevOps connected, the assistant combines the work item history, description, and attached screenshots into one summary. After you confirm, it can also post its findings as a comment on the work item.
Import the test cases from this Azure DevOps work item into my project: <work item URL>
With Azure DevOps connected, the assistant reads the Test Case work item's Steps grid as structured actions and expected results. After you approve the import, it creates a matching Katalon test case step by step.
Import the PRD named "Payment flows" from my Google Drive and list the acceptance criteria
With Google Drive connected, the assistant finds the named document, imports its content, and extracts the acceptance criteria for you to review.
Write test cases from the acceptance criteria of PROJ-123
With Jira connected, the assistant reads the issue's description, acceptance criteria, and comments, and drafts test cases for you to review before saving them to your project.
Read the diff of PR #42 and suggest which existing test cases are impacted
With GitHub connected, the assistant reads the pull request diff and maps the changes to test cases in your project that may need updating.
Export the checkout screens from this Figma file and write UI test cases: <Figma file URL>
With Figma connected (via personal access token), the assistant exports the referenced frames as images, inspects the screens, and drafts UI test cases with expected visuals.
- Reference content explicitly — paste the URL or ID instead of describing the document. The assistant reads only what you point it to, so precise references produce precise answers.
- Scope one request to one outcome, such as "generate test cases from this page." Chain follow-up requests in the same chat instead of packing several goals into one message.
- Connect only the apps a chat needs, and use the per-chat toggle to mute the rest. A shorter tool list helps the assistant choose the right source.
- Review every write before you confirm it. The assistant shows what it is about to post, and nothing is written to a connected app without your approval.
Manage app connection
-
Under the message box, click the connected app icon.
-
To keep the app connected but stop the assistant from using it in the current chat, use the toggle to turn the app on or off.
The change applies from your next message. When the app is turned off, the assistant tells you that it is unavailable if your request needs it.
-
To adjust the app connection:
- Click the settings icon next to the connected app.
- On the connector details page, expand the Manage menu.
- Click Reconnect to reload the connection.
- Click Disconnect to remove the connection.
Disconnecting revokes the authorization for your user. The assistant can no longer access the app until you connect it again.
To switch to a different account on the same app, disconnect it first, then connect again and sign in with the other account.
Data access and security
- Each connection is scoped to your user account. The assistant accesses the external app with your permissions only — it cannot read content that your account cannot access, and connections made by other users are never shared with you.
- Katalon does not store your reusable credentials for the external app. For OAuth apps, access is granted through OAuth: Katalon stores the authorization token server-side, never exposes it to your browser or chat messages, and revokes it when you disconnect the app. For Figma, the personal access token you provide is stored server-side the same way, never exposed to your browser or chat messages, and deleted when you disconnect the app; revoke it in Figma as well if the token is no longer needed.
- Every write action requires your explicit confirmation in the chat before the assistant performs it.
Permissions each connection requests
The assistant requests only the access it needs to read the content you reference and perform confirmed write actions. What each connection grants:
| App | Permissions requested |
|---|---|
| Jira | Atlassian scopes read:jira-work and write:jira-work, plus offline_access for token refresh. |
| Confluence | Atlassian read/write content scopes (shares the Jira authorization). Adding a label uses the classic write:confluence-content scope. |
| Azure DevOps | Microsoft Entra ID OAuth granting read/write access to work items, Test Plans, pipelines, and repositories. The exact scope set is configured by Katalon on the connector. |
| GitHub | GitHub App authorization (not classic OAuth scopes). Access to repositories, issues, and pull requests follows the app's granted permissions and the organizations where it is installed. |
| Google Drive | OAuth access to your Drive files (read, and create/upload for confirmed writes). The exact scope set is configured by Katalon on the connector. |
| Figma | Personal access token with the scopes listed under Connect an app: current_user:read, file_content:read, file_comments:read, file_comments:write, project_metadata:read. |
These per-user connectors are separate from the project-level Jira integration and Azure DevOps integration, which link requirements, defects, and sprints/releases into your Katalon True Platform project for the whole team. The per-user Jira and Azure DevOps connectors here give the assistant on-demand, read/comment access scoped to your own account; the project-level integrations are the team-wide sync. You can use both at the same time.
Troubleshooting
| Problem | What to check |
|---|---|
| The assistant cannot find a document, page, or work item you referenced. | Verify the account you connected with can open that content in the external app. For Confluence, also confirm the connected Atlassian account belongs to the same site (for example, yourcompany.atlassian.net) that hosts the content. |
| The assistant tells you an app you connected earlier is unavailable. | Open Connect apps and check that the app's toggle is on and the connection is still active. Reconnect the app if it was disconnected. |
| A write action fails after you confirm it. | Ask the assistant for the exact error message and retry, or perform the change directly in the external app. |
| Figma stops working or reports it is unavailable. | Your personal access token may have expired or been revoked in Figma. Open Connect apps, reconnect Figma, and paste a new token. |