ZAppwrite icon

ZAppwrite

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

Overview

This node operation allows you to create a new messaging provider configured for the Textmagic service within the Appwrite platform. It is useful when you want to integrate Textmagic as a messaging provider to send SMS or other text-based messages through Appwrite's messaging API.

Typical use cases include:

  • Setting up Textmagic as an SMS provider in your application.
  • Automating the creation and configuration of messaging providers for scalable communication workflows.
  • Managing multiple messaging providers programmatically via n8n.

For example, you might use this node to register a new Textmagic provider with your account credentials and specify the phone number from which messages will be sent.

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 for the provider.
From Phone number that messages will be sent from.
Username Your Textmagic username used for authentication.
API Key Your Textmagic API key used for authentication (input is masked).
Enabled Boolean flag indicating whether the provider is enabled (true or false).

Output

The output JSON contains the response from the Appwrite API after creating the Textmagic messaging provider. This typically includes details about the newly created provider such as its ID, name, type, configuration, and status.

No binary data is output by this node operation.

Dependencies

  • Requires an active Appwrite project with the Messaging service enabled.
  • Requires valid credentials for the Appwrite API including URL, project ID, and an API key credential with permissions to manage messaging providers.
  • Requires valid Textmagic account credentials (username and API key) to configure the provider.

Troubleshooting

  • Invalid Credentials: If the Textmagic username or API key is incorrect, the provider creation will fail. Verify your Textmagic credentials before running the node.
  • Duplicate Provider ID: Using a non-unique provider ID may cause conflicts. Use unique() to generate a unique ID or ensure your custom ID does not already exist.
  • API Permission Errors: Ensure your Appwrite API key has sufficient permissions to create messaging providers.
  • Missing Required Fields: The node requires certain fields like Provider ID, Provider Name, Username, and API Key. Omitting these will result in errors.
  • Network Issues: Connectivity problems with the Appwrite server or Textmagic API can cause failures. Check network access and endpoint URLs.

Links and References

Discussion