ZAppwrite icon

ZAppwrite

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

Overview

This node integrates with the Appwrite API to perform various operations on documents stored within an Appwrite database. Specifically, the Update Document operation allows users to update an existing document in a specified collection and database by providing the document ID and the new data.

Common scenarios where this node is beneficial include:

  • Updating user profiles or records stored as documents.
  • Modifying content or metadata of documents in real-time workflows.
  • Automating updates to structured data in Appwrite databases based on external triggers.

For example, you might use this node to update a customer's order status after payment confirmation or to modify a blog post's content dynamically.

Properties

Name Meaning
Database ID The identifier of the database where the document resides.
Collection ID The identifier of the collection containing the document to update.
Document ID The unique identifier of the document to update.
Body A JSON object representing the fields and values to update in the document.

Output

The output is a JSON array containing the updated document's data as returned by the Appwrite API. This includes all the document's attributes after the update has been applied.

If the operation succeeds, the output will be the full updated document object. If there is an error and "Continue On Fail" is enabled, the output will contain an error message instead.

The node does not output binary data for this operation.

Dependencies

  • Requires an active connection to an Appwrite server.
  • Needs credentials including the Appwrite endpoint URL, project ID, and an API key credential with permissions to update documents.
  • Uses the official Appwrite SDK (node-appwrite) internally.
  • The node expects the Appwrite client to be configured correctly via n8n credentials.

Troubleshooting

  • Common Issues:

    • Incorrect or missing Database ID, Collection ID, or Document ID will cause the update to fail.
    • Invalid JSON structure in the Body property can lead to errors.
    • Insufficient permissions or invalid API key may result in authorization errors.
    • Network connectivity issues to the Appwrite server can cause timeouts or failures.
  • Error Messages:

    • Errors from the Appwrite API are propagated and typically indicate the reason (e.g., "Document not found", "Permission denied").
    • If the node throws an error about resource not found, verify that the Resource and Operation parameters are set correctly.
    • For JSON parsing errors, ensure the Body field contains valid JSON.
  • Resolution Tips:

    • Double-check all IDs and JSON body syntax.
    • Confirm API key permissions and project settings in Appwrite console.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during workflow execution.

Links and References

Discussion