Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.

Commit 3b1e424

Browse files
committed
feat: more small fixes for Multistep check facelift
1 parent 0e61487 commit 3b1e424

1 file changed

Lines changed: 6 additions & 7 deletions

File tree

site/content/docs/multistep-checks/_index.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ Make multiple API calls in sequence with Multistep checks. Monitor complete API
1919
![Multistep check overview page](/docs/images/multistep-api-checks/multistep-check-overview.png)
2020

2121
This guide gives you all the info to create your first Multistep check with Checkly. You should have some prior
22-
knowledge of working with JavaScript and/or Node.js.
22+
knowledge of working with JavaScript/TypeScript and/or Node.js.
2323

2424
## What is a Multistep check?
2525

26-
Multistep checks enable you to write Node.js scripts that can run multiple API requests in sequence. They allow you to monitor entire API user flows with a single check. Make requests, parse response data and perform more requests to mimic and test API user behavior. Multistep checks ensure that combined API interactions lead to the correct results.
26+
Multistep checks enable you to write Node.js Playwright scripts that can run multiple API requests in sequence. They allow you to monitor entire API user flows with a single check. Make requests, parse response data and perform more requests to mimic and test API user behavior. Multistep checks ensure that combined API interactions lead to the correct results.
2727

2828
Examples of API sequences might be:
2929

@@ -77,7 +77,7 @@ Let's look at the code above step-by-step.
7777

7878
**1. Initial declarations:** To run any Multistep check, import the Playwright test framework.
7979

80-
**2. Define our headers:** In many cases you will have to authenticate when requesting data by providing authorization headers. Use [environment variables](/docs/browser-checks/variables/) to avoid having any confidential data in our test.
80+
**2. Define our headers:** In many cases, you will have to authenticate when requesting data by providing authorization headers. Use [environment variables](/docs/browser-checks/variables/) to avoid having any confidential data in your test.
8181

8282
**3. Establish environment:** Create a new test and leverage the Playwright `request` fixture to make API requests in the test steps.
8383

@@ -86,7 +86,7 @@ Let's look at the code above step-by-step.
8686
>[!NOTE]
8787
> Always use `await` before `test.step`, otherwise the test will fail.
8888
89-
**5. Define our assertion:** Use the `expect(response)` method to assert if the response was successful (the response code is in the range of 200 - 299) with `toBeOK()`. Should the request return anything outside of the 'OK' range, this will cause the check to fail and in a production scenario trigger any configured alerts.
89+
**5. Define our assertion:** Use the `expect(response)` method to assert if the response was successful (the response code is in the range of 200 - 299) with `toBeOK()`. Should the request return anything outside of the 'OK' range, the check will fail and in a production scenario, trigger any configured alerts.
9090

9191
**6. Return the response for future usage:** Return the request response in JSON format, so we can use it in the next test step.
9292

@@ -174,8 +174,7 @@ You can run your check as an [E2E test](/docs/testing) locally or from your CI/C
174174

175175
## Built-in runtime variables
176176

177-
The Multistep check [runtime](/docs/runtimes/) exposes a set of environment variables (e.g. `process.env.CHECK_NAME`)
178-
to figure out what check, check type etc. you are running.
177+
The Multistep check [runtime](/docs/runtimes/) exposes a set of environment variables (e.g. `process.env.CHECK_NAME`) that indicate what check, check type etc. you are running.
179178

180179
{{< markdownpartial "/_shared/runtime-env-vars.md" >}}
181180

@@ -186,7 +185,7 @@ As with Browser checks, Checkly runs Multistep checks for a maximum of 240s. Scr
186185

187186
The [Checkly CLI](/docs/cli/) gives you a JavaScript/TypeScript-native workflow for coding, testing and deploying synthetic monitoring at scale, from your code base.
188187

189-
You can define a Multistep check via the CLI. Unlike Browser checks, Multistep checks always need to be defined in a construct before assigning a `spec.js|ts` file. For example:
188+
You can define a Multistep check via the CLI. Unlike Browser checks, Multistep checks always need to be defined in a construct. For example:
190189

191190
{{< tabs "CLI example" >}}
192191
{{< tab "TypeScript" >}}

0 commit comments

Comments
 (0)