ZAppwrite icon

ZAppwrite

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

Overview

The node integrates with Appwrite's Messaging API to create SMS messages. It allows users to send SMS by specifying message content and various optional parameters such as scheduling, targeting specific users or topics, and marking the message as a draft. This node is useful in scenarios where automated SMS notifications, alerts, or marketing messages need to be sent programmatically within an n8n workflow.

Practical examples:

  • Sending appointment reminders to customers via SMS.
  • Dispatching promotional SMS campaigns to selected user groups.
  • Scheduling SMS alerts for system status updates.

Properties

Name Meaning
Message ID Unique identifier for the message. Can use unique() to auto-generate or provide a custom ID.
Content The text content of the SMS message to be sent.
Additional Fields Collection of optional fields:
- Topics: Comma-separated list of topic IDs
- Users: Comma-separated list of user IDs
- Targets: Comma-separated list of target IDs
- Draft: Boolean indicating if the message is a draft
- Scheduled At: ISO 8601 formatted string for scheduled delivery time

Output

The node outputs a JSON object representing the created SMS message as returned by the Appwrite Messaging API. This typically includes details such as the message ID, content, status, timestamps, and any metadata related to the message dispatch.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to an Appwrite server with Messaging API enabled.
  • Needs credentials containing the Appwrite endpoint URL, project ID, and an API key credential with permissions to send messages.
  • Proper configuration of the Appwrite Messaging service and providers (e.g., SMS provider) is necessary for successful message delivery.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials can cause authentication failures.
    • Providing an invalid or duplicate Message ID may result in errors.
    • Incorrectly formatted scheduled time (not ISO 8601) can cause scheduling failures.
    • Specifying non-existent user, topic, or target IDs will prevent message delivery to those recipients.
  • Error messages and resolutions:

    • Authentication error: Verify that the API key and project ID are correct and have sufficient permissions.
    • Message ID conflict: Use unique() to generate a unique ID or ensure your custom ID does not already exist.
    • Invalid scheduledAt format: Ensure the date-time string follows ISO 8601 standard.
    • Recipient not found: Check that user, topic, and target IDs exist in the Appwrite messaging system.

Links and References

Discussion