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. Specifically, the Delete Subscriber operation removes a subscriber from a specified messaging topic. This is useful in scenarios where you want to stop sending messages or notifications to a particular subscriber, such as when a user unsubscribes from a mailing list or notification channel.

Practical examples:

  • Removing an email subscriber who has opted out of newsletters.
  • Deleting a push notification subscriber who no longer wants to receive alerts.
  • Cleaning up inactive or invalid subscriber entries from a messaging topic.

Properties

Name Meaning
Topic ID The unique identifier of the messaging topic from which the subscriber will be deleted.
Subscriber ID The unique identifier of the subscriber to delete from the specified topic.
Additional Fields (Not used specifically for this operation but available generally) Collection of optional fields like BCC, CC, draft status, enabled flag, sender details, HTML content flag, scheduled delivery time, and lists of targets, topics, or users.

Note: For the Delete Subscriber operation, only Topic ID and Subscriber ID are required and used.

Output

The output JSON contains a single field:

  • success: A boolean indicating whether the deletion was successful (true) or not (false).

Example output:

[
  {
    "success": true
  }
]

No binary data is produced by this operation.

Dependencies

  • Requires an active connection to an Appwrite server via an API key credential configured in n8n.
  • The node uses the Appwrite SDK internally to perform the API call.
  • Proper permissions on the Appwrite project to delete messaging subscribers are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Topic ID or Subscriber ID parameters.
    • Insufficient permissions or invalid API credentials.
    • Network connectivity problems to the Appwrite server.
    • Attempting to delete a subscriber that does not exist.
  • Error messages and resolutions:

    • "Resource not found": Check if the Topic ID and Subscriber ID are correct and exist.
    • "Unauthorized" or authentication errors: Verify that the API key credential is valid and has appropriate permissions.
    • "Network error": Ensure the Appwrite server URL is reachable from your environment.
    • If the node returns an error but you want the workflow to continue, enable the "Continue On Fail" option in the node settings.

Links and References

Discussion