Skip to main content
All CollectionsUsing Assembla Integrations
TestRail Integration with Assembla
TestRail Integration with Assembla

How to setup and use Testrail Integration

Toshi Dávila avatar
Written by Toshi Dávila
Updated over a week ago

When you integrate Testrail with Assembla, you can relate, view and navigate to any TestRail entity in Assembla tickets

Set Up the Integration

First, your TestRail account must be connected to your Assembla account in order to enable the integration.


First, your account administrator must enable APIs for your TestRail site by opening the Administration settings page, clicking Site Settings from the sidebar on the right, opening the API tab and checking the Enable API checkbox. Don’t forget to select Save Settings before leaving this page.

Then, you’ll need to generate an API key to authenticate with Assembla. Click on your name at the top of the screen, open My Settings, and click on the API Keys tab.

Generate an API key by clicking Add Key - make sure to make a note of your API key, because TestRail will only show you your key once. Then, make sure you Save API Key and also Save Settings before leaving this screen.


You can enable integration in Assembla at Portfolio level as well as at Space level.

Portfolio level Integration

This is a global level of integration settings. You can relate as many accounts as you want. Also, you can set different accounts, or disable/enable the integration for each space.

Enable integration

To enable integration at Portfolio level, Manager can open the TestRail Integration page by selecting Admin from the tile menu at the top of the screen and clicking on ‘TestRail Integration’ link as shown in an image below.

Core User can open the TestRail Integration page by selecting Integrations from the top menu while on the space level.

Enabling Integration from TestRail Integration page will enable it for all child active spaces in this portfolio.

Connected Accounts

You can connect to the new TestRail account using the Authorize New TestRail Account button, You will need your TestRail URL, Login, API Key or Password.

Added accounts will be listed in this section along with a TestRail account link and user name. The latest added account will be set as an active account. It will be shown as (default) in front of the account name.

Account settings

For each account, the user can do some settings like set default columns for Testrail results, and case list to be shown on the Assembla side and remove an account. These settings will be global settings for that account unless overridden by child space.

Integration Settings

Users can do global settings related to Testrail integration, like by default enabling integration for all new spaces (this option will be checked by default). Also, it is possible to Enable/Disable integration in all spaces on click of ‘Enable in all spaces’ and ‘Disable in all spaces’ links.

(BETA) Synchronize with TestRail

This is a global setting and if set at the portfolio level, it will be set for all child spaces unless overridden at space level. If this functionality is enabled by user, every time relation is created or removed it tries to update correspondent TR entities by editing `references` fields on the TestRail side.

Space level integration

TestRail Integration could be enabled and disabled for specific space as well. Open the Integrations page from the tile menu at the top of the screen. TestRail entities will be related to the account which is set as default.

Select Enable to the right of the TestRail integration. Then, select Settings and enter your account data to authenticate. You will need your TestRail URL, Login, and API Key/Password.

Like at portfolio level, the same user accounts will be shown at space level under the connected accounts section and the default account marked at the portfolio level will be shown as selected at space level unless the user has overridden and set the different account as default one.

On the Click to change or relate different account link, the user can see a list of connected accounts and select one to make it an active account. TestRail entities search functionality will fetch entities from this account which is set as default.

View in Tickets

When TestRail Integration is enabled for space an additional Testrail tab will be shown on the Ticket Details page. Users can relate TestRail entities with tickets from the default account selected at space level integration.

Relate Entities

Select Project

To relate an entity with any ticket, the user has to first select the TestRail project. This project will become the default project for the default account and all actions related to entities will fetch entities for this project

Search Entities

Users can search TestRail entities belonging to specific entity types by clicking on the following tabs(on the right side). This will fetch all entities associated with that entity type for the selected project from the TestRail account and will be listed down.

Users can relate an entity on click of the Relate Entity button on each entity row.

Search results can be filtered using filters associated with each entity result as shown below

It might be possible that users want to relate entities from different projects, for that he can click on the Change button from the top right corner of the search result screen and select the required project.

Relate multiple entities at once using ID's

There is an easy way to relate known entities with a related search box on the top left corner of the screen as shown below, you can search test run, test plan, test milestone, and test cases by using comma-separated ids with prefix like R11, C23, M12 from search box and click on Relate button to relate those.

All related entities with the ticket will be grouped by project and account and listed down on TestRail tab as shown below

Un-relate entity

Click on ‘x’ button next to each entity to unrelate it.

Space Tickets List & Cardwall

Tickets can be filtered based on TestRail entities associated with it using the TestRail section added in the current filters. All TestRail entities and conditions [Has any of, Has all of, Has none of] are listed down with input box and user can search using entity ID with and without prefix.

Did this answer your question?