ZAppwrite icon

ZAppwrite

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

Overview

This node operation allows you to create a new Telesign messaging provider within the Appwrite platform. Telesign is a communication service that enables sending SMS messages and other telephony-related functions. By creating a Telesign provider, you can configure your Appwrite project to send SMS messages through Telesign's API.

Common scenarios for this node include:

  • Setting up SMS notification services in your applications.
  • Automating user verification or alerts via SMS.
  • Integrating Telesign as a messaging backend in multi-channel communication workflows.

For example, you might use this node to register your Telesign credentials and phone number so that subsequent messaging operations can send SMS messages using Telesign.

Properties

Name Meaning
Provider ID Unique identifier for the provider. You can generate a random ID using unique() or provide a custom string.
Provider Name Human-readable name for the provider.
From Phone number from which SMS messages will be sent.
Customer ID Your Telesign Customer ID credential.
API Key Your Telesign API key credential (kept secret).
Enabled Boolean flag indicating whether the provider is enabled (true/false).
Additional Fields Collection of optional fields such as BCC, CC, draft status, sender email/name, HTML content flag, scheduled delivery time, and lists of targets, topics, or users. These are more relevant for email or push providers but are available as additional options.

Output

The output of this operation is a JSON object representing the newly created Telesign provider resource as returned by the Appwrite API. This typically includes details such as the provider ID, name, configuration, enabled status, and any metadata related to the provider setup.

No binary data output is involved in this operation.

Dependencies

  • Requires an active Appwrite project with API access configured.
  • Needs an API key credential with permissions to manage messaging providers.
  • Requires valid Telesign credentials: Customer ID and API Key.
  • The node uses the Appwrite SDK internally to communicate with the Appwrite server.

Troubleshooting

  • Invalid Credentials: If the Customer ID or API Key is incorrect or missing, the creation will fail. Verify your Telesign credentials.
  • Provider ID Conflicts: Using a non-unique Provider ID may cause conflicts. Use unique() to generate a unique ID if unsure.
  • Network Issues: Connectivity problems with the Appwrite server or Telesign API can cause errors. Check network access and firewall settings.
  • Permission Denied: Ensure the API key used has sufficient permissions to create messaging providers.
  • Missing Required Fields: Omitting required fields like Provider Name or From phone number will result in validation errors.

Links and References

Discussion