ZAppwrite icon

ZAppwrite

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

Overview

This node operation allows you to create an Apple Push Notification Service (APNS) provider within the Appwrite platform via n8n. It is useful for setting up push notification services that send notifications to iOS devices. By configuring an APNS provider, you can manage and send push notifications through your Appwrite backend.

Typical use cases include:

  • Automating the creation of APNS providers as part of a deployment or setup workflow.
  • Integrating push notification capabilities into your app backend without manual configuration.
  • Managing multiple APNS providers programmatically.

For example, you might use this node to create a new APNS provider with your Apple developer credentials and specify whether to use the sandbox environment for testing.

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 APNS provider.
Auth Key The APNS authentication key (private key) used for signing push notifications.
Auth Key ID The identifier for the APNS authentication key.
Team ID Your Apple Developer Team ID associated with the APNS key.
Bundle ID The bundle identifier of your iOS app.
Sandbox Boolean flag indicating whether to use the APNS sandbox environment (true for testing).
Enabled Boolean flag indicating whether the provider is enabled after creation.

Additional Fields (not specific to APNS but available in messaging resource)

Name Meaning
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 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 object representing the newly created APNS provider. This typically includes details such as the provider ID, name, configuration parameters, status (enabled/disabled), and other metadata returned by the Appwrite API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to an Appwrite server with appropriate API credentials (URL, project ID, and API key).
  • The node uses the Appwrite SDK internally to communicate with the Appwrite backend.
  • Proper permissions on the Appwrite project to create messaging providers are necessary.

Troubleshooting

  • Invalid Credentials: If the provided Auth Key, Auth Key ID, Team ID, or Bundle ID are incorrect or missing, the creation will fail. Verify these values against your Apple Developer account.
  • Sandbox Flag Misconfiguration: Using the wrong environment (sandbox vs production) may cause push notifications not to be delivered. Ensure the Sandbox property matches your intended environment.
  • Duplicate Provider ID: If you provide a custom Provider ID that already exists, the operation may fail. Use unique() to generate a unique ID if unsure.
  • API Connection Issues: Network problems or incorrect Appwrite credentials will prevent the node from connecting. Check your Appwrite URL, project ID, and API key.
  • Permission Denied: Ensure the API key has sufficient permissions to create messaging providers.

Links and References

Discussion