Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v2/check-sessions/{checkSessionId}/completion
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/check-sessions/{checkSessionId}/completion
---
deprecated: true
---
9 changes: 9 additions & 0 deletions api-reference/check-sessions/cancel-a-check-session.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
openapi: post /v1/check-sessions/{checkSessionId}/cancel
title: Cancel a check session
sidebarTitle: Cancel a check session
---

Check sessions are started by the UI "Schedule now" button and `checkly deploy`.

See [Cancellation](/concepts/cancellation) for how cancelled runs affect alerts, metrics, and the `CANCELLED` session status.
3 changes: 3 additions & 0 deletions api-reference/check-sessions/retrieve-a-check-session-v2.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v2/check-sessions/{checkSessionId}
---
3 changes: 2 additions & 1 deletion api-reference/check-sessions/retrieve-a-check-session.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/check-sessions/{checkSessionId}
---
deprecated: true
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v2/check-sessions/trigger
---
3 changes: 2 additions & 1 deletion api-reference/check-sessions/trigger-a-new-check-session.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: post /v1/check-sessions/trigger
---
deprecated: true
---
9 changes: 9 additions & 0 deletions api-reference/test-sessions/cancel-a-test-session.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
openapi: post /v1/test-sessions/{testSessionId}/cancel
title: Cancel a test session
sidebarTitle: Cancel a test session
---

Test sessions are recorded with `checkly test`, `checkly trigger`, and `checkly pw-test`. Cancellation applies only to the session's Playwright Check Suite runs — any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs continue until they finish normally.

See [Cancellation](/concepts/cancellation) for how cancelled runs affect alerts, metrics, and the `CANCELLED` session status.
23 changes: 23 additions & 0 deletions cli/checkly-pw-test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Define `checkly pw-test` specific options before the `--` separator:
|--------|----------|-------------|
| `--config` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. |
| `--create-check` | - | Create a Checkly check from the Playwright test. |
| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C, instead of cancelling the run. |
| `--env, -e` | - | Env vars to be passed to the test run. Default: [] |
| `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` |
| `--include, -i` | - | File patterns to include when bundling the test project (e.g., `"utils/**/*"`). Can be repeated. |
Expand Down Expand Up @@ -125,6 +126,18 @@ const config = defineConfig({

</ResponseField>

<ResponseField name="--detach, -d" type="boolean" default="false">

By default, pressing <kbd>Ctrl</kbd>+<kbd>C</kbd> during a `pw-test` run cancels the recorded test session. With `--detach`, <kbd>Ctrl</kbd>+<kbd>C</kbd> exits the CLI immediately instead, leaving the checks running in the cloud.

**Usage:**

```bash Terminal
npx checkly pw-test --detach
```

</ResponseField>

<ResponseField name="--env, -e" type="string[]">

Pass environment variables to the test run. Can be specified multiple times to set multiple variables.
Expand Down Expand Up @@ -432,6 +445,16 @@ npx checkly pw-test -- test.spec.ts
- Test sessions are recorded by default with full logs, traces, and videos
- View all artifacts in Checkly's UI

## Cancelling a run

<Note>Available in CLI v8.0.0+.</Note>

Cancellation is available only for recorded test sessions.

Press <kbd>Ctrl</kbd>+<kbd>C</kbd> during a `checkly pw-test` run to cancel the test session. The CLI keeps running to report the cancelled results; press <kbd>Ctrl</kbd>+<kbd>C</kbd> again to exit immediately without waiting. Pass the `--detach` flag to keep the checks running in the cloud instead — <kbd>Ctrl</kbd>+<kbd>C</kbd> then exits the CLI immediately without cancelling.

See [Cancellation](/concepts/cancellation) for the full flow.

## Related Commands

- [`checkly test`](/cli/checkly-test) - Test your setup before deployment
Expand Down
38 changes: 33 additions & 5 deletions cli/checkly-test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,19 @@ npx checkly test [arguments] [options]
| Option | Required | Description |
|--------|----------|-------------|
| `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. |
| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C, instead of cancelling the run. |
| `--env, -e` | - | Env vars to be passed to the test run. Can be used multiple times. |
| `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` |
| `--grep, -g` | - | Only run checks where the check name matches a regular expression. Default: `.*` |
| `--list` | - | List all checks but don't run them. |
| `--location, -l` | - | The location to run the checks at. |
| `--private-location` | - | The private location to run checks at. |
| `--record` | - | Record test session results in Checkly with full logs, traces and videos. |
| `--[no-]record` | - | Record test session results in Checkly with full logs, traces and videos. Records by default since CLI v8.0.0. |
| `--refresh-cache` | - | Force a fresh install of dependencies and update the cached version. |
| `--reporter, -r` | - | One or more custom reporters for the test output. Supports comma-separated values and repeated flags. |
| `--retries` | - | How many times to retry a failing test run. |
| `--tags, -t` | - | Filter the checks to be run using a comma separated list of tags. |
| `--test-session-name, -n` | - | A name to use when storing results in Checkly with `--record`. |
| `--test-session-name, -n` | - | A name to use when recording results in Checkly. |
| `--timeout` | - | A timeout (in seconds) to wait for checks to complete. |
| `--update-snapshots, -u` | - | Update any snapshots using the actual result of this test run. |
| `--verbose, -v` | - | Always show the full logs of the checks. |
Expand All @@ -53,6 +54,18 @@ npx checkly test -c="./checkly.staging.config.ts"

</ResponseField>

<ResponseField name="--detach, -d" type="boolean" default="false">

By default, pressing <kbd>Ctrl</kbd>+<kbd>C</kbd> during a recorded run cancels the test session. With `--detach`, <kbd>Ctrl</kbd>+<kbd>C</kbd> exits the CLI immediately instead, leaving the checks running in the cloud.

**Usage:**

```bash Terminal
npx checkly test --detach
```

</ResponseField>

<ResponseField name="--env, -e" type="string[]">

[Environment variables](/cli/environment-variables) to be passed to the test run. Can be used multiple times.
Expand Down Expand Up @@ -228,14 +241,17 @@ npx checkly test -r github -r json

</ResponseField>

<ResponseField name="--record" type="boolean">
<ResponseField name="--[no-]record" type="boolean" default="true">

Record test results in Checkly as [a test session](/detect/testing/overview) with full logs, traces and videos. Recording is enabled by default; use `--no-record` to disable it.

Record test results in Checkly as [a test session](/detect/testing/overview) with full logs, traces and videos.
<Note>Recording defaults to enabled since CLI v8.0.0. In earlier versions, recording was opt-in via `--record`.</Note>

**Usage:**

```bash Terminal
npx checkly test --record
npx checkly test --no-record
npx checkly test --record --test-session-name="CI Build #123"
```

Expand Down Expand Up @@ -280,7 +296,7 @@ npx checkly test --retries 3

<ResponseField name="--test-session-name, -n" type="string">

A name to use when storing results in Checkly with `--record`.
A name to use when recording results in Checkly.

**Usage:**

Expand Down Expand Up @@ -380,6 +396,18 @@ Specify [environment variables](/cli/environment-variables) to dry run checks wi
npx checkly test --env ENVIRONMENT_URL="https://preview.acme.com" --env PASSWORD=doremiabc123
```

## Cancelling a run

<Note>Available in CLI v8.0.0+.</Note>

`checkly test` records a test session by default, so pressing <kbd>Ctrl</kbd>+<kbd>C</kbd> cancels it. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. Runs started with `--no-record` cannot be cancelled.

The CLI keeps running after the first <kbd>Ctrl</kbd>+<kbd>C</kbd> to report the cancelled results. Press <kbd>Ctrl</kbd>+<kbd>C</kbd> again to exit immediately without waiting.

Pass the `--detach` flag to keep the checks running in the cloud instead — <kbd>Ctrl</kbd>+<kbd>C</kbd> then exits the CLI immediately without cancelling.

See [Cancellation](/concepts/cancellation) for the full flow.

## Related Commands

- [`checkly pw-test`](/cli/checkly-pw-test) - Run Playwright tests in the Checkly cloud
Expand Down
46 changes: 37 additions & 9 deletions cli/checkly-trigger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,18 @@ npx checkly trigger [options]
| Option | Required | Description |
|--------|----------|-------------|
| `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. |
| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C, instead of cancelling the run. |
| `--env, -e` | - | Env vars to be passed to the check run. Default: empty. Multiple values can be passed. |
| `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` |
| `--fail-on-no-matching` | - | Exit with a failing status code when there are no matching tests. |
| `--location, -l` | - | The location to run the checks at. |
| `--private-location` | - | The private location to run checks at. |
| `--record` | - | Record test session results in Checkly with full logs, traces and videos. |
| `--[no-]record` | - | Record test session results in Checkly with full logs, traces and videos. Records by default since CLI v8.0.0. |
| `--refresh-cache` | - | Force a fresh install of dependencies and update the cached version. |
| `--reporter, -r` | - | One or more custom reporters for the test output. Supports comma-separated values and repeated flags. |
| `--retries` | - | How many times to retry a check run. |
| `--tags, -t` | - | Filter the checks to be run using a comma separated list of tags. |
| `--test-session-name, -n` | - | A name to use when storing results in Checkly with `--record`. |
| `--test-session-name, -n` | - | A name to use when recording results in Checkly. |
| `--timeout` | - | A timeout (in seconds) to wait for checks to complete. |
| `--verbose, -v` | - | Always show the full logs of the checks. |

Expand All @@ -50,6 +51,18 @@ npx checkly trigger -c="./checkly.staging.config.ts"

</ResponseField>

<ResponseField name="--detach, -d" type="boolean" default="false">

By default, pressing <kbd>Ctrl</kbd>+<kbd>C</kbd> during a recorded run cancels the test session. With `--detach`, <kbd>Ctrl</kbd>+<kbd>C</kbd> exits the CLI immediately instead, leaving the checks running in the cloud.

**Usage:**

```bash Terminal
npx checkly trigger --detach
```

</ResponseField>

<ResponseField name="--env, -e" type="string[]">

[Environment variables](/cli/environment-variables) to be passed to the check run. Multiple values can be passed and passed variables overwrite any existing variables stored in your Checkly account.
Expand Down Expand Up @@ -168,7 +181,7 @@ Tags are comma-separated within a single flag for AND logic, multiple flags for

<ResponseField name="--test-session-name, -n" type="string">

A name to use when storing results in Checkly with `--record`.
A name to use when recording results in Checkly.

**Usage:**

Expand Down Expand Up @@ -259,27 +272,30 @@ npx checkly trigger --no-fail-on-no-matching --tags optional-tag
Enabled by default. Use `--no-fail-on-no-matching` to allow zero matches without failure.
</ResponseField>

<ResponseField name="--record" type="boolean">
<ResponseField name="--[no-]record" type="boolean" default="true">

Record check results in Checkly as a test session with full logs, traces and videos. Recording is enabled by default; use `--no-record` to disable it.

Record check results in Checkly as a test session with full logs, traces and videos.
<Note>Recording defaults to enabled since CLI v8.0.0. In earlier versions, recording was opt-in via `--record`.</Note>

**Usage:**

```bash Terminal
npx checkly trigger --record
npx checkly trigger --no-record
```

**Examples:**

```bash Terminal
# Basic recording
npx checkly trigger --record

# Record with custom name
# Record with a custom session name
npx checkly trigger --record --test-session-name "Deploy validation"

# Record specific checks
npx checkly trigger --record --tags critical

# Run without recording
npx checkly trigger --no-record
```

Records provide full visibility including logs, traces, and videos for debugging failed checks.
Expand Down Expand Up @@ -372,6 +388,18 @@ npx checkly trigger --tags staging --record --test-session-name "Pre-prod valida

<Tip>If your production deployment includes monitoring changes and updates, [use `npx checkly test`](/cli/checkly-test) to validate your preview environment with the updated monitoring configuration.</Tip>

## Cancelling a run

<Note>Available in CLI v8.0.0+.</Note>

`checkly trigger` records a test session by default, so pressing <kbd>Ctrl</kbd>+<kbd>C</kbd> cancels it. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. Runs started with `--no-record` cannot be cancelled.

The CLI keeps running after the first <kbd>Ctrl</kbd>+<kbd>C</kbd> to report the cancelled results. Press <kbd>Ctrl</kbd>+<kbd>C</kbd> again to exit immediately without waiting.

Pass the `--detach` flag to keep the checks running in the cloud instead — <kbd>Ctrl</kbd>+<kbd>C</kbd> then exits the CLI immediately without cancelling.

See [Cancellation](/concepts/cancellation) for the full flow.

## Related Commands

- [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration
Expand Down
6 changes: 5 additions & 1 deletion communicate/alerts/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ Understanding how settings cascade through the hierarchy:

</Note>

<Note>
Runs you [cancel](/concepts/cancellation) never trigger alerts. No failure, degraded, or recovery notification is sent for a cancelled run, regardless of the settings above.
</Note>

## Alert Configuration

### Account-Level
Expand All @@ -70,7 +74,7 @@ Configure alerts for teams and service categories:
![Group-level alert settings](/images/docs/images/alerting/alert-settings-group.png)

<Note>
#### Group Override
### Group Override
Configure how group settings interact with individual checks:

**If checked, Group settings override individual check settings**
Expand Down
Loading