ZAppwrite icon

ZAppwrite

Use Appwrite's API from inside N8N, updated by @ZachHandley

Overview

The node integrates with the Appwrite API to create a new user in the Appwrite backend. It allows specifying user details such as email, password, name, and phone number, along with options to verify the email and/or phone number after creation.

This node is beneficial in scenarios where you want to automate user management workflows, such as onboarding new users from form submissions, syncing users from other systems, or programmatically managing user accounts within your applications.

Practical example:

  • Automatically create a user account when someone signs up on your website, sending verification emails or SMS based on your preferences.
  • Batch import users into Appwrite with predefined IDs and credentials.

Properties

Name Meaning
User ID (Optional) Optional user ID to assign to the new user. If not provided, a unique random ID will be generated.
Email The email address of the user to create.
Verify Email? Boolean flag indicating whether to send an email verification for the user's email address.
Name The full name of the user.
Phone The phone number of the user.
Verify Phone? Boolean flag indicating whether to send a phone verification for the user's phone number.
Password The password for the user account.

Output

The node outputs a JSON object representing the created user as returned by the Appwrite API. This typically includes fields such as the user's unique ID, email, name, phone, and other metadata related to the user account.

If email or phone verification is requested, the node performs additional update calls to trigger those verifications but the output remains the user object.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to an Appwrite server via an API key credential configured in n8n.
  • The node uses the official Appwrite SDK internally to communicate with the Appwrite API.
  • Proper permissions must be granted to the API key to allow user creation and updates.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Attempting to create a user with an email that already exists may result in an error from Appwrite.
    • Providing an invalid phone number format might cause verification failures.
    • If verification flags are set but the Appwrite project is not configured to send verification messages, no verification will occur.
  • Error messages:

    • Authentication errors: Check that the API key and project URL are correctly configured.
    • Duplicate user errors: Ensure the email or user ID is unique or handle conflicts appropriately.
    • Validation errors: Confirm all required fields are provided and formatted correctly.

Links and References

Discussion