ZAppwrite icon

ZAppwrite

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

Overview

This node operation allows you to create a new MSG91 messaging provider within the Appwrite platform via n8n. MSG91 is a cloud communication platform that enables sending SMS and other messaging services. By creating a MSG91 provider, you configure the necessary credentials and settings to send messages through MSG91 using Appwrite's messaging API.

Common scenarios for this node include:

  • Automating SMS notifications by setting up MSG91 as a messaging provider.
  • Integrating MSG91 messaging capabilities into workflows that require sending SMS alerts or marketing messages.
  • Managing multiple messaging providers centrally in Appwrite and selecting MSG91 for specific use cases.

Example: You want to send transactional SMS messages to users after they complete a purchase. First, you create a MSG91 provider with your MSG91 Auth Key and Sender ID, then use this provider in subsequent messaging operations.

Properties

Name Meaning
Provider ID Unique identifier for the provider. Use unique() to generate a random ID or provide a custom ID.
Provider Name The display name of the MSG91 provider.
Sender ID The MSG91 Sender ID used to identify the sender of the SMS messages.
Auth Key The MSG91 authentication key (API key) required to authorize requests to MSG91.
Enabled Boolean flag indicating whether the provider is enabled (true) or disabled (false).

Additional Fields (not specifically used in this operation but available generally)

  • BCC: Comma-separated list of BCC email addresses.
  • CC: Comma-separated list of CC email addresses.
  • Draft: Whether the message is a draft.
  • From Email: Sender email address.
  • From Name: Sender name.
  • HTML: Whether email content is HTML.
  • Scheduled At: Scheduled delivery time in ISO 8601 format.
  • Targets, Topics, Users: Comma-separated lists of target, topic, or user IDs.

Output

The output is a JSON object representing the newly created MSG91 messaging provider resource as returned by the Appwrite API. This typically includes details such as the provider ID, name, type, configuration parameters, and status (enabled/disabled).

No binary data output is involved in this operation.

Dependencies

  • Requires an active Appwrite project with messaging service enabled.
  • Requires valid credentials for Appwrite API access including URL, project ID, and an API key credential.
  • Requires a valid MSG91 account with an Auth Key and Sender ID to configure the provider.
  • The node uses the Appwrite SDK internally to communicate with the Appwrite server.

Troubleshooting

  • Invalid Auth Key or Sender ID: If the MSG91 credentials are incorrect or expired, the creation will fail. Verify your MSG91 account details.
  • Provider ID conflicts: Using a non-unique provider ID may cause errors. Use unique() to auto-generate a unique ID if unsure.
  • Appwrite API errors: Ensure your Appwrite credentials have sufficient permissions to create messaging providers.
  • Network issues: Connectivity problems between n8n and Appwrite server can cause failures; check network and firewall settings.

Links and References

Discussion