docs.checklyhq.com

# Checkly Documentation

Important notes:

- Checkly is a synthetic monitoring platform designed for developers and DevOps teams
- Provides API monitoring, browser monitoring with Playwright, and monitoring as code workflows
- Supports monitoring as code through CLI, Terraform, and Pulumi for version-controlled monitoring
- Offers uptime monitoring, alerting, dashboards, and integrations with popular tools
- Built for modern development workflows with CI/CD integration and deployment testing
- Before getting started make sure to understand the project structure
- For backend projects identify all resources which can be tested
- For frontend projects identify all pages and user journeys which can be tested
- Understand the authentication setup for the users app so you can support it
- Store required credentials in Checkly
- Make sure to guide the user when setting up a new project, use the `npm create checkly@latest` command to get started
- To generate the first checks/tests explain the user the available check types and ask them which one they want to use
- Make sure to only use npm packages in scripts which are available in Checkly runtimes, Checkly doesn't support all npm packages
- Never use the imports in the namespace '@checkly'. they are outdated. Always import from 'checkly/constructs'
- Make sure that generated test files names match the patterns set in Checkly config file
- Make sure when using environment variables or secrets to store them in Checkly using Checkly's cli

## Core Platform

### Monitoring
- [How Checkly runs checks](https://www.checklyhq.com/docs/monitoring/): How Checkly runs checks
- [Results](https://www.checklyhq.com/docs/monitoring/check-results/): Check results
- [Global locations](https://www.checklyhq.com/docs/monitoring/global-locations/): Global locations & scheduling strategies
- [Optimizing reliability](https://www.checklyhq.com/docs/monitoring/optimizing-reliability/): Optimizing your monitoring for reliability
- [How we store data](https://www.checklyhq.com/docs/monitoring/how-we-store-data/): How we store data
- [Storing secrets](https://www.checklyhq.com/docs/monitoring/storing-secrets/): Storing secrets
- [Allowlisting traffic](https://www.checklyhq.com/docs/monitoring/allowlisting/): Allowlisting & filtering traffic
- [IP information & versions](https://www.checklyhq.com/docs/monitoring/ip-info/): IP information & versions
- [Responsible use](https://www.checklyhq.com/docs/monitoring/responsible-use/): Responsible use

### Testing
- [Overview](https://www.checklyhq.com/docs/testing/): Getting started with testing in Checkly


### Command Line Interface (CLI)
- [Getting started](https://www.checklyhq.com/docs/cli/): Getting started with the Checkly CLI
- [Installation](https://www.checklyhq.com/docs/cli/installation/): Installing the Checkly CLI
- [Project structure](https://www.checklyhq.com/docs/cli/project-structure/): Structuring your project in Checkly
- [Using `checkMatch` and `testMatch`](https://www.checklyhq.com/docs/cli/using-check-test-match/): Using `checkMatch` and `testMatch`
- [Using Constructs](https://www.checklyhq.com/docs/cli/using-constructs/): Using Constructs
- [Environment variables](https://www.checklyhq.com/docs/cli/using-environment-variables/): Using environment variables
- [Dynamic monitor creation](https://www.checklyhq.com/docs/cli/dynamic-check-creation/): Dynamic monitor creation
- [Using Git](https://www.checklyhq.com/docs/cli/using-git/): Using git metadata
- [NPM packages & local dependencies](https://www.checklyhq.com/docs/cli/npm-packages/): Using NPM packages and local dependencies
- [Importing existing resources](https://www.checklyhq.com/docs/cli/import/): Importing your account with the Checkly CLI
- [CLI vs. Terraform & Pulumi - Checkly Docs](https://www.checklyhq.com/docs/cli/cli-vs-terraform-pulumi/): CLI vs. Terraform & Pulumi
- [Constructs Reference](https://www.checklyhq.com/docs/cli/constructs-reference/): Constructs Reference
- [Command Line Reference](https://www.checklyhq.com/docs/cli/command-line-reference/): Command Line Reference

### Traces & OpenTelemetry
- [Getting started](https://www.checklyhq.com/docs/traces-open-telemetry/): Getting started with Checkly Traces and OpenTelemetry
- [How it works](https://www.checklyhq.com/docs/traces-open-telemetry/how-it-works/): Understand Checkly Traces and OpenTelemetry

## Resources

### API Checks
- [Overview](https://www.checklyhq.com/docs/api-checks/): Getting started with API checks
- [HTTP request settings](https://www.checklyhq.com/docs/api-checks/request-settings/): HTTP request settings
- [Variables and secrets](https://www.checklyhq.com/docs/api-checks/variables/): Variables and secrets
- [API Assertions](https://www.checklyhq.com/docs/api-checks/assertions/): Writing assertions for API checks
- [Response time limits](https://www.checklyhq.com/docs/api-checks/limits/): API Response time limits
- [Setup & teardown scripts](https://www.checklyhq.com/docs/api-checks/setup-teardown-scripts/): API setup & teardown scripts
- [Setup script examples](https://www.checklyhq.com/docs/api-checks/setup-script-examples/): API setup script examples
- [Teardown script examples](https://www.checklyhq.com/docs/api-checks/teardown-script-examples/): API teardown script examples
- [Timeouts and timing phases](https://www.checklyhq.com/docs/api-checks/timeouts-timing/): API timeouts and timing phases
- [Client certificates](https://www.checklyhq.com/docs/api-checks/client-certificates/): Client certificates

### Browser Checks
- [Overview](https://www.checklyhq.com/docs/browser-checks/): Getting started with Browser monitoring
- [Using Playwright Test Runner](https://www.checklyhq.com/docs/browser-checks/playwright-test/): How to use Playwright Test Runner natively within browser checks at Checkly
- [Scraping on page elements](https://www.checklyhq.com/docs/browser-checks/scraping-onpage-elements/): How to scrape web page elements like texts, buttons and forms with Google Chrome and Playwright Test.
- [Screenshots](https://www.checklyhq.com/docs/browser-checks/screenshots/): Taking screenshots
- [File system](https://www.checklyhq.com/docs/browser-checks/file-system/): File uploads, downloads and the file system
- [Login scenarios](https://www.checklyhq.com/docs/browser-checks/login-scenarios/): Monitoring a login scenario with browser checks
- [Variables and secrets](https://www.checklyhq.com/docs/browser-checks/variables/): Handling variables and secrets
- [Multiple tabs](https://www.checklyhq.com/docs/browser-checks/multiple-tabs/): Monitoring a scenario with multiple tabs
- [Timeouts](https://www.checklyhq.com/docs/browser-checks/timeouts/): Timeouts
- [Tracing and Web Vitals](https://www.checklyhq.com/docs/browser-checks/tracing-web-vitals/): Tracing and Web Vitals
- [Visual regression & snapshot testing](https://www.checklyhq.com/docs/browser-checks/visual-regression-snapshot-testing/): Visual regression & snapshot testing
- [Degraded state](https://www.checklyhq.com/docs/browser-checks/degraded-state/): Degraded state with soft assertions

### Heartbeat Monitors
- [Overview](https://www.checklyhq.com/docs/heartbeat-monitors/): Getting started with Heartbeat monitors
- [Ping examples](https://www.checklyhq.com/docs/heartbeat-monitors/ping-examples/): Ping examples

### URL Monitors
- [Overview](https://www.checklyhq.com/docs/url-monitors/): Run HTTP health checks with URL monitors

### Multistep Checks
- [Overview](https://www.checklyhq.com/docs/multistep-checks/): Getting started with Multistep API Checks
- [Degraded state](https://www.checklyhq.com/docs/multistep-checks/degraded-state/): Degraded state with soft assertions on Multistep checks
- [File uploads, downloads and the file system](https://www.checklyhq.com/docs/multistep-checks/upload-downloads-filesystem/): File uploads, downloads and the file system
- [WebSockets](https://www.checklyhq.com/docs/multistep-checks/websockets/): WebSockets on Multistep checks
- [Examples](https://www.checklyhq.com/docs/multistep-checks/example-checks/): Multistep check examples

### TCP Monitors
- [Overview](https://www.checklyhq.com/docs/tcp-monitors/): Monitoring your services with TCP monitors

### Playwright Check Suites
- [Overview](https://www.checklyhq.com/docs/playwright-checks/): Onboard your Playwright test suite
- [Custom dependencies](https://www.checklyhq.com/docs/playwright-checks/custom-dependencies/): Using custom dependencies in Playwright Check Suites
- [Reference](https://www.checklyhq.com/docs/playwright-checks/reference/): All options available in Playwright Check Suites
- [Add to a group](https://www.checklyhq.com/docs/playwright-checks/groups-usage/): Adding a Playwright Check Suite to a group

### Groups
- [Overview](https://www.checklyhq.com/docs/groups/): Organizing checks with groups
- [API check defaults](https://www.checklyhq.com/docs/groups/api-check-defaults/): API check defaults
- [Variables](https://www.checklyhq.com/docs/groups/variables/): Environment variables and secrets at the Group level

### Alerting & Retries
- [Overview](https://www.checklyhq.com/docs/alerting-and-retries/): Alerting and retries with Checkly
- [Alert settings](https://www.checklyhq.com/docs/alerting-and-retries/alert-settings/): Alert settings in Checkly
- [Alert channels](https://www.checklyhq.com/docs/alerting-and-retries/alert-channels/): Available alerting channels in Checkly
- [Custom Alerts](https://www.checklyhq.com/docs/alerting-and-retries/custom-alerts/): Custom Alerts in Checkly
- [Retries](https://www.checklyhq.com/docs/alerting-and-retries/retries/): Retrying failed checks in Checkly
- [SSL Cert expiration](https://www.checklyhq.com/docs/alerting-and-retries/ssl-expiration/): Monitoring SSL certificate expiration in Checkly
- [Alert states](https://www.checklyhq.com/docs/alerting-and-retries/alert-states/): Alert states in Checkly
- [SMS](https://www.checklyhq.com/docs/alerting-and-retries/sms-delivery/): Alerting with SMS in Checkly
- [Phone Calls](https://www.checklyhq.com/docs/alerting-and-retries/phone-calls/): Alerting with phone calls in Checkly
- [Webhooks](https://www.checklyhq.com/docs/alerting-and-retries/webhooks/): Alerting with webhooks in Checkly
- [Alert notification log](https://www.checklyhq.com/docs/alerting-and-retries/alert-notification-log/): Alert notification log in Checkly

### Maintenance Windows
- [Overview](https://www.checklyhq.com/docs/maintenance-windows/): Setting Maintenance Windows

### Dashboards
- [Overview](https://www.checklyhq.com/docs/dashboards/): Checkly Dashboards
- [Customization](https://www.checklyhq.com/docs/dashboards/dashboard-customization/): Customizing your dashboard
- [Private Dashboards](https://www.checklyhq.com/docs/dashboards/authentication/): Creating Private Dashboards
- [Custom CSS](https://www.checklyhq.com/docs/dashboards/custom-css/): Customizing Your Dashboard with Custom CSS
- [Incidents](https://www.checklyhq.com/docs/dashboards/incidents/): Incident & Maintenance messages

### Status Pages
- [Overview](https://www.checklyhq.com/docs/status-pages/): Checkly Status Pages
- [Incidents](https://www.checklyhq.com/docs/status-pages/incidents/): Incidents

### Accounts & Users
- [About Roles in Checkly - Checkly Docs](https://www.checklyhq.com/docs/accounts-and-users/): About Roles in Checkly
- [Adding team members](https://www.checklyhq.com/docs/accounts-and-users/adding-team-members/): Adding team members to your Checkly account
- [Changing email or password](https://www.checklyhq.com/docs/accounts-and-users/changing-your-email-password/): Changing your email or password in Checkly
- [Multi-Factor Authentication](https://www.checklyhq.com/docs/accounts-and-users/multi-factor-authentication/): Multi-Factor Authentication in Checkly
- [Creating an API key](https://www.checklyhq.com/docs/accounts-and-users/creating-api-key/): Creating an API key in Checkly
- [Single Sign-on](https://www.checklyhq.com/docs/accounts-and-users/single-sign-on/): Single Sign-on in Checkly
- [SAML](https://www.checklyhq.com/docs/accounts-and-users/saml/): SAML for Single Sign-on in Checkly
- [Microsoft Azure AD](https://www.checklyhq.com/docs/accounts-and-users/microsoft-azure-ad/): Using Microsoft Azure AD for Single Sign-on in Checkly

### Private Locations
- [Overview](https://www.checklyhq.com/docs/private-locations/): Getting started with Private Locations
- [Checkly Agent Configuration](https://www.checklyhq.com/docs/private-locations/checkly-agent-configuration/): Checkly Agent Configuration
- [Running on Kubernetes](https://www.checklyhq.com/docs/private-locations/running-on-kubernetes/): Running Checkly on Kubernetes
- [Scaling and Redundancy](https://www.checklyhq.com/docs/private-locations/scaling-and-redundancy/): Scaling and Redundancy on Private Locations
- [Using HTTP proxies](https://www.checklyhq.com/docs/private-locations/proxy/): Using HTTP proxies

### Reporting
- [Overview](https://www.checklyhq.com/docs/reporting/): Reporting Dashboard

### Analytics
- [Overview](https://www.checklyhq.com/docs/analytics/)

### Runtimes
- [Overview](https://www.checklyhq.com/docs/runtimes/): How runtimes work
- [Runtime specification](https://www.checklyhq.com/docs/runtimes/specs/): Runtime specification

## Integrations

### Integrations Overview
- [Overview](https://www.checklyhq.com/docs/integrations/): Checkly Integrations
- [Slack](https://www.checklyhq.com/docs/integrations/slack/): Sending Alerts to Slack
- [PagerDuty](https://www.checklyhq.com/docs/integrations/pagerduty/): Learn how Checkly integrates seamlessly with PagerDuty, delivering real-time failure and recovery alerts to your PagerDuty account.
- [Opsgenie](https://www.checklyhq.com/docs/integrations/opsgenie/): Learn how to integrate Checkly with Opsgenie and deliver failure, degradation, and recovery events to any Opsgenie team. Check our guide!
- [Incident.io](https://www.checklyhq.com/docs/integrations/incidentio/): Send Alerts to Incident.io
- [Rootly](https://www.checklyhq.com/docs/integrations/rootly/): Send Alerts to Rootly
- [GitLab Alerts](https://www.checklyhq.com/docs/integrations/gitlab_alerts/): Integrating GitLab Alerts
- [Microsoft Teams](https://www.checklyhq.com/docs/integrations/msteams/): Send Alerts to Microsoft Teams
- [Discord](https://www.checklyhq.com/docs/integrations/discord/): Send Alerts to Discord
- [Telegram](https://www.checklyhq.com/docs/integrations/telegram/): Find out how Checkly integrates with Telegram to send failure, degradation, and recovery messages to any chat.
- [Spike.sh](https://www.checklyhq.com/docs/integrations/spike/): Integrating Spike.sh
- [Splunk On-Call](https://www.checklyhq.com/docs/integrations/splunk_on_call/): Send Alerts via Splunk On-Call
- [StatusPage](https://www.checklyhq.com/docs/integrations/statuspage/): Integrating StatusPage
- [Prometheus V2](https://www.checklyhq.com/docs/integrations/prometheus-v2/): Exporting Metrics & Data via Prometheus V2
- [Prometheus](https://www.checklyhq.com/docs/integrations/prometheus/): Exporting Metrics & Data via Prometheus
- [Pulumi](https://www.checklyhq.com/docs/integrations/pulumi/): Integrating Pulumi with Checkly
- [FireHydrant](https://www.checklyhq.com/docs/integrations/firehydrant/): Send Alerts to FireHydrant
- [Coralogix](https://www.checklyhq.com/docs/integrations/coralogix/): Export Metrics & Data via Coralogix
- [ilert](https://www.checklyhq.com/docs/integrations/ilert/): Send Alerts to ilert

### CI/CD Integration
- [Overview](https://www.checklyhq.com/docs/cicd/): Integrating Checkly in your CI/CD pipeline
- [Vercel Deployment Protection](https://www.checklyhq.com/docs/cicd/vercel-deployment-protection/): Vercel Deployment Protection
- [GitHub Actions](https://www.checklyhq.com/docs/cicd/github-actions/): Integrating Checkly in GitHub Actions
- [Managing Users and Plans with Vercel](https://www.checklyhq.com/docs/cicd/vercel-managing-users-and-plan/): Managing Users and Plans with Vercel
- [Jenkins](https://www.checklyhq.com/docs/cicd/jenkins/): Integrating Checkly in a Jenkins pipeline
- [GitLab CI](https://www.checklyhq.com/docs/cicd/gitlabci/): Integrating Checkly in GitLab CI
- [Vercel](https://www.checklyhq.com/docs/cicd/vercel/): Integrate Checkly with Vercel for app development and deployment to benefit from automated browser checks and production deployment testing.
- [GitHub deployments](https://www.checklyhq.com/docs/cicd/github/): Integrating Checkly with GitHub deployments
- [Command Line triggers](https://www.checklyhq.com/docs/cicd/triggers/): Command Line triggers

### Terraform Provider
- [Overview](https://www.checklyhq.com/docs/terraform-provider/): Getting started with the Terraform provider for Checkly
- [Checks and groups](https://www.checklyhq.com/docs/terraform-provider/checks-groups/): Checks and groups for Terraform
- [Alert channels and settings](https://www.checklyhq.com/docs/terraform-provider/alerting/): Alert channels and settings for Terraform
- [Snippets and environment variables in Terraform - Checkly Docs](https://www.checklyhq.com/docs/terraform-provider/snippets-variables/): Snippets and environment variables in Terraform
- [Dashboards](https://www.checklyhq.com/docs/terraform-provider/dashboards/): Dashboards in Terraform
- [Service maintenance windows](https://www.checklyhq.com/docs/terraform-provider/maintenance-windows/): Service maintenance windows in Terraform
- [Command line triggers](https://www.checklyhq.com/docs/terraform-provider/command-line-triggers/): Command line triggers for Terraform
- [Testing Terraform scripts locally - Checkly Docs](https://www.checklyhq.com/docs/terraform-provider/testing-scripts-locally/): Testing Terraform scripts locally
- [Parameterized resources in Terraform - Checkly Docs](https://www.checklyhq.com/docs/terraform-provider/parameterized-resources/): Parameterized resources in Terraform
- [CI/CD pipelines](https://www.checklyhq.com/docs/terraform-provider/ci-cd/): CI/CD pipelines for Terraform
- [Common issues](https://www.checklyhq.com/docs/terraform-provider/troubleshooting/): Common issues with the Terraform provider

### Pulumi Provider
- [Overview](https://www.checklyhq.com/docs/pulumi-provider/): Getting started with the Pulumi provider for Checkly

## API Reference

- [Checkly API Documentation](https://developers.checklyhq.com): Complete REST API reference for managing checks, alerts, and dashboards programmatically