ZAppwrite icon

ZAppwrite

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

Actions84

Overview

The node integrates with the Appwrite API to perform various operations on different resources. Specifically, for the Users resource and the Get User Preferences operation, it retrieves the preferences settings of a specified user by their User ID. This is useful in scenarios where you want to fetch personalized settings or configurations that a user has saved in an Appwrite backend.

Practical examples include:

  • Fetching user interface preferences to customize the UI dynamically.
  • Retrieving notification or privacy settings for a user.
  • Integrating user preference data into workflows for personalized automation.

Properties

Name Meaning
User ID The unique identifier of the user whose preferences you want to retrieve.

Output

The output is a JSON object containing the user's preferences as stored in Appwrite. The exact structure depends on how preferences are defined in the Appwrite backend but typically includes key-value pairs representing user-specific settings.

No binary data output is involved in this operation.

Example output (conceptual):

{
  "theme": "dark",
  "notifications": {
    "email": true,
    "sms": false
  },
  "language": "en"
}

Dependencies

  • Requires an active connection to an Appwrite server.
  • Needs credentials including the Appwrite endpoint URL, project ID, and an API key credential configured in n8n.
  • Uses the official Appwrite SDK (node-appwrite) internally to communicate with the Appwrite API.

Troubleshooting

  • Common issues:

    • Invalid or missing User ID parameter will cause the operation to fail.
    • Incorrect or expired API key or project ID credentials can lead to authentication errors.
    • Network connectivity problems to the Appwrite server will prevent successful API calls.

  • Error messages:

    • Authentication errors indicating invalid credentials: Verify your API key and project ID.
    • "Resource not found" or similar: Ensure the User ID exists in your Appwrite project.
    • Timeout or network errors: Check your network connection and Appwrite server availability.

Links and References

Discussion