API setup for any CI - QA.tech Docs

Use this page when your CI is not GitHub, GitLab, Bitrise, or Envoyer. Bitbucket Pipelines, Azure DevOps, CircleCI, Jenkins, and any other system that can send an HTTPS request connect the same way.

Pull request testing

Review a pull request over the API.

Regression testing

Run a test plan over the API.

API key setup, the request format, and the IDs you need to start a test plan are on API regression testing. The requests that start a change review are on API pull request testing.

Connect the repository for reviews

A test plan run needs only the API key. A change review also needs the repository connected, so the agent can read the diff and post the review: the GitHub App for GitHub, or GitLab MR reviews for GitLab.

API pull request testing - Start a change review from any CI
API regression testing - Run a test plan from any CI
API Introduction - Authentication, IDs, and the base URL
Start Run API - Request options for test plan runs
Start change review chat API - Request options for change reviews