ZAppwrite icon

ZAppwrite

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

Overview

The node integrates with Appwrite's Messaging API to manage and interact with messaging entities such as messages, providers, topics, subscribers, and logs. Specifically, the List Messages operation retrieves a list of messages from the configured Appwrite project.

This node is beneficial in scenarios where you want to automate workflows involving message management, such as fetching all messages for monitoring, reporting, or further processing within an automation pipeline. For example, you could use it to retrieve all email or push notification messages sent through your Appwrite backend and then analyze their status or content.

Properties

Name Meaning
Additional Fields Optional filters and query parameters to refine the list of messages returned. This includes:
- BCC: Comma-separated BCC email addresses
- CC: Comma-separated CC email addresses
- Draft: Whether the message is a draft (boolean)
- Enabled: Whether the provider is enabled (boolean)
- From Email: Sender email address
- From Name: Sender name
- HTML: Whether email content is HTML (boolean)
- Scheduled At: Scheduled delivery time in ISO 8601 format
- Targets: Comma-separated list of target IDs
- Topics: Comma-separated list of topic IDs
- Users: Comma-separated list of user IDs

Additionally, supports complex queries to filter results by attributes using operators like equal, greater than, less than, not equal, limit, offset, order ascending/descending, and search keywords.

Output

  • The output is a JSON array containing the list of messages retrieved from the Appwrite Messaging service.
  • Each item in the array represents a message object with its associated properties as returned by the Appwrite API.
  • The structure typically includes message metadata such as IDs, content, recipients, scheduling info, and status.
  • The node does not output binary data for this operation.

Dependencies

  • Requires an active connection to an Appwrite server with valid credentials including:
    • Appwrite endpoint URL
    • Project ID
    • An API key credential with permissions to access the Messaging service
  • The node uses the official Appwrite SDK internally to communicate with the API.
  • No additional external dependencies are required beyond the configured Appwrite credentials.

Troubleshooting

  • Common Issues:

    • Invalid or missing Appwrite credentials will cause authentication failures.
    • Incorrectly formatted query filters may result in empty responses or errors.
    • Network connectivity issues to the Appwrite server can cause request timeouts or failures.
  • Error Messages:

    • Authentication errors indicating invalid API keys or insufficient permissions require checking and updating the credentials.
    • Query syntax errors suggest reviewing the filter options and ensuring they conform to expected formats.
    • Timeout or network errors indicate connectivity problems; verify the Appwrite server URL and network access.
  • To resolve most issues, ensure that the Appwrite credentials are correctly set up in n8n, and that the query filters (if used) are properly constructed.

Links and References

Discussion