Integrate with ClickUp

This topic explains how to integrate TestRail with ClickUp. There are currently two recommended ways to do this:

  • Using defect URLs to link test results to a ClickUp task
  • Using reference URLs to link milestones, test runs, test plans, or test cases to ClickUp lists

Note that you can configure defect URLs and reference URLs globally or on a per-project basis.

To make the most of the ClickUp integration, it is recommended that users completely understand ClickUp hierarchy levels.

Unfortunately, ClickUp does not offer dedicated URLs for adding tasks and lists. Hence, it is not possible to configure Defect Add Url or Reference Add Url.

Defect URLs

The defect URL can be used to let TestRail know how to access your ClickUp tasks directly from your test results.

Once the URL has been configured, you can use the Defects field on the Add Result window. This link allows you to jump to a related ClickUp task.

To configure a unique ClickUp URL in your entire TestRail instance, go to the Dashboard and select Administration > Integration > Defects.

You can alternatively enter separate task URLs for each project by going to Administration > Projects and clicking the edit icon of the corresponding project.

Use the following URL to configure the view task address:

ClickUp installation
Defect View Url: https://app.clickup.com/t/%id%

Reference URLs

The reference URLs are used to link milestones, test runs, test plans, and test cases to lists stored in ClickUp via the References field.

Once the URL has been configured, list IDs entered in the References field are linked to your ClickUp instance to make it easier to jump to them.

To configure a unique ClickUp URL in your entire TestRail instance, go to the Dashboard and select Administration > Integration > References.

You can alternatively enter separate list URLs for each project by going to Administration > Projects and clicking the edit icon of the corresponding project.

Use the following template URL to integrate TestRail with ClickUp making sure you input the real Workspace ID:

ClickUp installation
Reference View Url: https://app.clickup.com/<workspace_ID>/v/li/%id%
Was this article helpful?
1 out of 2 found this helpful