Skip to content

TheFehr/n8n-nodes-pocketbase

Repository files navigation

n8n-nodes-pocketbase

This is a n8n community node. It lets you use PocketBase in your n8n workflows.

PocketBase is an open source backend consisting of embedded database (SQLite) with realtime subscriptions, built-in auth management, convenient dashboard UI and simple REST-ish API.

n8n is a fair-code licensed workflow automation platform.

Installation
Usage Tips
Operations
Credentials Compatibility
Development
Resources

Usage Tips

Clearing Fields

To clear a field (set it to its zero-value or delete a file), you can send null as the value:

  • Text/Number/Select/Relation: Use an expression to return null to clear the field.
  • JSON: Use null to store a literal null value.
  • File: Use null to delete the existing file.

In the Fields parameter, use an expression: ={{ null }}.
In the JSON Body, use the literal null: {"myField": null}.

Installation

Follow the installation guide in the n8n community nodes documentation.

Operations

Nearly all PocketBase operations for Base collections should be implemented.

Trigger Node (Beta)

This node allows you to subscribe to PocketBase events (create, update, delete) in real-time via Server-Sent Events (SSE).

Note: The trigger node is currently in Beta. We've implemented basic reconnection logic, but it may still be sensitive to network interruptions or large amounts of data. Please use with caution in production.

Credentials

Ensure you have an Auth collection in your PocketBase defined and the "Username/Password" Auth method turned on.
Alternatively, you can use your administrator account and the "_superusers" collection which PocketBase creates automatically since v0.23.0.

Compatibility

This was developed for version 2.28.6 of n8n and version 0.39.5 of PocketBase.

Development

This project uses modern tooling for development:

  • Linting: oxlint for fast linting.
  • Formatting: oxfmt for fast formatting.
  • Testing: vitest for unit and integration tests.

Scripts

  • npm run lint: Lint the project.
  • npm run format: Format the project.
  • npm test: Run tests.
  • npm run test:pipeline: Run a full integration test against a PocketBase instance in Docker and update the compatibility section in README.md.

Resources

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Generated from n8n-io/n8n-nodes-starter