Appwrite icon

Appwrite

A comprehensive node for the Appwrite API

Overview

This node integrates with the Appwrite API to manage and execute serverless functions within an Appwrite project. Specifically, for the Function - Create Execution operation, it triggers the execution of a specified function by its unique ID, optionally passing string data as input. It supports both synchronous execution (waiting for the result) and asynchronous execution (triggering without waiting).

Common scenarios include:

  • Running backend logic or scripts on demand from workflows.
  • Triggering custom processing tasks with input data.
  • Automating function executions as part of larger automation pipelines.

Example: You have a function that processes user data uploaded to your app. Using this node, you can trigger that function with specific data whenever a new user signs up.

Properties

Name Meaning
Function ID Unique identifier of the function to execute. Use "unique()" to auto-generate an ID when creating a new function.
Data String data passed as input to the function during execution.
Execute Asynchronously Boolean flag indicating whether to run the function asynchronously (true) or wait for the result synchronously (false).

Output

The output is a JSON object representing the response from the Appwrite API after triggering the function execution. This typically includes details about the execution such as execution ID, status, and any returned data if executed synchronously.

If the function is executed asynchronously, the output confirms the execution request was accepted but does not contain the function's result.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Appwrite API via an API key credential configured in n8n.
  • The node depends on the Appwrite client library bundled internally.
  • Proper permissions must be granted to the API key to execute functions.

Troubleshooting

  • Common issues:

    • Invalid or missing Function ID will cause errors.
    • Passing malformed JSON or unexpected data format in the "Data" property may lead to execution failures.
    • Executing asynchronously means no immediate result; ensure downstream nodes handle this accordingly.
    • Insufficient API permissions will result in authorization errors.
  • Error messages:

    • Errors from the Appwrite API are wrapped and surfaced with message and details.
    • Network or authentication errors indicate misconfiguration of credentials.
    • To resolve, verify the Function ID exists, check API key permissions, and validate input data format.

Links and References

Discussion