Docs

Connect your n8n

From fresh account to monitored in about five minutes. This is the API-key path; if your instance is private or you'd rather not share a key, use push-only mode instead.

Start API-key setup Compare push-only mode

Before you start

An n8n instance reachable over HTTPS (n8n Cloud or self-hosted).
An n8n API key: in n8n, go to Settings → API → Create key.

What the key is used for - honestly

This API key grants broad access to your n8n instance. We only ever call: GET /api/v1/workflows, GET /api/v1/executions, GET /api/v1/executions/:id, and GET /healthz. Prefer not to share a key? Use push-only mode - we never connect to your instance at all.

The key is encrypted at rest (AES-256-GCM) the moment it’s saved and decrypted only by the background worker at poll time. Details on the security page.

The five-minute flow

Connect.Pick “Connect with API key”, give the instance a label, paste its URL and the key. We immediately test the connection and tell you the result.
Templates (optional but recommended). Download the preconfigured Error Reporter workflow and import it into n8n (Workflows → Import from file). It pushes failures to us the moment they happen - real-time alerts even between polls.
Choose workflows.Everything is monitored by default; untick what you don’t care about. You can tune per-workflow criticality and silence settings later.
Alerts. Confirm your alert email and hit Send TEST ALERT - prove the loop works end to end before you rely on it. Slack, Telegram and Discord channels are available on paid plans.

Polling frequency

We poll on your plan’s cadence - every 15 minutes on Free, every 2 minutes on Pro, every minute on Agency. The Error Reporter template gives you real-time failure alerts on any plan, regardless of polling cadence.

A note on version detection

The n8n public API does not expose your instance’s version, so API polling alone can’t check it against published advisories - the version shows as unknown, and that’s the truth, not a bug. To get vulnerable-version alerts, also import the Reporter workflow from push-only mode; it reports the version on every check-in.