Bitbucket Integration

This document explains how to set up and manage a Bitbucket integration in Katalon True Platform.

Connect Bitbucket to Katalon True Platform to sync test cases and test suites between the two systems.

Find your starting point:

• You are setting up Bitbucket for the first time? -> Start from Step 1
• Your organization is already connected and you only need to link a repository? -> Skip to Step 2
• You need to manage an existing integration (disconnect, archive, or restore)? -> Skip to Managing your Bitbucket integration

---

Step 1: Authorize the Bitbucket Connection (Account-level)

This step establishes the connection between Katalon True Platform and Bitbucket. No data is synced yet.

requirements

• You must have the Account Admin or System Admin role in Katalon True Platform.

1. Go to Account Settings > Integrations and click + Create Integration.
2. In the Available Integration list, select Bitbucket.
3. Fill in the required fields:
   • Integration Name: A custom label (max 50 characters).
   • Organization Account URL: Your Bitbucket workspace URL (must start with https://).
     • Example: https://bitbucket.org/workspace-example
   • Bitbucket Username
   • Bitbucket App Password: Used to authenticate the connection. Refer to Atlassian documentation on creating an app password.
   • Description (Optional): Max 255 characters.
4. Click Test Connection to validate, then click Save.

Result

To verify the connection is active, go to Account Settings > Integrations and check the Integration list.

• If the status initially shows Inactive, reload the page to update it to Active.
• If the status shows Error, verify all required fields, especially the Bitbucket App Password.

---

Step 2: Link Repository to Project (Project-level)

This step connects a specific Bitbucket repository, branch, or directory to your Katalon True Platform project and syncs test data.

requirements

• You must have the Project Admin role in the project.
• A Bitbucket account must already be connected at the Account-level (Step 1).

1. Navigate to your project > Settings > Integrations.

2. On your linked Bitbucket connection, click the right edge and select New configuration (Settings icon).

3. Fill in the required fields:

   • Display Name: A custom name for the linked project (max 50 characters).
   • URL: The URL to the repository, branch, or directory from the linked Bitbucket workspace.
     • Example: https://bitbucket.org/katalon-test/katalon-repo/src/main/Test%20Cases
   • Link existing test execution results with test cases having the exact same paths and names (Optional): Enable this to attach existing results to matching test cases and test suites.
   • Description (Optional): Max 255 characters.

4. Click Proceed to sync data and finalize the connection.

   • If the status initially shows Inactive, reload the page to update it to Active.
   • If you click Save after modifying details, changes are saved but status may remain Inactive.
   • To complete syncing, click Proceed.

5. [Optional] To edit an existing linked Bitbucket integration, click the Edit (pen) icon, update fields, and click Proceed.

Result

Your Bitbucket repository is now active within your project and data is synced to Katalon True Platform.

---

View Test Cases or Test Suites Synced from Bitbucket

To view synced test cases or test suites, go to Tests > Test Cases/Test Suites.

---

Managing Your Bitbucket Integration

Katalon True Platform provides multiple ways to manage Bitbucket integrations without losing historical data.

• Use Disconnect to disable Bitbucket integration across all projects (Account-level).
• Use Archive to disable Bitbucket connection for a single project (Project-level).

Katalon does not support permanently deleting integrations. This ensures audit history is preserved and enhances security and traceability.

Disconnect a Bitbucket Connection

Required role: Account Admin or System Admin.

Disconnecting makes the integration inactive across all projects. Katalon True Platform does not support fully deleting integrations to preserve audit history.

1. Go to Account Settings > Integrations.

2. Click the Disconnect icon next to the connection.

3. Confirm by clicking Disconnect in the dialog.

   => The status changes to Inactive. All projects using this integration lose the ability to sync with Bitbucket.

4. To reconnect, click the Reconnect icon next to the integration and confirm. All projects will resume syncing once reconnected.

Archive a Linked Bitbucket Repository

Required role: Project Admin.

Archiving disables the connection for one project only. Other projects using the same Bitbucket integration are not affected.

1. Go to Project Settings > Integrations.
2. Click the right edge of the linked connection and select Archive.
3. Confirm by clicking Archive in the dialog.

Result: The integration no longer appears in the Test Cases/Test Suites module. Any scheduled test runs in the Execution module will be automatically canceled at runtime.

Restore an Archived Bitbucket Integration

1. Go to Project Settings > Integrations.
2. Click New configuration (settings icon) on the Bitbucket connection.
3. Enter the same repository URL as the archived configuration and click Proceed.

Katalon True Platform restores the archived configuration instead of creating a duplicate.