> For the complete documentation index, see [llms.txt](https://docs.oobeya.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.oobeya.io/integrations/all-integrations/code-quality-addons/testrail-integration.md).

# TestRail Integration

## 1. Enable API Setting on TestRail :tools: 

1. Click "**Administration**" on the right as follows: 

![](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MGIlBSTjQtZxUoFwUx4%2Fuploads%2FaSlXej5ix51TzSYch3N3%2Ffile.png?alt=media)

2\. Click "**Site Settings**": 

![](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MGIlBSTjQtZxUoFwUx4%2Fuploads%2Fz4TmtxPdcEDDJQaCnxUa%2Ffile.png?alt=media)

3\. Click to the "**API**" tab, select the "**Enable API**" option, and click the "**Save Settings**" button: 

![](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MGIlBSTjQtZxUoFwUx4%2Fuploads%2F3OSiFPQeZXve94UaOkC6%2Ffile.png?alt=media)

## 2. Install TestRail Addon on Oobeya :jigsaw: 

1. Log in to [Oobeya](https://oobeya.io/) with an Administrator account.
2. Navigate to Market Place and select the **TestRail** addon and then click the "**Install**" button.

![](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MGIlBSTjQtZxUoFwUx4%2Fuploads%2FkG1XMaFdpG0ajGdELkYe%2Ffile.png?alt=media)

## 3. Add a New Data Source :electric\_plug: 

1. Navigate to Data Sources and select **TestRail** to add a new data source. 

![](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MGIlBSTjQtZxUoFwUx4%2Fuploads%2Fi1eciQEx3n8KfUuyPVad%2Ffile.png?alt=media)

2\. Click the "New Data Source" button and fill in the form as : 

* **Data Source Name:** You can enter any name for your TestRail Data Source. 
* **Server URL:** Enter this area (ex: https\://\<yourCompany>.testrail.io).&#x20;
* **Username:** The username that you use to sign in to the TestRail.&#x20;
* **Password:** The password that you use to sign in to the TestRail.&#x20;

![](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MGIlBSTjQtZxUoFwUx4%2Fuploads%2FoEZOkPKVajZVudYrQ2Dg%2Ffile.png?alt=media)

3\. Click the "**Test Connection**" button to verify the connection.&#x20;

## Ready to Connect :rocket:&#x20;

Now Oobeya is connected with your own TestRail Cloud to track & visualize the status of tests with dashboards and reports.&#x20;

## **Next Steps** :dart:&#x20;

* [Add a new Widget](/dashboards/adding-a-new-widget.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.oobeya.io/integrations/all-integrations/code-quality-addons/testrail-integration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.