Azure DevOps Integration
This document explains how to set up and manage an Azure DevOps integration in Katalon True.
Connect Azure DevOps to Katalon True to sync requirements, bugs, and release planning data, link Azure DevOps Test Plans cases, and push test results between the two systems.
Find your starting point:
- You are setting up Azure DevOps for the first time? -> Start from Step 1
- Your organization is already connected and you need to configure a project link? -> Skip to Step 2
- You need to manage an existing integration (disconnect, archive, or restore)? -> Skip to Managing Your Azure DevOps Integration
- You need to link Azure DevOps Test Plans cases? -> Go to Link Azure DevOps Test Plans cases
- You need to export test cases into Azure DevOps? -> Go to Push test cases to Azure DevOps
- You need to publish execution results to Azure DevOps? -> Go to Push test results to Azure DevOps
- Each project needs its own restricted PAT? -> See the Use project PAT option in Step 2
Step 1: Authorize the Azure DevOps Connection (Account-level)​
This step establishes the connection between Katalon True and Azure DevOps. No project data is synced yet.
- You must have the Account Admin or System Admin role in Katalon True.
-
Go to Account Settings > Integrations and click
+ Create Integration. -
In the Available Integration list, select Azure DevOps.
-
Fill in the required fields:
- Integration Name: A custom label (max 50 characters).
- Organization Account URL: Your Azure DevOps organization URL (must start with
https://).- Example:
https://dev.azure.com/your-workspace
- Example:
- Personal Access Token (PAT): Refer to Microsoft documentation on creating a PAT. Ensure your PAT includes required permissions.
Azure DevOps Permissions Required for Katalon True Integration
Integration Feature Required Permissions Notes Manual Sync Read Project and Team,Read Work Items,Read Analytics
Access level: at least BasicRequired to fetch test and work item data. Link Defect Read Project and Team,Read Work ItemsEnables linking Azure DevOps work items to Katalon True. Create Defect Read Project and Team,Read & write Work ItemsNeeded to create new Azure DevOps work items (for example, bugs) from Katalon True. Push Test Result Read Project and Team,Read & write Test ManagementEnables pushing test execution data from Katalon True to Azure DevOps. Link Test Case to KS Read Project and Team,Read & write Test ManagementRequired to associate Katalon Studio test cases with Azure DevOps test cases. Handle Webhook Events Read Project and Team,Read Work Items,Read Analytics
Access level: at least BasicNeeded for syncing Azure DevOps events to Katalon True. Webhook Setup Member of the Project Collection Administrators group Required only when configuring webhooks from Azure DevOps to Katalon True. - Description (Optional): Max 255 characters.
-
Click Test Connection to validate, then click Save.
Result​
To verify the connection is active, navigate to Account Settings > Integrations.
- If the status initially shows Inactive, reload the page to update it to Active.
- If the status shows Error, verify all required configuration fields, especially the PAT.
Step 2: Link Azure DevOps to Project (Project-level)​
This step shows how to connect an Azure DevOps project to your Katalon True project and configure synchronization settings.
- You must have the Project Admin role in this project.
- An Azure DevOps account must already be connected at the Account-level (Step 1).
- Navigate to your project > Settings > Integrations.
- On your linked Azure DevOps connection, click the right edge and select New configuration (Settings icon).
-
[Optional] By default, the integration uses the PAT saved on the account-level Azure DevOps connection. To use a separate PAT for this project, select Use project PAT, enter the PAT, and click Test Connection to validate it. The projects this PAT can access become available for selection. If the Use project PAT option is not available, ask an Account Admin to allow project-level PAT management for Azure DevOps in Account Settings.
How the project-specific PAT behaves- All Azure DevOps requests for this integration use the project PAT instead of the account PAT. The saved PAT belongs to the project integration, not to your user account. Background sync, webhooks, and enabled Test Plans, result, and defect operations for this integration use it.
- Rotating or revoking one project's PAT does not affect other projects. A valid project PAT keeps working even when the account PAT reports an error.
- If the project PAT fails, the integration does not fall back to the account PAT. Fix or replace the project PAT.
- Disconnecting the account connection still disables all its project integrations, including those with their own PAT.
-
Configure the project-level settings:
Step 1: Select the Project and Team​
- Project: Select the Azure DevOps project to link.
- Team (Optional): Select a team to support team-based board mapping.
- Description (Optional): Max 255 characters.
Step 2: Additional Integration Settings​
- Pull Requirements: Enable generation of test cases from requirements and requirement-to-test-case traceability.
- Bug Mapping (Pull bugs from ADO): Enable bug synchronization from Azure DevOps.
notesEnabling either option above controls which mapping sections are available in later steps.
Step 3: Map Iteration Path to Release and Sprint​
info- This step is enabled only if Pull Requirements and/or Bug Mapping is selected in Step 2.
- Tier levels follow your Azure DevOps work-item hierarchy configuration.
Select an iteration path and map it to Release/Sprint in Katalon True.
- Use Full path when you need full hierarchy paths for clearer resource mapping.
- To enable For ADO - Team Board, you must select a Team in Step 1.
Step 4: Common Fields and Values Mapping​
Map ADO Priority levels (1 to 4) to Katalon True Priority levels.
Step 5: Requirement Fields and Values Mapping​
infoThis step is enabled only if Pull Requirements is selected in Step 2.
- Release Date for Requirement (Optional): Select up to three Azure DevOps date fields.
- The system uses these fields in priority order (left to right) and picks the first available date.
- Map ADO State to Katalon True Status.
- Select Work Item Types to sync.
Step 6: Bug Fields and Values Mapping