ZAppwrite icon

ZAppwrite

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

Overview

This node integrates with the Appwrite API, allowing users to interact with various Appwrite resources such as Functions, Documents, Storage, Users, Messaging, Avatars, Locale, and Tokens. Specifically for the Function resource, it supports operations like listing all functions, retrieving details of a specific function, and executing a function.

A common use case is automating backend workflows by invoking serverless functions hosted on Appwrite directly from n8n. For example, you can trigger a function that processes data or performs custom logic whenever an event occurs in your workflow.

Properties

Name Meaning
Function ID The unique identifier of the Appwrite function to get details for or execute.

For the "Get Function" operation, only the Function ID property is required.

Output

The node outputs JSON data representing the response from the Appwrite API for the requested function operation:

  • For Get Function, the output JSON contains detailed information about the specified function, such as its configuration, status, and metadata.
  • For Execute Function, the output JSON contains the result of the function execution, which may include any data returned by the function.

If binary data were involved (not in this operation), it would be summarized accordingly, but here the output is purely JSON.

Dependencies

  • Requires an active Appwrite project with API access.
  • Needs an API key credential configured in n8n to authenticate requests to the Appwrite API.
  • Uses the official Appwrite SDK (node-appwrite) internally.
  • The node depends on helper functions that wrap Appwrite API calls.

Troubleshooting

  • Common issues:
    • Invalid or missing Function ID will cause errors when trying to get or execute a function.
    • Authentication failures if the API key or project credentials are incorrect.
    • Network connectivity issues to the Appwrite endpoint.
  • Error messages:
    • Errors thrown by the Appwrite API will be surfaced, e.g., "Resource not found" if the function does not exist.
    • If continueOnFail is enabled, errors will be returned as part of the output array instead of stopping execution.
  • Resolution tips:
    • Verify the Function ID is correct and exists in your Appwrite project.
    • Ensure the API key credential has sufficient permissions.
    • Check network access and endpoint URL correctness.

Links and References

Discussion