Public API
Last updated
Was this helpful?
BugBug Public API lets you run and manage tests from your own tools, scripts, CI/CD pipelines, and internal dashboards.
Use the Public API when you need more control than a simple webhook URL or CLI command can provide.
Keep in mind that Public API access is available on paid plans. More information about pricing can be found here: https://bugbug.io/pricing/
Go to the Integrations page.
Open the API tab.
Copy the project API token.
The API token belongs to a project. Treat it as a secret.
Send the API token in the Authorization header with the Token prefix:
Authorization: Token <api-token>Example:
curl \
-H "Authorization: Token <api-token>" \
"https://api.bugbug.io/v2/tests/"BugBug provides generated API documentation in three formats:
The Public API can be used to create custom integrations for CI/CD systems, internal tools, dashboards, release workflows, and reporting automation.
Common API capabilities include:
listing, creating, updating, and deleting tests
listing, creating, updating, and deleting suites
running tests and suites in the cloud
checking test run and suite run status
retrieving run results
stopping running tests and suites
downloading JUnit reports
managing test groups, steps, and reusable components in API v2
exporting and importing tests or projects as YAML or ZIP files
reading and updating project settings
managing visual regression reference screenshots
Use the Public API when you are building a custom integration and need programmatic control.
Use the Command Line Interface when you want a ready-made command for CI/CD scripts.
Use incoming webhooks when another tool only needs to start a test or suite with one POST request.
Use outgoing webhooks when BugBug should send run events to another system.
Last updated
Was this helpful?
Was this helpful?
