Adding a Playwright Check Suite to a group

On this page

Playwright Check Suites are currently in Alpha. Join the Slack community to get live updates on feature development and get help getting started.

You can define a new group, or associate a Playwright Check Suite to an existing group.

Steps

1. Create a group for your checks

To define a new group, create a group file, for example website-group.check.ts.

website-group.check.ts


import { CheckGroup } from 'checkly/constructs'

export const myGroup = new CheckGroup('production-group', {
  name: 'Production group',
  activated: true,
  muted: false,
  locations: ['us-east-1', 'eu-west-1'],
  tags: ['mac', 'group'],
  environmentVariables: [],
  apiCheckDefaults: {},
  concurrency: 100,
  runParallel: true,
  retryStrategy: RetryStrategyBuilder.linearStrategy({ baseBackoffSeconds: 30, maxRetries: 2, sameRegion: false }),
})

Learn more about using groups to unify checks in Checkly.

2. Associate the group to the check

When specifying your Playwright Check Suite, you can reference the new or existing group, using its name:

checkly.config.ts

import { defineConfig } from 'checkly'

const config = defineConfig({
  logicalId: 'checkly-website',
  projectName: 'checkly-website',
  checks: {
    playwrightConfigPath: './playwright.config.ts',
    playwrightChecks: [
      {
        name: 'checkly-website',
        frequency: 10,
        locations: ['us-east-1',],
        groupName: 'Production group', // use the name of the group you created
      },
    ],
  },
  cli: {
    runLocation: 'us-east-1',
  },
})

export default config

3. Deploy to apply the changes

Terminal

  npx checkly deploy --preview #confirm what will be deployed
  npx checkly deploy  # deploy

You can now see your Playwright Check Suite in your group.

All options available in Playwright Check Suites

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