Skip to content

ZachHandley/n8n-nodes-appwrite

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

n8n-nodes-zappwrite


N8N Logo

Free and open fair-code licensed node based Workflow Automation Tool.


Appwrite Logo

A complete backend solution for your [Flutter / Vue / Angular / React / iOS / Android / *ANY OTHER*] app

This is an n8n community node. It lets you use Appwrite in your n8n workflows through the ZAppwrite integration.

n8n is a fair-code licensed workflow automation platform.

Quick Links

Installation

Follow the installation guide in the n8n community nodes documentation.

NPM Installation

npm install n8n-nodes-zappwrite

Note

This package replaces the previous n8n-nodes-nappwrite package. See the migration section for upgrade instructions.

Operations

Documents

  • Get - Retrieve document by ID or with queries
  • Create - Create new documents
  • Update - Update existing documents
  • Delete - Delete documents
  • Get All - List documents with optional filtering

Functions

  • List All - Get all available functions
  • Get by ID - Retrieve specific function details
  • Execute - Execute function and return results

Storage

  • Create Bucket - Create new storage bucket
  • Delete Bucket - Remove storage bucket
  • Get Bucket - Retrieve bucket information
  • List Buckets - Get all buckets
  • List Files - Get files in bucket
  • Get File - Retrieve file information
  • Create File - Upload new files
  • Delete File - Remove files

Users

  • Get User - Retrieve user information
  • Create User - Create new user accounts
  • Update User - Modify user details including:
    • Name, Email, Phone
    • Verification status
    • Password, Labels, Status
  • Get User Preferences - Retrieve user preferences
  • Update User Preferences - Modify user preferences
  • List Users - Get users with optional filtering
  • Delete User - Remove user accounts
  • Session Management - List/delete user sessions
  • Memberships - List user team memberships
  • Logs - Access user activity logs
  • Identities - Manage user identities

Additional Services

  • Avatars - Generate and retrieve user avatars
  • Locale - Get locale and country information
  • Messaging - Send messages and notifications
  • Tokens - Manage authentication tokens

Credentials

Setup Steps

  1. Appwrite Instance: Ensure you have Appwrite running

  2. Create Project: Set up a new project in Appwrite

  3. Generate API Key:

    • Navigate to your project settings
    • Create a new API key
    • Grant necessary permissions:
      • Functions - For function operations
      • Databases - For document operations
      • Storage - For file operations
      • Users - For user management
  4. Configure N8N Credentials:

    • Create new "ZAppwrite API" credential in N8N
    • Endpoint URL:
      • Appwrite Cloud: https://cloud.appwrite.io/v1
      • Self-hosted: https://your-domain.com/v1
    • Project ID: Copy from project settings
    • API Key: Paste your generated API key

Security Best Practices

  • Use minimum required permissions for API keys
  • Rotate API keys regularly
  • Store credentials securely in N8N
  • Use separate API keys for different environments

Compatibility

  • N8N: Latest stable version
  • Appwrite: 1.7.x and newer
  • Node.js: 18+ recommended
  • node-appwrite: 17.0.0+

Migration from NAppwrite

Upgrading from Previous Versions

1. Package Installation

# Remove old package
npm uninstall n8n-nodes-nappwrite

# Install new package  
npm install n8n-nodes-zappwrite

2. Update Workflows

  • Change node type from "NAppwrite" to "ZAppwrite"
  • Update credential type from "NAppwrite API" to "ZAppwrite API"
  • Recreate credentials using new credential type

3. Workflow JSON Updates

// Old configuration
{
  "name": "NAppwrite",
  "type": "nAppwrite", 
  "credentials": {
    "nAppwriteApi": "credential-id"
  }
}

// New configuration
{
  "name": "ZAppwrite",
  "type": "zAppwrite",
  "credentials": {
    "zAppwriteApi": "credential-id"  
  }
}

4. Functionality Verification

  • Test all existing workflows
  • Verify credentials work correctly
  • Confirm operations produce expected results

Note: All functionality remains identical - only naming has changed.

Advanced Usage

Query Building

ZAppwrite supports Appwrite's query system for filtering and sorting:

// Example queries in workflow expressions
[
  Query.equal('status', 'published'),
  Query.greaterThan('created_at', '2024-01-01'),
  Query.orderDesc('updated_at'),
  Query.limit(10)
]

Error Handling

Implement proper error handling in your workflows:

  • Check for authentication errors
  • Handle network timeouts
  • Validate required parameters
  • Log errors for debugging

Performance Tips

  • Use query filters to limit data transfer
  • Implement pagination for large datasets
  • Cache frequently accessed data
  • Monitor API rate limits

Development

Building from Source

# Clone repository
git clone https://github.com/zachhandley/n8n-nodes-appwrite.git
cd n8n-nodes-appwrite

# Install dependencies
pnpm install

# Build package
pnpm build

# Run linting
pnpm lint

Contributing

  1. Fork the repository
  2. Create feature branch
  3. Make changes with tests
  4. Run build and lint checks
  5. Submit pull request

Resources

Changelog

1.0.1 - Fix README.md links

  • They were linking to what I thought I was gonna name the repository, not what I actually did

1.0.0 - ZAppwrite Rebrand

  • Complete rebrand from NAppwrite to ZAppwrite
  • Maintained 100% compatibility with existing functionality
  • Enhanced documentation and migration guides
  • Updated package structure and naming conventions
  • Improved testing and validation procedures

Previous Versions (NAppwrite Legacy)

  • 0.71.4 - Bug fixes, query conversion improvements
  • 0.71.3 - Safe JSON parsing for query strings
  • 0.71.2 - Updated Appwrite logo
  • 0.71.1 - Appwrite 1.6.x support
  • 0.70.0 - Appwrite 1.5.x support
  • 0.69.1 - Document update fixes
  • 0.69.0 - Initial release

License

MIT License - see LICENSE.md for details.

Support

For issues, questions, or contributions:

About

n8n node for Appwrite

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.8%
  • JavaScript 1.2%