ZAppwrite icon

ZAppwrite

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

Overview

This node operation allows you to create a new Vonage messaging provider within the Appwrite platform via n8n. It is useful when you want to integrate Vonage as a messaging service provider for sending SMS or other communications through Appwrite's messaging system.

Typical use cases include:

  • Setting up Vonage as a provider to send SMS notifications from your applications.
  • Automating the creation and configuration of Vonage providers in bulk or as part of deployment workflows.
  • Managing multiple messaging providers programmatically within Appwrite using n8n workflows.

For example, you might use this node to create a Vonage provider with specific API credentials and a sender phone number, enabling your app to send SMS messages through Vonage.

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 Vonage provider.
From Phone number that messages will be sent from.
API Key Vonage API key used for authentication.
API Secret Vonage API secret used for authentication.
Enabled Boolean flag indicating whether the provider is enabled (true) or disabled (false).
Additional Fields Optional extra fields such as BCC, CC, draft status, sender email/name, HTML content flag, scheduled delivery time, and target/topic/user IDs (comma-separated lists).

Additional Fields Options (subset relevant to messaging/email context)

  • BCC: Comma-separated list of BCC email addresses.
  • CC: Comma-separated list of CC email addresses.
  • Draft: Whether the message is a draft (boolean).
  • From Email: Sender email address.
  • From Name: Sender name.
  • HTML: Whether the 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.

Output

The output is a JSON array containing the response from the Appwrite API after creating the Vonage provider. This typically includes details about the newly created provider such as its ID, name, configuration, enabled status, and any metadata returned by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active Appwrite project with messaging capabilities enabled.
  • Requires valid Appwrite API credentials configured in n8n to authenticate requests.
  • Requires Vonage API credentials (API Key and API Secret) to configure the provider.
  • The node uses the Appwrite SDK internally to communicate with the Appwrite server.

Troubleshooting

  • Invalid Credentials: If the Vonage API key or secret are incorrect, the creation will fail. Verify your Vonage credentials before running the node.
  • Provider ID Conflicts: Using a non-unique provider ID that already exists may cause errors. Use unique() to generate a unique ID if unsure.
  • Missing Required Fields: Ensure all required properties (Provider ID, Provider Name, API Key, API Secret) are provided; otherwise, the node will throw validation errors.
  • Appwrite Connection Issues: Network or authentication issues with the Appwrite server can cause failures. Check your Appwrite credentials and network connectivity.
  • Disabled Provider: If the "Enabled" flag is set to false, the provider will be created but inactive, which may lead to unexpected behavior when sending messages.

Links and References

Discussion