Tools: OnTime REST API

Defect plugins can be used to implement a deeper bug tracker integration and TestRail comes with a ready-to-use OnTime defect plugin.

The OnTime defect plugin discussed in this article uses OnTime's new REST API, which we recommend for OnTime v13 or later (including OnTime Now). If you are using OnTime v12 or earlier, please use our OnTime SOAP defect plugin instead.

To configure the defect plugin, select Administration > Integration and select OnTime_REST in the Defect Plugin dropdown list. The next step is to configure all the necessary connection settings in the Configuration field. Project specific plugins and configuration settings can optionally be specified under Administration > Projects.

You might need to activate the API in OnTime first. To do this:

  • Select Tools > System Options > OnTime API Settings in OnTime
  • Enable the API on that page
  • Generate API keys on that page

The required client ID as well as the client secret needed to configure the integration are also listed on that page.

When the defect plugin has been configured, a new Push link is shown next to the Defects field in the Add Test Result dialog. Clicking the link will open a popup dialog that enables you to push a bug report to OnTime without leaving TestRail. Once the test result was added, hovering the mouse cursor over an defect ID will open a window with useful information and status details about the defect in OnTime.


The OnTime defect plugin was built to work with a standard OnTime configuration. TestRail allows you to customize the integration to work with your own custom fields among other things. Please see the following articles for details on how to customize the integration: