TestRail Setup Guide Lite

Follow our setup guide to connect TestRail to Fivetran.

Prerequisites

To connect TestRail to Fivetran, you need a TestRail admin account with API access.

IMPORTANT: The TestRail API needs to be enabled on your account for the connection to work. You can check in your TestRail dashboard by going to Administration > Site Settings > API. Make sure the Enable API box is checked.

NOTE: Make sure your reports are accessible to the API. Learn more in TestRail's support article.

Setup instructions

Find subdomain

Find your subdomain in your TestRail login and account URL and make a note of it. For example, if your login URL is https://fivetran.testrail.com/index.php?/auth/login, then your subdomain is fivetran.

Generate API key

Log into your TestRail account.
In the user drop-down menu in the top right of the page, select My Settings.
Go to the API KEYS tab, then click Add Key.
Enter a descriptive name for the API key and click +Generate Key.
Make a note of the API key. You will need it to configure Fivetran.

Finish Fivetran configuration

In the connector setup form, enter your chosen Destination schema name.
Enter the Subdomain you found.
In the Username field, enter your TestRail email.
Enter the API key you generated.
(Hybrid Deployment only) If your destination is configured for Hybrid Deployment, the Hybrid Deployment Agent associated with your destination is pre-selected in the Select an existing agent drop-down menu. To use a different agent, select the agent of your choice, and then select the same agent for your destination.
Click Save & Test. Fivetran will take it from here and sync your TestRail data.

Connector Overview

Schema Information

Release Notes

API Connector Configuration