Using API Hooks

API Hooks provide a mechanism to interact with tests within a Test Suite via an API. Whilst the API Hook itself defines the basepath of this API, it also exposes a series of endpoints which, when appended onto this basepath, allow you to list and execute published tests within the API Hook's scope. The following pages detail these endpoints and subsequent parameters you can provide to either list, execute all, or execute only specific tests within a test suite.

Endpoints

• List All Tests
  Lists all of the published tests within an API Hook's scope.

• Run All Published Tests
  Runs all of the published tests within an API Hook's scope.

• Run Published Tests By Tag
  Runs the published tests within an API Hook's scope that match the tags specified in the request body.

• Run Published Test By ID
  Run a specified test within an API Hook's scope.