Actions84
- Avatar Actions
- Document Actions
- Function Actions
- Messaging Actions
- Create APNS Provider
- Create Email
- Create FCM Provider
- Create Mailgun Provider
- Create MSG91 Provider
- Create Provider
- Create Push
- Create Sendgrid Provider
- Create SMS
- Create SMTP Provider
- Create Subscriber
- Create Telesign Provider
- Create Textmagic Provider
- Create Topic
- Create Twilio Provider
- Create Vonage Provider
- Delete Provider
- Delete Subscriber
- Delete Topic
- Get Message
- Get Provider
- Get Subscriber
- Get Topic
- List Message Logs
- List Messages
- List Provider Logs
- List Providers
- List Subscriber Logs
- List Subscribers
- List Targets
- List Topic Logs
- List Topics
- Update APNS Provider
- Update Email
- Update FCM Provider
- Update Mailgun Provider
- Update MSG91 Provider
- Update Provider
- Update Push
- Update Sendgrid Provider
- Update SMS
- Update SMTP Provider
- Update Telesign Provider
- Update Textmagic Provider
- Update Topic
- Update Twilio Provider
- Update Vonage Provider
- Storage Actions
- Token Actions
- Users Actions
Overview
The node's Messaging - Create Subscriber operation allows you to add a new subscriber to a specific messaging topic within the Appwrite platform. This is useful for managing communication channels where messages are sent to multiple subscribers grouped under topics.
Typical use cases include:
- Adding users or endpoints as subscribers to notification topics.
- Managing subscription lists dynamically in workflows.
- Automating subscriber creation when onboarding new users or devices.
For example, you might create a subscriber with a unique ID linked to a target device or user ID under a given topic ID to receive push notifications or emails related to that topic.
Properties
| Name | Meaning |
|---|---|
| Topic ID | The identifier of the messaging topic to which the subscriber will be added. Use unique() to generate a random ID or provide a custom ID. |
| Subscriber ID | The identifier for the subscriber being created. Use unique() to generate a random ID or provide a custom ID. |
| Target ID | The target identifier associated with the subscriber (e.g., a user ID, device ID, or endpoint). |
Additional fields are available but not used directly in this operation based on the provided input properties.
Output
The output JSON contains the details of the newly created subscriber object returned by the Appwrite API. This typically includes:
- Subscriber ID
- Associated Topic ID
- Target ID
- Any metadata or status information related to the subscriber
No binary data output is involved in this operation.
Dependencies
Requires an active connection to the Appwrite API via configured credentials including:
- API URL
- Project ID
- An API key credential for authentication
The node uses the official Appwrite SDK internally to perform the subscriber creation.
Troubleshooting
Common issues:
- Invalid or missing Topic ID or Subscriber ID parameters.
- Target ID not provided or invalid.
- Authentication failures due to incorrect API credentials.
- Network connectivity issues to the Appwrite server.
Error messages and resolutions:
- "Resource not found" — Ensure the specified topic exists before adding subscribers.
- Authentication errors — Verify API key and project ID in credentials.
- Validation errors — Check that all required fields (Topic ID, Subscriber ID, Target ID) are correctly set and formatted.