Subscriber
In Wolfx, we call the entities designed to receive notifications as Subscribers.
Each subscriber is unique and identified by a unique subscriberId.
💡
We recommend using the internal unique id your application uses for a specific user as the subscriberId.
Each subscriber has the following data points:
- User Data: Data stored in the subscriber object that you can easily access in your workflow. This contains basic info such as first name, last name, avatar, locale, email and phone. This data is fixed and structured.
- Custom Data: Apart from the above fixed structured user data, any unstructured custom data such as user's address, nationality, height,... can also be stored
in the
targetfield using key-value pairs.
Subscriber attributes
subscriberId
string
required
Ex: 961c8859-bca9-49d3-9443-233c5888286c
firstName
string
optional
Ex: John
lastName
string
optional
Ex: Doe
email
string
required
phone
string
optional
Ex: +84339210xxx
avatar
string
optional
Ex: https://example.com/images/avatar.jpg
target
object
optional
{"key": "value"}
Create a subscriber
We support creating new subscriber using API (opens in a new tab).
Bulk Subscriber Creation
You can create subscribers in bulk (up to 500 at once) via the API (opens in a new tab)