Xray Setup
Add Xray client credentials for Test Sets, Executions, and steps.
When you need Xray
Connect Xray when you want push to create Xray-oriented artifacts beyond plain Jira issues — especially optional Test Set and Test Execution workflows.
You can push test cases to Jira with Jira credentials alone. Xray is required for Test Set / Test Execution options in the Push drawer.
Create credentials
- In Jira, open your Xray app settings and create an API key (Client ID and Client Secret). Follow Xray's official documentation(opens in a new tab) for your Cloud site.
- Copy the Client ID and Client Secret. Store the secret securely.
example
Xray Client ID: 12A3B4C5D6E7F8G9...
Xray Client Secret: abcdef0123456789...Connect in the app
- Open Jira / integration settings (same place as Jira Cloud setup).
- Enter the Xray Client ID and Client Secret.
- Save. If a secret is already stored, leave the field blank to keep it.
How the app uses Xray
- During push, you can optionally create a Test Set and/or Test Execution and link newly created tests.
- Summaries default to a project-keyed label based on your workflow title; you can edit them before confirming.
- Results and any warnings appear in the Push drawer after the run completes.
Full push flow: How Push Works.