table of contents Table of contents
Docs / Groups / Variables
CLI Enabled

Environment variables and secrets

On this page

You can set both variables and secrets for a Group of checks.

For browser and multistep checks, you can set variables at the check level. See browser check variables and secrets for more details.

Note that for browser checks, secrets are only hidden in the Checkly native UI, not in any generated Playwright artifacts, such as Traces, Screenshots or Videos.
Secrets are available for Private Locations on agent version 3.3.4 and later. Secrets are available on CLI version 4.9.0 and later.

Variable hierarchy

As checks are scheduled, Checkly merges the check, group and global environment variables into one data set and exposes them to the runtime environment. During merging, any check variable with the same name as a global or group variable overrides that variable.

Or, in other words: check variables trump group variables trump global variables.

You can make use of this by providing a default value for a specific variable at the global or group level, but allow that variable to be overridden at the group level or check level.

next API check defaults

Last updated on October 2, 2024. You can contribute to this documentation by editing this page on Github