Documentation
Guide to connecting repositories, generating API keys, and sending CI test results to Qably based on the public API contract.
How Qably works
Qably centralizes QA tracking for engineering teams. The platform does not execute tests directly. Instead, external CI pipelines run the test suites and push results to Qably over HTTP. Qably stores the incoming data and provides a single view of test history, suites, and repository changes.
Two independent pipelines
Qably operates two decoupled data pipelines. Setting up one pipeline does not configure the other, which is the most frequent reason a screen appears empty.
| Pipeline | Endpoint | Credential | Fills |
|---|---|---|---|
| Test results | POST /runs/ingest | Project API key in Authorization: Bearer | Suites, cases, and runs shown on the main dashboard |
| Code changes | POST /webhooks/scm/:provider | HMAC signature (no API key) | Code changes, ingestion batches, and traceability on the Repository page |
Your CI runs the tests and produces a JUnit XML or JSON report. It sends the report to the Qably ingest API with a project API key. Qably stores the runs and their cases and shows them on the dashboard and in notifications. Qably never runs the tests.
- Your CI: Runs the tests
- Your CI: JUnit XML or JSON report. Then: API key
- Qably: Ingest API - POST /runs/ingest and /runs/ingest/junit
- Qably: Runs and cases
- Qably: Dashboard and notifications
A push or pull request on GitHub sends a webhook signed with HMAC to the Qably webhook endpoint. Qably stores the delivery as an ingestion batch with its commits and changed files, and shows it in the Repository view and as candidate commits on run comparisons.
- Your repository: Push or pull request on GitHub. Then: HMAC signature
- Qably: Webhook endpoint - POST /webhooks/scm/:provider
- Qably: Ingestion batches - Commits and changed files
- Qably: Repository view - And the candidate commit range on run comparisons
commitSha.Important: A CI reporter sending test results never populates the Repository page, and connecting a repository never records test runs. If a screen shows no data, verify which pipeline feeds that specific view.
Prerequisites
- A Qably account with at least one active organization.
- A repository hosted on GitHub, the only repository provider supported today.
- A CI pipeline capable of running tests and making HTTP requests upon completion.