Package Information
Released: this month
Downloads: 0 weekly / 0 monthly
Latest Version: 1.0.0
Author: Stephan Baum
Documentation
@brussobaum/n8n-nodes-payload-cms
Community node package for n8n providing full integration with the Payload CMS REST API (v2 & v3).
Built with zero runtime dependencies, full n8n AI Agent Tool support (usableAsTool: true), light & dark themed icons, and strict @n8n/eslint-plugin-community-nodes compliance.
Features
Nodes Included
- Payload CMS (
payloadCms) — Action node & AI Agent Tool supporting:- Zero-Mod Autodiscovery: Automatically discovers your Collections, Globals, and nested Field paths directly from Payload's built-in
GET /api/accessendpoint (with a From List / By Slug resource locator) — no custom reflection endpoint or backend code required - Collections:
Get Many(with pagination, Filter Builder, raw JSONwhere, sorting,select),Get,Create,Update,Update Many(bulkPATCHwithwhere),Delete,Delete Many(bulkDELETEwithwhere), andCount - Globals:
GetandUpdate - Media / Uploads:
Uploadbinary files (multipart/form-datawith optional_payloadmetadata),Update File, andDownload(original file or named Payload image size variant into n8n binary data) - Custom Endpoints: Call any custom Payload REST endpoint (
GET,POST,PUT,PATCH,DELETE) with automatic authentication, query parameters, JSON bodies, custom headers, and Payload options (depth,locale,fallback-locale,draft) - Auth:
Login,Get Current User (Me),Refresh Token, andLogout
- Zero-Mod Autodiscovery: Automatically discovers your Collections, Globals, and nested Field paths directly from Payload's built-in
- Payload CMS Trigger (
payloadCmsTrigger) — Polling trigger node with auto-discovered collection dropdowns supporting:Document CreatedDocument UpdatedDocument Created or Updated- Optional Payload
wherefilter,depth,locale,fallback-locale,draft, andselectoptions, plus millisecond-accurate boundary deduplication
Payload CMS Query & Localization Support
depth(relationship population depth)locale&fallback-localedraft&autosaveselect(Payload v3 bracket-notation field selection, including nested dot paths likemeta.descriptionand exclusions like-internalNotes)where(visual Filter Builder with all Payload operators —equals,not_equals,contains,like,in,not_in,all,exists,greater_than,less_than,near,within,intersects— or raw JSONwherequeries)
Authentication Methods
- Payload CMS API (API Key) — Uses
Authorization: <authCollection> API-Key <apiKey>.
Enable API keys on your auth collection in Payload:export const Users: CollectionConfig = { slug: 'users', auth: { useAPIKey: true, }, fields: [], }; - Payload CMS Email & Password (JWT) API — Automatically logs in via
POST /api/<authCollection>/login, caches the JWT in memory until expiry, and retries once with a fresh token on HTTP401.
Both credentials support custom apiRoute prefixes (default /api) and custom authCollection slugs (default users), and include built-in credential tests.
Installation
In n8n (Community Nodes)
Go to Settings → Community Nodes → Install and enter:
@brussobaum/n8n-nodes-payload-cms
Publishing & n8n Verification
This repository includes .github/workflows/publish.yml configured with --provenance (id-token: write) for n8n Creator Portal verification:
- Configure npm Trusted Publishers (or add an
NPM_TOKENrepository secret) forStephanBaum/n8n-nodes-payload-cms. - Create a GitHub Release (e.g.,
v1.0.0) to automatically build, lint, test, and publish@brussobaum/n8n-nodes-payload-cmsto npm with provenance. - Submit the published npm package in the n8n Creator Portal to make it searchable and installable directly inside n8n Cloud and self-hosted instances.
Local Development & Testing in n8n
npm install
npm run build
npm run lint
npm test
To link this package into a local n8n instance:
npm link
cd ~/.n8n/custom
npm link @brussobaum/n8n-nodes-payload-cms
n8n start