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 user-related operations. 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 programmatically access or audit user-specific configuration or preference data stored in Appwrite.

Practical examples include:

  • Fetching a user's UI or notification preferences before sending personalized communications.
  • Retrieving user settings to customize workflow behavior dynamically.
  • Auditing or exporting user preferences for analysis or migration purposes.

Properties

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

Output

The output is a JSON array containing the user preferences object retrieved from Appwrite for the specified User ID. The structure corresponds to the preferences data as stored in Appwrite, typically key-value pairs representing user-specific settings.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to an Appwrite server.
  • Needs credentials including the Appwrite API URL, project ID, and an API key credential with permissions to read user preferences.
  • The node depends on the node-appwrite SDK and internal helper functions to communicate with the Appwrite API.

Troubleshooting

  • Common issues:

    • Invalid or missing User ID will cause the operation to fail.
    • Insufficient API permissions or incorrect API key may result in authorization errors.
    • Network connectivity problems to the Appwrite server can cause timeouts or connection errors.

  • Error messages:

    • Errors related to "Resource not found" indicate that the specified user does not exist.
    • Authorization errors suggest checking the API key and its permissions.
    • If the node throws an error about missing parameters, ensure the User ID is provided and correctly formatted.

To resolve these issues:

  • Verify the User ID exists in your Appwrite project.
  • Confirm the API key has the necessary scopes/permissions.
  • Check network connectivity and Appwrite server status.

Links and References

Discussion