> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qawolf.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How to integrate with Xray

> Sync QA Wolf automated test results to Xray Test Management for Jira, including test executions and metadata.

## Features

Integrate QA Wolf with [Xray Test Management for Jira](https://marketplace.atlassian.com/apps/1211769/xray-test-management-for-jira) to sync automated test results directly to Jira.

For each QA Wolf run, the integration can:

* Create a test execution in Xray.
* Sync automated test results (passed, failed, skipped).
* Link executions to existing Xray test cases.
* Include execution metadata (start/end time, environment).
* Optionally link executions to a test plan.

Results are synced after runs reach Completed status in QA Wolf.

## Limitations

* Cloud-hosted only (Jira Cloud + Xray Cloud).
* Only one Jira/Xray project can be configured per QA Wolf workspace.
* Xray test cases must already exist.
* Test executions are created at the execution level (no test plan management).
* Custom fields are not supported unless specially configured.

## Configure Xray / Jira

Customers configure Xray and Jira. QA Wolf uses the provided credentials to sync results and enable the integration.

<Tip>
  Generating Xray API credentials requires administrator access in Jira/Xray. If you're not a Jira/Xray admin, ask one to create the credentials.
</Tip>

### Set up in Xray

* Jira Cloud instance with Xray installed.
* Xray-enabled Jira project to receive test executions.
* Xray Cloud API access enabled.
* Xray test cases already created (tests are not created automatically).

### Credentials to share with QA Wolf

Once Xray is configured, provide QA Wolf with:

* Xray Client ID.
* Xray Client Secret.
* Jira project key (for example, QA or MOBILE).
* *(Optional)* Default test plan to link executions.

## Verify the integration

After QA Wolf enables the integration:

<Steps>
  <Step>
    Run your automated tests in QA Wolf.
  </Step>

  <Step>
    After the run completes, a new Test Execution appears in your Jira project.
  </Step>

  <Step>
    Test results and execution metadata are visible in Xray.

    <Tip>
      If executions do not appear as expected, or if test cases are not mapping correctly, contact QA Wolf for verification.
    </Tip>
  </Step>
</Steps>
