ZAppwrite icon

ZAppwrite

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

Overview

The node integrates with Appwrite's Messaging API to manage messaging subscribers within a specified topic. The "List Subscribers" operation retrieves all subscribers associated with a given messaging topic. This is useful for scenarios where you want to monitor or process the list of users or endpoints subscribed to a particular messaging channel, such as sending notifications, managing subscriptions, or auditing subscriber data.

Practical examples:

  • Fetching all subscribers of a notification topic to send targeted messages.
  • Auditing subscriber lists for compliance or reporting.
  • Integrating subscriber data into other workflows for personalized communication.

Properties

Name Meaning
Topic ID The unique identifier of the messaging topic whose subscribers you want to list.
Additional Fields (Not applicable specifically for this operation based on provided info)

Note: For the "List Subscribers" operation, only the "Topic ID" property is required and used.

Output

The output is a JSON array containing subscriber objects related to the specified topic. Each object represents a subscriber with its details as returned by the Appwrite Messaging API. The exact structure depends on the API response but typically includes subscriber identifiers and associated metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to Appwrite's API via an API key credential configured in n8n.
  • The node uses the Appwrite SDK client initialized with the project URL, project ID, and API key.
  • Proper permissions on the Appwrite project to access messaging topics and subscribers are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Topic ID will cause the API call to fail.
    • Insufficient permissions or incorrect API credentials can result in authorization errors.
    • Network connectivity issues may prevent successful API calls.
  • Error messages:

    • Errors from the Appwrite API will be propagated; typical messages include "Resource not found" if the topic does not exist or "Unauthorized" if credentials are invalid.
    • To resolve, verify the Topic ID exists, check API credentials, and ensure network access to the Appwrite server.

Links and References

Discussion