References: Reference URLs - TestRail

References: Reference URLs

Reference URLs are an easy and universal way to link TestRail to requirement management, user story, wiki or document management tools. Once the reference URLs have been configured, TestRail allows you to link test cases to external resources and quickly jump from test cases to the linked resources.

Configuring the integration

The reference integration can be configured globally or on a per-project basis. You can also specify global reference URLs and override them for just a few specific projects. To configure global reference URLs, select Administration > Integration > References tab and enter the web addresses of your tool.

Reference View Url

This is the web address of your external tool to view a reference. Use %id% as the placeholder for the reference ID or article name. E.g., if a reference is accessed with the address http://server/view.html?1234, enter http://server/view.html?%id% here.

Reference Add Url

This is the web address of your external tool to add a reference. Not all tools support this and you might need to add new references from your tool’s user interface instead.

To configure references for a specific project, edit the project and enter the web addresses of your bug tracker on the Integration tab.

Example: bug & issue trackers

To link your test cases to your bug or issue tracker, simply use the example URLs listed in the Defect URLs topic. Once you have configured the address of your issue tracker, TestRail automatically links all issue IDs that you enter into the References field.

Example: Wiki software

You can also use the References field to link test cases to specifications and other documents in your Wiki software. For example, if the web address of your Wiki articles typically look like this:


Then enter the Reference View Url like this:


You can then enter My_article in the References field of test cases to link to your Wiki pages. To enter multiple references, separate them with commas.