Description
n8n Payload CMS Node
A dynamic n8n node for Payload CMS that automatically discovers collections and operations, allowing you to interact with any Payload CMS instance via the REST API.
Forked from n8n-payload-dynamic
Features
- Dynamic Collection Discovery: Automatically discovers available collections from your Payload CMS instance
- Dynamic Global Discovery: Automatically discovers available globals from your Payload CMS instance
- Full CRUD Operations: Support for all standard operations (Create, Read, Update, Delete, Count)
- Advanced Query Support: Includes support for filtering, sorting, pagination, depth control, and localization
- Flexible Authentication: Uses API key authentication with configurable API prefix
- Error Handling: Robust error handling with detailed error messages
Installation
Payload
In your payload server create one endpoint to fetch the permissions for your user
#### src/endpoints/reflection.ts
import type { Endpoint, PayloadRequest } from "payload";export const reflectionEndpoint: Endpoint = {
path: "/reflection",
method: "get",
handler: async (req: PayloadRequest) => {
const { payload, user } = req;
if (!user) {
return Response.json(
{
error: "Unauthorized: You must be logged in to access this endpoint",
},
{ status: 401 }
);
}
return Response.json({
collections: payload.config.collections,
globals: payload.config.globals,
});
},
};
#### src/payload.config.ts
import { buildConfig } from "payload/config";
import { reflectionEndpoint } from "./endpoints"; // import the endpointexport default buildConfig({
// your collections, globals, etc
endpoints: [reflectionEndpoint], // add the endpoint
});
n8n
1. In your n8n instance go to “Settings”
1. Then go to “Comunity nodes” and click the install button
1. paste the following into the “npm Package Name” field
> >
> > @warleon/n8n-nodes-payload-cms
> > 4. Accept the checkpbox and click install
Configuration
Credentials Setup
1. In n8n, create new credentials of type “Payload CMS API”
2. Configure the following fields:
– Base URL: The base URL of your Payload CMS instance (e.g., https://your-payload-instance.com)
– API key: the generated api key for your user
– User Collection: The collection slug for users (default: users)
– API Prefix: The API route prefix (default: /api)
Getting Credentials
Use any valid user account from your PayloadCMS instance. The node will automatically:
No API keys are required – the node uses PayloadCMS’s standard login authentication flow.
Usage
Collection Operations
The node supports the following operations on collections:
Global Operations
The node supports the following operations on globals:
Auth Operations
The node supports the following authentication operations:
Query Parameters
The node supports all standard Payload CMS query parameters:
- prefix for descending, e.g., -createdAt)Example Usage
#### Finding Posts with Filtering
{
"resource": "collection",
"collection": "posts",
"operation": "find",
"additionalOptions": {
"where": {
"status": {
"equals": "published"
}
},
"limit": 20,
"sort": "-createdAt"
}
}
#### Creating a New Document
{
"resource": "collection",
"collection": "posts",
"operation": "create",
"data": {
"title": "My New Post",
"content": "This is the content of my new post",
"status": "draft"
}
}
#### Updating Global Settings
{
"resource": "global",
"global": "settings",
"operation": "update",
"data": {
"siteName": "My Updated Site Name",
"siteDescription": "Updated description"
}
}
Dynamic Discovery
The node automatically discovers available collections and globals from your Payload CMS instance using the following methods:
1. Primary Method: Attempts to fetch collections/globals from admin endpoints (/api/collections, /api/globals)
2. Fallback Method: Tests common collection/global names to discover what’s available
Common Collections Tested
Common Globals Tested
Error Handling
The node includes comprehensive error handling:
Development
Building
npm run build
Development Mode
npm run dev
Linting
npm run lint
Formatting
npm run format
Payload CMS REST API Reference
This node is built according to the official Payload CMS REST API documentation:
https://payloadcms.com/docs/rest-api/overview
Supported Payload CMS Versions
This node is designed to work with Payload CMS v2.x and v3.x. It uses the standard REST API endpoints that are consistent across versions.
Contributing
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request
License
This project is licensed under the MIT License.
Support
For issues and questions:
1. Check the Payload CMS documentation: https://payloadcms.com/docs
2. Review the n8n node development documentation
3. Open an issue in this repository
