ZAppwrite icon

ZAppwrite

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

Overview

The node integrates with the Appwrite platform's Messaging service to retrieve details of a specific message by its ID. This operation is useful when you want to fetch the content and metadata of an existing message, such as an email, push notification, or SMS, that was previously created or sent via Appwrite.

Common scenarios include:

  • Auditing or reviewing message contents after sending.
  • Fetching message status or logs for troubleshooting delivery issues.
  • Displaying message details in dashboards or reports.

Example: You have sent a transactional email through Appwrite and want to retrieve its full details (subject, content, recipients) later for verification or logging purposes.

Properties

Name Meaning
Message ID The unique identifier of the message to retrieve. Use unique() to generate a random ID or provide a custom ID.
Additional Fields Not applicable for this operation (only relevant for other messaging operations).

Output

The output JSON contains the detailed information of the requested message. This typically includes fields such as:

  • Message ID
  • Subject or title (depending on message type)
  • Content/body of the message
  • Recipients (users, targets, topics)
  • Metadata like draft status, scheduled time, CC/BCC lists (for emails)
  • Other message-specific properties depending on the message type (email, push, SMS)

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Appwrite API using an API key credential configured in n8n.
  • The node uses the Appwrite SDK internally to communicate with the Messaging service.
  • Proper permissions must be granted to the API key to access messaging resources.

Troubleshooting

  • Message not found error: If the provided Message ID does not exist, the node will throw an error indicating the message could not be retrieved. Verify the Message ID is correct.
  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to read messages.
  • Network or connectivity issues: Check network access to the Appwrite endpoint URL.
  • Invalid Message ID format: The Message ID should be a valid string; avoid empty or malformed IDs.

Links and References

Discussion