Skip to main content

Checkly

Synthetic monitoring and API checks — manage checks, check groups, alert channels, maintenance windows, snippets and environment variables, and read run results and reporting.

Categories: Monitoring, Observability, Developer Tools

What you can ask​

  • List every check that failed in the last 24 hours and the locations it failed from.
  • Create an API check that hits https://api.acme.com/health every 5 minutes and alerts the on-call Slack channel.
  • Schedule a maintenance window for Saturday 02:00 to 04:00 UTC covering the checkout check group.

Set up​

Checkly connects with credentials from your Checkly account. Have these values ready:

  • Account ID
  • API key
  1. Go to Organization > Connectors and find Checkly.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

Checkly offers 44 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (25)​

View and search information without changing it.

ToolWhat it does
get_alert_channelRetrieve one alert channel by ID, with its type-specific config.
get_checkRetrieve one check by ID, including its schedule, locations and request or heartbeat configuration.
get_check_groupRetrieve one check group by ID, with its shared settings.
get_check_resultRetrieve one recorded check run in full, including timings and per-assertion detail.
get_current_accountRetrieve the Checkly account this connection acts on, with its plan and default runtime.
get_maintenance_windowRetrieve one maintenance window by ID, with its schedule and the tags it applies to.
get_reportingGet aggregated success rates and response-time percentiles per check over a window.
get_runtimeRetrieve one runtime by ID, including every package version it bundles.
get_snippetRetrieve one snippet by ID, including its full script.
get_variableRetrieve one environment variable by key.
list_account_membersList the people with access to the current Checkly account, with their roles.
list_accountsList every Checkly account this API key can reach.
list_alert_channelsList the destinations Checkly sends alerts to, such as email, Slack and webhooks.
list_check_alertsList alerts Checkly has raised across every check, newest first, optionally limited to a date range.
list_check_group_checksList the checks that belong to one check group.
list_check_groupsList check groups, which hold shared locations, runtime and alert settings for a set of checks.
list_check_resultsList recorded runs of one check, newest first, filtered by location, failure state, result type and time window.
list_checksList monitoring checks, newest first, with server-side filtering by type, name, tag, status and API-check URL.
list_locationsList the public locations Checkly can run checks from.
list_maintenance_windowsList maintenance windows, the scheduled periods in which Checkly pauses checks and silences their alerts.
list_runtimesList the runtime versions checks can execute on, with their Node.js version and bundled packages.
list_snippetsList reusable JavaScript snippets that checks can run as setup or teardown steps.
list_static_ipsList the IPv4 addresses Checkly's public runners send traffic from, for allowlisting a monitored endpoint's firewall.
list_variablesList account-level environment variables that checks can read at runtime.
validate_credentialValidate the Checkly API key and account ID with a lightweight account lookup.

Write (7)​

Create or send data.

ToolWhat it does
create_alert_channelCreate an alert destination.
create_api_checkCreate an API check that sends an HTTP request on a schedule and asserts on the response.
create_check_groupCreate a check group so several checks share locations, runtime and alert settings.
create_heartbeat_checkCreate a heartbeat check that alerts when a scheduled job stops pinging Checkly.
create_maintenance_windowCreate a maintenance window so checks are paused and alerts silenced during planned work.
create_snippetCreate a reusable JavaScript snippet that checks can run as a setup or teardown step.
create_variableCreate an account-level environment variable that checks can read at runtime.

Delete or overwrite (12)​

Remove or replace existing data.

ToolWhat it does
delete_alert_channelPermanently delete an alert channel.
delete_checkPermanently delete a check and its run history.
delete_check_groupPermanently delete a check group.
delete_maintenance_windowPermanently delete a maintenance window, so the checks it covered are no longer paused during it.
delete_snippetPermanently delete a snippet.
delete_variablePermanently delete an environment variable.
update_alert_channelUpdate an alert channel's config or which alert kinds it receives.
update_checkUpdate a check.
update_check_groupUpdate a check group.
update_maintenance_windowUpdate a maintenance window's schedule or the tags it applies to.
update_snippetUpdate a snippet's name or script.
update_variableReplace an environment variable's value.
⌘J