Running via API

BugBug can be connected to CI/CD pipelines, deployment tools, and custom systems through Public API, CLI, or incoming webhooks.

Use this page to choose the right option. No need to over-engineer a webhook when a CLI command does the job.

Public API

Use the Public API when you are building a custom integration and need programmatic control.

The Public API can list and manage tests and suites, start runs, check statuses, retrieve results, stop runs, download reports, export/import data, update settings, and manage visual regression reference screenshots.

Swagger and Redoc

BugBug provides generated API documentation in two formats:

Swagger: https://api.bugbug.io/docs/swagger/?version=v2
Redoc: https://api.bugbug.io/docs/redoc/?version=v2

Authenticate requests with:

Authorization: Token <api-token>

You can find your project API token in the Integrations page in the BugBug app.

Command Line Interface

Use CLI when you need to run BugBug tests from CI/CD without writing a custom integration.

Incoming webhooks

Use incoming webhooks when another tool only needs to trigger a test or suite with a single POST request.