Creating an API Hook

You can generate an API hook for each of the Test Suites within your Test Organization. API hooks are scoped to only one test suite and thus will only have access to operate on the data within that test suite; that is, if an API Hook is generated for Test Suite 1, it may only access the tests and test results associated with Test Suite 1. If you wish to interact with tests in multiple test suites, you will need to generate an API hook for each Test Suite.

API Hooks are protected and require an API Key and Secret to be used. You can find out how to create a API Key and Secret here.

Prerequisites

  1. Your account must have administrators or Test Organization manager privileges.
  2. You must have at least one Test Suite in your Test Organization.

To see a list of all the Test Suites in your Test Organization, navigate to the Main Dashboard by clicking on your Test Organization Name in the menu bar.

Image of test organization name in the menu bar

If there are no Test Suites here, you can create one by clicking the Create Test Suite button after the Test Status chart.

How to create an API Hook

First navigate to the Test Organization settings page by clicking the Cog icon in the menu bar.

Image of cog icon in the menu bar

Within the Test Organization settings page, click the Hooks option under the API Hooks heading in the navigation menu.

Image of hooks option in the test origanization page

Now click on the + API Hook button to begin creating a new API Hook.

As API Hooks are scoped at a Test Suite level, you will need to select the test suite you wish to generate the hook for. Choose the appropiate test suite from the Test Suite dropdown and optionally add a description for the API Hook. Click the confirm Image of check mark icon icon to generate and save the API Hook.

You've now created the API Hook URL for your Test Suite. Make a note of this this URL as this will form the base path of all future API requests you make to to this test suite.

Close the Hook URL dialog box. You can see that your new API Hook is now in the list of API Hooks. You can click on this at anytime to view the URL again in the future should you need. Note that this URL will remain active until it is deleted. To delete the API Hook, simply click on the Delete icon next to the API Hook you want to remove.

In order to use your new API Hook, you need to ensure you have an API Key and Secret for your Test Organization. Steps do do this can be found here. Alternatively, if your Key and Secret is set up, see Using API Hooks for more information on how to use the API Hook.

What to do next