n8n-nodes-checkredirects
v1.0.0
Published
n8n community node for Checkredirects.io — URL inspection, redirect checking, and monitoring API
Maintainers
Readme
n8n-nodes-checkredirects
n8n community node for the Checkredirects.io API -- inspect URLs, check redirect chains, run batch audits, and monitor URLs for changes over time.
Table of Contents
- Prerequisites
- Installation
- Quick Start
- Architecture Overview
- Configuration
- Usage
- Nodes
- Troubleshooting
- Testing
Prerequisites
- n8n (self-hosted or cloud) -- any recent version
- A Checkredirects.io account with an API key (sign up / create API key)
Installation
In n8n (community node)
- Open Settings > Community Nodes in your n8n instance
- Select Install
- Enter
n8n-nodes-checkredirects - Agree to the risks and click Install
Manual install (self-hosted)
cd ~/.n8n
npm install n8n-nodes-checkredirectsRestart n8n after installation.
Quick Start
- Install the node (see above)
- Create a new workflow in n8n
- Add the Checkredirects.io node
- Create credentials: paste your API key (starts with
httpd_) from Settings > API Keys - Set Resource to URL Inspection, Operation to Inspect URL
- Enter a URL and execute -- you'll get the full redirect chain, status codes, and timing
Architecture Overview
This package provides three n8n nodes and one credential type:
n8n-nodes-checkredirects/
credentials/
CheckredirectsApi.credentials.ts -- API key + base URL credential
nodes/Checkredirects/
Checkredirects.node.ts -- Main action node (inspect, batch, monitor, account)
CheckredirectsTrigger.node.ts -- Webhook trigger (batch/monitor events)
CheckredirectsPollTrigger.node.ts -- Polling trigger (monitor runs)
Checkredirects.node.json -- Codex metadata (categories, aliases)
checkredirects.svg -- Node icon
index.ts -- Package entry point (re-exports all nodes)All nodes communicate with the Checkredirects.io API via REST. No external runtime dependencies.
Configuration
Credentials
| Field | Description |
| -------- | ----------------------------------------------------- |
| API Key | Your Checkredirects.io API key (starts with httpd_) |
| Base URL | https://api.checkredirects.io (default) |
Create an API key at checkredirects.io/settings/api-keys.
UPDATE: If Checkredirects.io changes their API base URL, update the default in credentials/CheckredirectsApi.credentials.ts field baseUrl.
Usage
Inspect a single URL
Set Resource = URL Inspection, Operation = Inspect URL. Returns the full redirect chain with status codes, response times, and optionally SEO metadata (title, canonical, OG tags).
Batch check many URLs
Set Resource = Batch, Operation = Check and Wait. Paste one URL per line. The node submits the batch and polls until results are ready (up to 5 minutes). For larger batches, use Create Batch + Get Results separately.
Monitor URLs over time
Set Resource = Monitor, Operation = Create. Define a name, URLs, and check interval. The Checkredirects.io API will re-check those URLs on schedule.
Use the Poll Trigger or Webhook Trigger node to start workflows when a monitor run completes or detects changes.
Example: Alert on redirect changes
- Checkredirects.io Poll Trigger -- watches a monitor for new runs
- IF node -- filter for runs where
has_changesis true - Slack node -- post a message with the change details
Nodes
Checkredirects.io (Action Node)
| Resource | Operations | | -------------- | --------------------------------------------------------------------- | | URL Inspection | Inspect URL, Compare Agents, Import Sitemap | | Batch | Check and Wait, Create Batch, Get Results, Get Progress, Compare | | Monitor | Create, List, Get, Update, Delete, Pause, Resume, Trigger, Get Runs | | Account | Get Usage |
Checkredirects.io Trigger (Webhook)
Fires when the Checkredirects.io API sends a webhook for:
- Batch completed
- Monitor completed
- Monitor change detected
Copy the webhook URL from n8n and paste it into your batch/monitor configuration at checkredirects.io.
Checkredirects.io Poll Trigger
Polls a specific monitor for new runs on the n8n polling schedule. No webhook configuration needed.
Troubleshooting
| Error | Cause | Fix |
| ----- | ----- | --- |
| "Invalid API key" | Wrong or expired API key | Re-create at Settings > API Keys |
| "Monthly check limit exceeded" | Plan quota reached | Check usage at Settings > Billing |
| "This feature requires a paid plan" | Free tier limitation | Upgrade at checkredirects.io/settings/billing |
| "Service unavailable" (503) | Google Sheets not connected | Connect at Settings > Integrations |
| Batch timed out after 5 min | Large batch still processing | Use "Create Batch" + "Get Results" separately |
| Missing node icon | Old build without assets | Run npm run build (copies SVG to dist) |
Testing
Build locally
git clone https://github.com/neondeerdatalabs/n8n-nodes-checkredirects.git
cd n8n-nodes-checkredirects
npm install
npm run buildLint (n8n community node scanner)
npm run lintTest in a local n8n instance
# From the node package directory
npm link
# From your n8n installation
cd ~/.n8n
npm link n8n-nodes-checkredirects
# Restart n8n -- the node should appear in the nodes panelBuilt by Neon Deer Data Labs. Full API documentation at checkredirects.io/docs.
