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 topics. Specifically, the Create Topic operation allows users to create a new messaging topic by specifying a unique topic ID and a topic name. Topics are useful for organizing messages and subscribers in a publish-subscribe messaging system.

This node is beneficial when you want to programmatically create messaging topics within Appwrite to categorize or segment messages for different audiences or purposes. For example, you might create topics for different product updates, marketing campaigns, or user notification channels.

Practical example:

  • Creating a topic named "New Features" with a unique ID to send announcements about new product features to subscribed users.

Properties

Name Meaning
Topic ID Unique identifier for the topic. Can be generated automatically using unique() or provided manually.
Topic Name The display name of the topic.
Additional Fields (Not used in this operation)

Note: The bundled source code shows that the createTopic operation uses parameters "topicId" and "name" (mapped from "Topic Name") and an optional "subscribe" parameter which is not exposed in the provided properties JSON, so it is likely omitted here.

Output

The output is a JSON object representing the created messaging topic as returned by the Appwrite API. This typically includes details such as:

  • The topic's unique ID
  • The topic's name
  • Other metadata related to the topic creation response

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to Appwrite's API.
  • Needs credentials including:
    • Appwrite API URL
    • Project ID
    • An API key credential for authentication
  • The node depends on the node-appwrite SDK internally to communicate with Appwrite services.

Troubleshooting

  • Common issues:

    • Providing a non-unique or already existing Topic ID may cause errors.
    • Missing required parameters like Topic ID or Topic Name will result in validation errors.
    • Invalid or expired API credentials will prevent successful API calls.
    • Network connectivity issues can cause timeouts or failures.
  • Error messages:

    • Errors indicating duplicate topic IDs suggest choosing a different unique ID.
    • Authentication errors indicate checking API keys and project configuration.
    • Validation errors usually mean required fields are missing or malformed.

To resolve these, ensure all required inputs are correctly set, credentials are valid, and network access to Appwrite API is available.

Links and References

Discussion