Onboard your Playwright test suite

Use your existing Playwright tests as live, scheduled monitoring checks. No rewrites required. Define what to monitor using code, selecting the right tags and projects, and run your checks globally, using the Checkly CLI.

A Playwright Check Suite lets you use your existing Playwright tests and projects for end-to-end monitoring with tailored monitoring strategies.

You can mix and match existing projects (pwProjects) and test tags (pwTags) to select tests and group subsets into Playwright Check Suites. This approach allows you to specify different monitoring settings for each Playwright Check Suite to differenciate between smoke tests or critical path flows.

Here’s how to get from zero to deployed checks in 5 minutes.

What you need:

• A checkly account
• A repository using Playwright for E2E tests and a Playwright configuration file.

npm install --save-dev checkly

If you’re using TypeScript, install the dev dependencies jiti and typescript. These help the CLI bundle your typescript config and test files correctly.

npm install --save-dev jiti typescript

Create a checkly.config.ts/js and pick the tests you want to monitor, use test tags and projects to create a Playwright Check Suite.

Make sure:

• pwProjects match projects names in your playwright.config.ts.
• pwTags match tags in your test definitions.

Below are two example check suites:

• a full multi-browser suite with smoke tests.
• a chromium-only check suite running tests tagged with @critical.

import { defineConfig } from 'checkly'
import { Frequency } from 'checkly/constructs'

export default defineConfig({
  projectName: 'Cool Website Checks',
  logicalId: 'cool-website-monitoring',
  repoUrl: 'https://github.com/acme/website',
  checks: {
    playwrightConfigPath: './playwright.config.ts',
    playwrightChecks: [
      {
        /**
         * Create a multi-browser check that runs
         * every 10 mins in two locations.
         */
        logicalId: 'multi-browser',
        name: 'Multi Browser Suite',
        // Use one project (or multiple projects) defined in your Playwright config
        pwProjects: ['chromium', 'firefox', 'webkit'],
        // Use one tag (or multiple tags) defined in your spec files
        pwTags: '@smoke-tests',
        frequency: Frequency.EVERY_10M,
        locations: ['us-east-1', 'eu-west-1'],
      },
      {
        /**
         * Create a check that runs the `@critical` tagged tests
         * every 5 mins in three locations.
         */
        logicalId: 'critical-tagged',
        name: 'Critical Tagged tests',
        // Use one project (or multiple projects) defined in your Playwright config
        pwProjects: ['chromium'],
        // Use one tag (or multiple tags) defined in your spec files
        pwTags: '@critical',
        frequency: Frequency.EVERY_5M,
        locations: ['us-east-1', 'eu-central-1', 'ap-southeast-2'],
      },
    ],
  },
  cli: {
    runLocation: 'us-east-1',
    retries: 0,
  },
})

Access the Playwright Check Suites reference documentation for more configuration options.

Validate the Playwright check suites that reference existing Playwright tags or projects in your repository by running npx checkly test from your terminal. Your Playwright check suites will then be executed in the Checkly infrastructure running in the location specified in your Checkly config (cli.runLocation).

npx checkly test --record
> Running 2 checks in eu-west-1.

  critical-tagged
    ✔ critical-tagged (4s)
  multi-browser
    ✔ multi-browser (18s)

2 passed, 2 total

If you you want to persist the test results and access them in the Checkly web app, use the --record CLI option and run npx checkly test --record to transform your test runs into a Checkly test session.

npx checkly test --record
> Running 2 checks in eu-west-1.

  critical-tagged
    ✔ critical-tagged (4s)
  multi-browser
    ✔ multi-browser (18s)

2 passed, 2 total
Detailed session summary at: https://chkly.link/...

The CLI command will then return a link leading to results, traces and more details.

If your Playwright monitoring passes and you are ready to start monitoring your applications with your Playwright tests, transform your Playwright Check Suite into global monitoring with npx checkly deploy.

npx checkly deploy

> You are about to deploy your project "playwright-check-suites" to account "Checkly E2E Prod". Do you want to continue? … yes

Successfully deployed project "playwright-check-suite" to account "Checkly E2E Prod".

Once deployed, your checks will run on a schedule and results will appear in your home dashboard.

Configure alert channels and alert groups to get notified when checks fail. You can receive alerts via email, Slack, webhooks, and more.

To set up alerts:

1. Go to the Checkly dashboard.
2. Navigate to Alert Settings > Alert Channels to create a new channel.
3. Assign channels to your project or individual checks.

Learn more in the alerting guide.

And all done!

• Explore advanced configuration like private locations and environment variables.
• Add or tweak your checks to monitor flows in different browsers or locations.
• Set up alerting and integrations with your incident response tools
• Add TCP and API monitors alongside your Playwright Check Suites.

Last updated on July 3, 2025. You can contribute to this documentation by editing this page on Github