Docs
API 1.39
Status
Actions

checkpoint

The `checkpoint` step.

Saves the page URL, variables and browser state so a parked or resumed job can return here. The string form is the checkpoint's name.

Type: string or object

#Keys

KeyTypeDescription
checkpoint.namestringThe checkpoint's name, such as logged_in.
checkpoint.save_sessionstringThe name of a session to save the browser's storage state into, which is how a sign-in program creates or refreshes a session.

Every step also takes the common step keys: expect, id, if, name, on_error, optional, retry, side_effect, timeout_ms, x_kaab.

#Example

{
  "id": "save",
  "checkpoint": {
    "name": "logged_in",
    "save_session": "acme"
  }
}

From the contract fixture login-2fa-checkpoint-report, a program the test suite validates.

Was this page helpful?