Connect to Jira Cloud

qTest offers a seamless connection between qTest SaaS and your Jira Cloud instance. There are two ways to establish this connection: using an API token and using an OAuth token.

For information about the permissions needed to set up and configure a Cloud connection, refer to Which Jira Permissions Are Required to Set Up a Connection?

Before you start

Before configuring your connection, you must first install the free Tricentis qTest Integration for Jira add-on from the Atlassian Marketplace.

Locate Jira connection settings

Whether you want to add or edit a connection, you can find Jira connection settings in the following location:

  1. Go to Settings and select Integration Settings from the dropdown.

  2. Select Jira in the External Systems panel to go to the Configure integration: Jira page.

  1. From here, you can create a new connection or edit an existing one:

    • To create a new connection, select Add Jira Connection.

    • To edit an existing connection, select the blue hyperlink of the Jira Integration you want to edit in the Connection Name column.

Configure Jira Cloud with an API Token

Create a new Jira Cloud Connection with an API Token

Follow these steps to configure a connection between Jira Cloud and qTest using an API token:

  1. Select Add Jira Connection and enter a Connection name.

  2. Choose Jira cloud as your deployment type.

  3. Enter the Server URL of your Jira instance. For example, https://sample.atlassian.net

  4. Select Username & password as the authentication method.

  5. Enter the following information:

    • One-time Password: If this is the first time you're adding a Jira connection, enter the one-time password from your Jira instance. To find the one-time password after you install the integration, in Jira, go to Apps > Manage App > Get started under Tricentis qTest Integration for Jira. Skip this if you've previously connected qTest to another project.

      Please note that you must also enter this one-time password again if you are editing an existing connection.

    • Username: Enter a Jira Global Admin username in this field. A global administrator in Jira is the same as a site administrator. For information on setting up Jira administrator permissions, refer to Manage Jira Global Permissions (opens in a new tab).

    • Password or Token: Enter your Jira API Token. Learn how you can create an API token for your Atlassian account (opens in a new tab).

  1. Select Test Jira Connection, then select Save and Configure to save your connection.

Edit an Existing Jira Cloud Connection to use the API Token

If you are editing an existing integration, connection follow these instructions:

  1. In the Connection Name column, select the blue hyperlink of your Jira Integration name.

  2. Select Username & Password as the authentication type.

  3. Once you retrieve the API Token, enter it in the Password or Token field. Learn how to create an API token with the Atlassian documentation (opens in a new window).

  4. Enter the One-time Password from your Jira instance to re-verify the connection. To find the one-time password after you install the integration, in Jira, go to Apps > Manage App > Get Started under Tricentis qTest Integration for Jira.

  5. Select the Test Jira Connection icon. When the connection is tested, select Save and Configure.

Configure Jira Cloud with OAuth 2.0

If you don't want to use an account Username and Token, you can connect qTest Manager to Jira Cloud using an OAuth token.

Set up OAuth 2.0 in Jira Cloud

Before you can start setting up your Jira integration in qTest, you need to set up a few things in Jira to get your Client ID and Client secret.

In Jira, you need to create a new OAuth 2.0 Integration app for your qTest instance (links opens in a new tab). Here's the specific information for qTest that you need to add or locate in Jira:

In the Authorization tab of your new app, add the Callback URL in the following format: https://<qtest url>/portal/oauth2/callback/jira. For example, https://sampleurl.qtestnet.com/portal/oauth2/callback/jira

In the Permissions tab of your new app, add the following scopes:

  • User Identity API: Add View active user profile.

  • Jira API in the Classic scopes tab:

    • View Jira issue data

    • Manage project settings

    • View user profiles

    • Create and manage issues

    • Manage Jira webhooks

  • Jira API in the Granular scopes tab:

    • View projects

    • View project versions

    • View board configuration

    • View boards, backlogs, and related items

    • View sprints

In the Settings tab of your new app, locate the Client ID and Secret that you'll need to configure the connection in qTest.

Set up OAuth 2.0 in qTest

Once you've set up OAuth 2.0 in Jira, follow these steps to add it to new or existing Jira connections in qTest:

  1. Select Add Jira Connection and enter a Connection name.

  2. Choose Jira cloud as your deployment type.

  3. Enter the Server URL of your Jira instance. The Server URL is the base URL for your Jira instance. For example, https://sample.atlassian.net

  4. Select OAuth 2.0 as your authentication method.

  5. Enter the Client ID and Client secret. You can find these in the Settings tab of the OAuth 2.0 app you set up in Jira.

  6. Select Authorize Jira connection.

  7. When you're redirected, choose the Jira instance you want to connect to from the Use app on dropdown, and select Accept.

  8. After you successfully connect, select Save and Configure to save the connection.

Configure Release webhook

This is a temporary measure that you need to complete to use release and sprint integration with Jira Cloud using OAuth 2.0. You don't need to do this for requirements or defects.

When you've successfully connected Jira and qTest, you'll also need to set up a webhook in Jira for release and sprint integration.

After you've enabled the release integration in qTest, you'll see a dialog with a webhook URL. Copy the URL, and use it to create a webhook in your Jira Cloud instance (opens in a new tab).

Add the following events to the webhook you create:

  • Sprint: created, updated, started, closed.

  • Version: released, unreleased, created, moved, updated, merged.

Configure Jira Cloud with OAuth 1.0

Atlassian has deprecated OAuth 1.0 and may remove it in future Jira updates, which may cause existing connections to stop working. You should create all new connections with OAuth 2.0, and plan to migrate existing connections to avoid service disruptions.

Set up OAuth Token in Jira Cloud

Before you can connect qTest to Jira with OAuth 1.0, you need to set up a Direct application link in Jira. Take a look at the Jira documentation to learn more about how to set up an application link for qTest in Jira (opens in a new tab).

Here's the information you'll need about qTest during setup:

  • Enter your qTest URL as the Application URL. For example, https://sample.qtestnet.com

  • Select Atlassian product as the Application Type.

When you set up the application link in Jira, the Configure Application URL page may tell you it didn't receive a response from the URL. You can ignore this message and select Continue to finish setup.

After you create the application link in Jira, locate it on the Jira Application links page and select Edit from the three-dot menu. Go to the Incoming Authentication tab and enter the following values:

  • Consumer Key: qTest

  • Consumer Name: hard-coded consumer

  • Public Key:

    Copy 
    MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxZDzGUGk6rElyPm0iOua0lWg84nOlhQN1gmTFTIu5WFyQFHZF6OA4HX7xATttQZ6N21yKMakuNdRvEudyN/coUqe89r3Ae+rkEIn4tCxGpJWX205xVF3Cgsn8ICj6dLUFQPiWXouoZ7HG0sPKhCLXXOvUXmekivtyx4bxVFD9Zy4SQ7IHTx0V0pZYGc6r1gF0LqRmGVQDaQSbivigH4mlVwoAO9Tfccf+V00hYuSvntU+B1ZygMw2rAFLezJmnftTxPuehqWu9xS5NVsPsWgBL7LOi3oY8lhzOYjbMKDWM6zUtpOmWJA52cVJW6zwxCxE28/592IARxlJcq14tjwYwIDAQAB

If you set up your own Private Key in qTest, enter that as the Public Key here instead.

Create a Jira Cloud connection with OAuth 1.0 in qTest

Once you've set up OAuth in Jira, you're ready to add it to new or existing Jira connections.

To set up a Jira connection with OAuth in qTest, follow these steps:

  1. Select Add Jira Connection and enter a Connection Name.

  2. Choose Jira cloud as your deployment type.

  3. Enter the Server URL of your Jira instance. The Server URL is the base URL for your Jira instance. For example, https://sample.atlassian.net

  4. Select OAuth 1.0 as your authentication method.

  5. Enter the One-time Password from your Jira instance to re-verify the connection. To find the one-time password after you install the integration, in Jira, go to Apps > Manage App and select Get started under Tricentis qTest Integration for Jira.

  6. Select Authorize Jira connection and qTest will create an authorization URL, then select the Authorize URL hyperlink.

  7. Select Allow to grant qTest access to Jira, then copy the verification code.

  8. Paste the code into the Verification Code field and select Submit.

  9. Select Test Connection, then select Save and Configure.

What's next

After you set up a Jira integration, you're ready to configure defects and import requirements from Jira.