ZAppwrite icon

ZAppwrite

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

Overview

The node provides integration with Appwrite's Messaging API, allowing users to manage messaging topics and related entities. Specifically, the Delete Topic operation deletes a messaging topic identified by its Topic ID. This is useful for cleaning up unused or obsolete topics in your messaging system.

Common scenarios include:

  • Removing topics that are no longer relevant to your application.
  • Managing messaging infrastructure dynamically based on user actions or system events.
  • Automating cleanup tasks in workflows that handle messaging topics.

Example: If you have a topic used for sending notifications about a specific event and that event is deprecated, you can use this node operation to delete the associated topic programmatically.

Properties

Name Meaning
Topic ID The unique identifier of the topic to delete. You can generate a random ID using unique() or provide a custom ID.
Additional Fields A collection of optional fields (not specifically used in Delete Topic but available for other messaging operations). These include: BCC, CC, Draft, Enabled, From Email, From Name, HTML, Scheduled At, Targets, Topics, Users (all mostly related to message creation and management).

Note: For the Delete Topic operation, only the Topic ID property is required and used.

Output

The output JSON contains an object with a single property:

  • success: A boolean indicating whether the deletion was successful.

Example output:

[
  {
    "success": true
  }
]

This confirms that the topic was deleted successfully.

Dependencies

  • Requires an active connection to an Appwrite server via an API key credential configured in n8n.
  • The node uses the Appwrite SDK client initialized with the server URL, project ID, and API key.
  • Proper permissions must be granted to the API key to allow deleting messaging topics.

Troubleshooting

  • Common issues:

    • Invalid or missing Topic ID: Ensure the Topic ID provided exists and is correct.
    • Insufficient permissions: The API key used must have rights to delete messaging topics.
    • Network or connectivity problems with the Appwrite server.
  • Error messages:

    • Errors from the Appwrite API will be thrown if the topic does not exist or deletion is forbidden.
    • If the node fails, check the error message for details such as "Topic not found" or "Unauthorized".
  • Resolution tips:

    • Verify the Topic ID is correct and the topic exists.
    • Confirm API credentials and permissions.
    • Check network connectivity to the Appwrite server.

Links and References

Discussion