ZAppwrite icon

ZAppwrite

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

Overview

The node interacts with Appwrite's Messaging service, specifically to list logs related to a subscriber. This operation retrieves the log entries associated with a particular subscriber under a specified topic. It is useful for monitoring message delivery, debugging issues with message sending, or auditing subscriber activity.

Practical examples include:

  • Tracking email or push notification delivery status for a specific subscriber.
  • Auditing subscriber engagement by reviewing message logs.
  • Debugging failed message deliveries by examining detailed logs.

Properties

Name Meaning
Subscriber ID The unique identifier of the subscriber whose logs you want to retrieve.
Additional Fields (Not used directly in this operation based on provided info)
Topic ID The unique identifier of the topic to which the subscriber belongs (required to scope logs).

Note: Although "Topic ID" is not explicitly listed in your provided properties JSON snippet, the source code shows it is required as a parameter for listing subscriber logs.

Output

The output is an array of log objects related to the specified subscriber within the given topic. Each log entry typically contains details such as timestamps, message statuses, error messages if any, and other metadata about message delivery or subscriber interactions.

The output is returned as JSON data. There is no indication that binary data is involved in this operation.

Dependencies

  • Requires an active connection to an Appwrite server via an API key credential.
  • The node uses the Appwrite SDK client configured with URL, project ID, and API key.
  • Proper permissions must be granted to the API key to access messaging subscriber logs.
  • The user must specify valid Topic ID and Subscriber ID parameters.

Troubleshooting

  • Common Issues:

    • Missing or incorrect Topic ID or Subscriber ID will cause the API call to fail.
    • Insufficient permissions on the API key may result in authorization errors.
    • Network connectivity issues to the Appwrite server can cause request failures.
  • Error Messages:

    • Errors from the Appwrite API will be propagated; typical messages include "Subscriber not found", "Topic not found", or "Unauthorized".
    • To resolve, verify the correctness of IDs, ensure the API key has necessary scopes, and check network connectivity.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion