checkly

n8n community node for the Checkly API - manage checks, check groups, alert channels, dashboards, maintenance windows and more, plus a webhook trigger for alerts

Package Information

Released: 4 mo ago
Downloads: 0 weekly / 0 monthly
Latest Version: 0.1.2
Author: mookielianhd

Available Nodes

Documentation generating…

Checkly icon
Checkly
Manage checks, alerts and monitoring resources in Checkly
Checkly Trigger icon
Checkly Trigger
Starts the workflow when Checkly sends a check alert

Documentation

@mookielianhd/n8n-nodes-checkly

An n8n community node for Checkly — the synthetic monitoring and API checking platform. Manage checks, alert channels, dashboards and more, and trigger workflows when Checkly raises an alert.

This package contains two nodes:

  • Checkly — a regular (action) node for the Checkly REST API.
  • Checkly Trigger — a webhook trigger that fires when a check fails, recovers, degrades, or an SSL certificate is expiring.

Installation · Credentials · Operations · Trigger · Compatibility · Resources

Installation

Follow the community nodes installation guide and use the package name @mookielianhd/n8n-nodes-checkly.

Credentials

The nodes authenticate with a Checkly API key and your account ID.

  1. API Key — create a User or Service API key in Checkly under User Settings → API keys (or Account Settings → API keys for a service key).
  2. Account ID — copy it from Account Settings → General.

Both values are sent on every request (Authorization: Bearer <API Key> and X-Checkly-Account: <Account ID>). Use the Test button on the credential to confirm they are valid.

Operations

The Checkly node supports the following resources and operations:

Resource Operations
Check Create (API / Browser), Get, Get Many, Update, Delete
Check Group Create, Get, Get Many, Update, Delete
Check Result Get, Get Many
Check Status Get, Get Many
Alert Channel Create, Get, Get Many, Delete, Subscribe
Dashboard Create, Get, Get Many, Update, Delete
Snippet Create, Get, Get Many, Update, Delete
Environment Variable Create, Get, Get Many, Update, Delete
Maintenance Window Create, Get, Get Many, Update, Delete
Location Get Many
Runtime Get, Get Many

Create and update operations expose the most common fields directly. For anything else the API
accepts, use the Additional Body Fields (JSON) input (or, for alert channels, the Config (JSON)
field) to supply the raw payload. See the Checkly API reference.

Trigger

The Checkly Trigger node listens for Checkly alerts via a webhook.

When you activate a workflow containing this node, it automatically creates a webhook alert channel
in your Checkly account pointing at the n8n webhook URL, and subscribes it according to the Subscribe To
setting. When the workflow is deactivated, the alert channel is removed again.

  • All Checks — subscribes every existing check and auto-subscribes any checks created later.
  • Specific Check / Specific Check Group — subscribes only the selected check or group.

Subscriptions are created via Checkly's dedicated subscriptions endpoint after the channel is made, so
re-publishing the workflow re-applies them.

  • Events — choose which events fire the workflow (failed, recovered, degraded, SSL expiring).
  • Verify Signature — when enabled, requests whose x-checkly-signature header does not match the
    generated secret are rejected.

Compatibility

  • Requires n8n with n8nNodesApiVersion 1.
  • Built and tested against the Checkly public API v1 (https://api.checklyhq.com).

Resources

Discussion