Docs

What is Canary?

A clear overview of what Canary does and how teams use it day to day.

Getting started

The core objects you’ll see across the app: properties, pages, runs, issues, and flows.

Common questions about setting up and using Canary.

Definitions for common Canary terms.

Get to your first crawl, run, and issue review.

Guides

Building your first smoke suite

Create a small “must-pass” set of flows you can run before every release.

CI/CD Integration

Run your workflow tests automatically in CI/CD pipelines using the Canary CLI.

Designing a good test

Write workflows that read like a person, stay reliable, and fail with clarity.

Running tests with the CLI

Install the Canary CLI, authenticate, and run your workflow tests from the terminal.

Running your first QA audit

Run a comprehensive, structured QA run that tests every page’s elements with happy-path and negative tests.

Testing Private Environments

Run Canary tests against staging apps behind a VPN or private network using our AWS integration.

Integrations

Connect Jira to sync requirements and file issues.

Connect Slack to receive alerts about automation results and test failures directly in your workspace.

Reference

Inspect captured API calls observed during QA runs.

Create and manage API keys for CLI and CI/CD authentication.

Upload and manage supporting artifacts (images, PDFs) used across QA.

How auth works across the web app, API, and docs connect.

Product changes and release notes.

Autonomous AI-powered exploratory testing.

Discover pages and build your test surface area.

Credentials and Login

Authenticate Canary so it can test logged-in areas of your app.

Use the in-app assistant to find and summarize documentation.

How the public docs site works (MDX + optional SSO connect).

Use exploratory runs to discover issues and improve coverage.

Build repeatable user journeys in the Flow Designer.

Triage, categorize, and track problems found by Canary.

Limits and Rate Limiting

Operational limits that keep crawls and runs safe and predictable.

Macros & Variables

Generate dynamic test data with macros and reference shared values with workflow variables.

Organizations and Permissions

Invite teammates and manage access controls.

Understand discovered pages, canonical grouping, and QA status.

Create, manage, and scope what Canary tests.

Connect requirements to flows and issues to keep QA aligned with product intent.

Execute QA runs and interpret results.

Security and Privacy

How Canary handles credentials, artifacts, and sensitive data.

Configure organization and user settings.

Execute all published workflows as regression tests.

Troubleshooting

Common setup problems and how to fix them.

VPC Environments

Run E2E tests against internal endpoints inside your AWS VPC.

Other

Coming soon