Description
n8n-nodes-crownpeak-dqm
Overview
This repository provides a custom n8n integration node for the Crownpeak DQM CMS API. It enables direct access to asset operations such as creation, retrieval, and spellcheck quality analysis within an n8n workflow.
What is it?
An n8n node module designed to simplify integration with Crownpeak DQM's CMS API using secure and structured credential management. It supports:
- Authenticate securely using API key credentials.
- Manage assets end-to-end: create, update, delete, and fetch content and status.
- Inspect asset issues via spellcheck, page highlights, and checkpoint errors.
- Access checkpoint and website data with tailored workflows.
- Chain operations using dynamic expressions, building automated quality pipelines.
What is it for?
This module is useful for organizations using Crownpeak DQM who want to:
- Automate quality checks on web content
- Schedule or trigger DQM scans from CMS or DAM systems
- Include DQM analysis within broader content approval workflows
Installation & Usage
As a Private Node
- Clone this repository to your local machine:
git clone https://github.com/crownpeak/n8n-nodes-crownpeak-dqm.git
- Build the node module:
cd n8n-nodes-crownpeak-dqm
npm install
npm run build
- Copy the
dist/folder to your n8n instance's custom nodes directory:
docker cp ./dist n8n-dev:/home/node/.n8n/custom-nodes/crownpeak-dqm
- Restart your n8n Docker container:
docker restart n8n-dev
- Log in to n8n and the node will appear as Crownpeak DQM.
ℹ️ If it doesn't appear, ensure you are mounting or copying to the correct container path and that
NODE_FUNCTION_ALLOW_EXTERNALis not overly restricted.
As a Community Node (once approved)
Once this node is approved and published on the official n8n integrations registry, installation will be as simple as:
n8n install n8n-nodes-crownpeak-dqm
And in n8n@1.100.0+ via the UI:
- Open Settings → Community Nodes
- Click Install a Community Node
- Search or paste:
n8n-nodes-crownpeak-dqm - Click Install
Community node versions are verified by n8n and automatically updated when new releases are published.
Node Features
| Operation | Method | Endpoint Route | Description |
|---|---|---|---|
| List Assets | GET | /assets?apiKey&websiteId&limit |
Paginated asset listing with optional filters |
| Get Asset Details | GET | /assets/:assetId?apiKey&websiteId |
Full metadata for a specific asset |
| Get Asset Content | GET | /assets/:assetId/content?apiKey&websiteId |
Fetch raw HTML/text of the asset |
| Get Asset Status | GET | /assets/:assetId/status?apiKey&websiteId |
Processing status of the asset |
| Get Spellcheck Issues | GET | /assets/:assetId/spellcheck?apiKey&websiteId |
Spelling/grammar issues identified |
| Get Asset Errors by Checkpoint | GET | /assets/:assetId/errors/:checkpointId?apiKey&websiteId |
Errors for asset at a specific checkpoint |
| Get Asset Page Highlights | GET | /assets/:assetId/pagehighlight/all?apiKey&websiteId |
Page-level highlights of quality issues |
| Create Asset | POST | /assets?apiKey (body: websiteId, content, contentType) |
Submit new asset |
| Update Asset | PUT | /assets/:assetId?apiKey (body: websiteId, content) |
Update content or trigger re-analysis |
| Delete Asset | DELETE | /assets/:assetId?apiKey&websiteId |
Remove asset and associated results |
| List Websites | GET | /websites?apiKey |
Fetch all websites configured |
| Get Website Details | GET | /websites/:websiteId?apiKey |
Metadata for a specific website |
| Get Website Checkpoints | GET | /websites/:websiteId/checkpoints?apiKey |
Checkpoints configured on a website |
| List Checkpoints | GET | /checkpoints?apiKey |
Full set of available quality checkpoints |
| Get Checkpoint Details | GET | /checkpoints/:checkpointId?apiKey |
Specific checkpoint metadata |
Each method supports query parameterization using dynamic expressions and securely authenticates using an API key.
📸 Screenshots
-
A basic workflow example using n8n Crownpeak DQM Node
-
The result of /spellcheck for a specified asset
Support
- This repository is maintained by Crownpeak and released under the MIT License.
- For Crownpeak platform questions, please contact your Customer Success Manager or support@crownpeak.com.
- For n8n integration issues or pull requests, use GitHub Issues or Discussions.
License
MIT © Crownpeak Technology, Inc.
See LICENSE for details.
