Learn how to integrate Xray Cloud

Xray Cloud Integration

Directly link your test cases to testRigor and create test runs in Xray Cloud automatically every time you execute your tests.


How to Enable the Integration

Enable Xray Cloud

Settings -> Integrations

First, you need to allow Xray Cloud integration on by navigating to Settings > Integrations.
Make sure the integration is enabled, and fill in the required fields.

We can add as many custom fields as needed.

Don’t forget to click the Save button on the bottom of the page after filling in the fields!

Your project key can be located in the project URL, which should have the following template or similar:


How to Obtain an API Key in Xray Cloud

  1. Click on the settings icon () in the top right corner of Jira
  2. Click Apps.
  3. On the Apps Manager page, in the left-side navigation pane, click on API Keys under Xray (you may need to scroll down on the navigation pane to find it).
  4. Click the Create API Key button, choose a user and click Generate.
  5. Copy the Client Id and Client Secret that we will use in the integration settings.
Once the integration is enabled, you can go to your testRigor test cases and start linking them to the test cases in Xray Cloud.
Xray Cloud

Link testRigor test cases to the test cases in Xray Cloud

To link a testRigor test case to the Xray Cloud test case, we need:
  1. Copy the Key of the test case in Xray Cloud, which is found at the bottom of the task card of your test case.
  2. In testRigor, find the test case you wish to link, then click the Change button on the right of Xray Cloud label at the bottom of the test case summary info.
  3. Paste (or type) the Key into Test key field and click Save.
Xray Cloud

Using Custom Fields

The Xray Cloud allows the user to set custom fields and make them required or optional on their test executions.

testRigor is ready to work with these custom fields by adding them when setting up the Xray Cloud integration. Custom fields can also be added at any time after setup.

We can add as many custom fields as needed, and each custom field will have a default value. testRigor will send this default value if no other value is provided.

On the Test Suite Details page, when we will run a full retest, there will be a corresponding field for each custom field added in the integration settings. When we fill in this field and request a retest, this data will override the default data defined on the integration settings, as they will be more specific for that execution.

In the testRigor linked test case, on the right of the Xray Cloud label, we can click Custom Fields and set values to the custom fields. As this value is more specific for this test case, the value is defined has high priority and will override the default value and the value defined in the Test Suite Details page.

Xray Cloud

Test Run results

Now every time you do a full Rerun of your testRigor tests, we will automatically create a Test Run in Xray Cloud, and you will have a pass/fail status for each linked test case.

Additionally, you can run a test suite without creating a test cycle in Xray Cloud by checking the Do not update Xray Cloud checkbox on the Test Suite Details page before rerunning the test suite.

If you have any questions or encounter any unexpected issues during setup, feel free to contact testRigor support.