NAppwrite icon

NAppwrite

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

Actions25

Overview

This node integrates with the Appwrite API to manage users within an Appwrite project. Specifically, the "Create User" operation allows you to create a new user account by providing essential details such as email, password, and optionally name and phone number. It also supports verifying the user's email and/or phone number immediately after creation.

Common scenarios where this node is beneficial include:

  • Automating user registration workflows in applications.
  • Creating test users programmatically during development or QA.
  • Integrating user management into broader automation pipelines without manual intervention.

For example, you could use this node to automatically create a user when a form is submitted on your website, sending verification emails or SMS messages as part of the process.

Properties

Name Meaning
User ID (Optional) Optional custom user ID to assign; if not provided, a unique random ID will be generated automatically.
Email The email address for the new user. Required.
Verify Email? Boolean flag indicating whether to send an email verification request after user creation.
Name The full name of the user. Optional.
Phone The phone number of the user. Optional.
Verify Phone? Boolean flag indicating whether to send a phone verification request after user creation.
Password The password for the new user. Required.

Output

The node outputs a JSON object representing the created user. This includes at least the user's unique ID and other metadata returned by the Appwrite API upon successful creation.

If email or phone verification flags are set, the node performs additional update calls to trigger verification processes but the output remains the created user data.

No binary data output is produced by this operation.

Dependencies

  • Requires an active Appwrite project with API access.
  • Needs an API key credential configured in n8n to authenticate requests to the Appwrite server.
  • The node uses the official Appwrite SDK internally to communicate with the API.

Troubleshooting

  • Error: Invalid credentials or authentication failure
    Ensure that the API key and project ID are correctly configured in the node credentials.

  • Error: Email already exists
    The email must be unique in the Appwrite project. Use a different email or check if the user already exists.

  • Error: Password does not meet requirements
    Verify that the password complies with any Appwrite password policies (length, complexity).

  • Verification flags not triggering verification
    Make sure the Appwrite server is properly configured to handle email and phone verifications.

  • Network or connectivity issues
    Confirm that the Appwrite endpoint URL is reachable from the n8n instance.

Links and References

Discussion