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 and related entities. Specifically, the Get Topic operation retrieves detailed information about a messaging topic identified by its unique Topic ID.

This node is useful in scenarios where you need to fetch metadata or configuration details of a specific messaging topic within your Appwrite project. For example, you might want to verify the existence of a topic before sending messages to it, or retrieve its subscription settings for auditing or automation purposes.

Practical examples:

  • Fetching a topic's details to confirm its subscription status.
  • Retrieving topic metadata to display in an admin dashboard.
  • Using topic information as part of a workflow that manages messaging subscriptions dynamically.

Properties

Name Meaning
Topic ID The unique identifier of the messaging topic to retrieve. You can generate a random ID using unique() or provide a custom string.
Additional Fields (Not applicable for Get Topic operation)

Output

The output JSON contains the detailed information of the requested messaging topic. This typically includes properties such as the topic's ID, name, subscription settings, creation date, and other metadata as provided by the Appwrite Messaging API.

No binary data is output by this operation.

Example output structure (simplified):

{
  "$id": "topicId",
  "name": "Topic Name",
  "subscribe": true,
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z"
}

Dependencies

  • Requires an active connection to an Appwrite server.
  • Needs credentials including the Appwrite endpoint URL, project ID, and an API key credential with permissions to access the Messaging service.
  • The node uses the official Appwrite SDK internally to perform API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing Topic ID parameter will cause the operation to fail.
    • Insufficient permissions or invalid API key may result in authorization errors.
    • Network connectivity problems to the Appwrite server can cause timeouts or connection failures.
  • Error messages:

    • "Resource not found": The specified Topic ID does not exist in the project.
    • "Unauthorized" or similar: Check that the API key credential has correct permissions.
    • "Invalid parameter": Verify that the Topic ID is correctly formatted and provided.
  • Resolution tips:

    • Ensure the Topic ID is correct and exists in your Appwrite project.
    • Confirm that the API key credential used has access to the Messaging resource.
    • Test connectivity to the Appwrite endpoint outside n8n to rule out network issues.

Links and References

Discussion