This documentation refers to beta functionality and may be subject to frequent changes.
To learn more about events, and how to send them to Zaius, refer to the following:
Event Action | Fields |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
To learn more about creating Objects, Fields and Relationships and then updating newly created schema, refer to the following:
Object Name | Description |
Loyalty Tiers ( | Stores data about available Loyalty Tiers that customers can attain via loyal actions. |
Loyalty Referral Codes ( | Stores all available referral codes, metrics on sharing, |
Field Name | Type | Description |
| string | The ID of the tier that the customer was previously associated with. |
| string | The ID of the tier that the customer is now associated with. |
| number | The loyalty points balance of the customer before this event. |
| number | The loyalty points balance of the customer after this event. |
| number | The total change in loyalty points due to this event. |
| string | The unique referral code that this event applies to. |
| string | The email of the customer that was referred. |
To learn more about Customers in Zaius, refer to the following:
Field Name | Type | Description |
| number | The number of loyalty points that the customer currently has. |
| string | The unique Referral Code ID assigned to the customer. |
| string | The ID of the Loyalty Tier that the customer is associated with. |
| ts | The date & time that the customer record was created in the connected loyalty app. |
| ts | The date & time that the customer record was last updated in the connected loyalty app. |
| boolean | If true, the customer is currently enrolled in your loyalty program. |
Field Name | Type | Description |
| string | The unique identifier for a Loyalty Tier. |
| string | The name of the Loyalty Tier. |
| number | The numeric rank of this Loyalty tier relative to other Loyalty Tiers. |
| number | The amount of dollars required to be spent by a customer to reach this Loyalty Tier. |
| string | A description of this Loyalty Tier. |
| number | The number of points required to reach this Loyalty Tier. |
| number | The number of purchases required to reach this Loyalty Tier. |
Field Name | Type | Description |
| string | The unique referral code assigned to a customer. |
| number | The number of times that this referral code has been shared. |
| number | The number of orders that have resulted from this referral code. |
| number | The dollar amount of the number of orders that have resulted from this referral code. |
| ts | The date & time that the referral code expires, if it does. |
| boolean | Determines whether or not the referral code is expired. |
| number | The total number of clicks of the shared referral code URL. |
| string | The unique referral code URL. |
Name | Parent | Child |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|