# Xray

<div align="left"><img src="/files/XMVp5apCWoKkhyEtZrlb" alt=""></div>

## Set up

### Navigate to the Integration settings view

1. Select an app in the top left corner from the Switcher
2. Navigate to **App Settings** by clicking the gear icon (⚙️) at the top of the Timeline sidebar
3. Click on **Integrations** in the sidebar

### **Connect Xray**

* Find the **Xray** integration module under the **Regression testing** section
* Click the **Connect** button
* Enter your **Client ID** and **Client Secret**
  * Every Xray API Key you generate will have a Client ID and Client Secret associated and displayed alongside. You can generate API Keys for Xray within Jira by going to **Settings > Apps > Xray > API Keys** (:link: [Xray Documentation - Global Settings: API Keys](https://docs.getxray.app/space/XRAYCLOUD/44568019/Global+Settings+-+API+Keys))

{% hint style="info" %}
When connected, Xray API actions will be performed on behalf of the user linked to the Xray API key being used.
{% endhint %}

* Click **Save**; you’ll be presented with a dialog in which to add any test execution naming keywords

{% hint style="warning" %}
For linking test executions to specific releases, Runway will parse your test execution names for the presence of a version string (e.g. “**2.3.0**”)
{% endhint %}

{% hint style="info" %}
You can optionally add test execution naming keywords (case insensitive) to associate test executions with a particular app, e.g. "iOS" or "Android"
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.runway.team/integrations/regression-testing/xray.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.