Skip to main content
Use the API when the pipeline is not GitHub Actions, GitLab CI, or Bitrise. Bitbucket, Azure DevOps, CircleCI, Jenkins, and any other system that can send an HTTPS request can start the same review.

​
Set it up

Start a change review

POST /v1/chat/change-review with mode: "pr" and the request URL.

Mobile build

Upload the build first, then pass applicationBuildShortId.

Post on GitHub

Install the GitHub App so the agent can read the diff and post the review.

Post on GitLab

Connect the repository under Settings → Integrations → GitLab.
Create the API key and find the IDs on Other CI (API). Without the GitHub App or the GitLab connection, the API cannot read the diff or write the review. A test plan run does not need either. See the regression API.

​
What works over the API

​
What this does not do

  • It does not replace the GitHub App or the GitLab connection. Those are what allow the review to be posted.
  • It does not schedule runs. Schedules belong on a test plan.
  • Envoyer is not a substitute. Envoyer cannot start a change review.