Webhook Events
Overview
Every event we can send to your webhooks.
When you configure a webhook, you choose which of the events below it receives. See Receiving Webhooks for how events are delivered.
Members
Events about the members of your loyalty program.
| Event | Description |
|---|---|
event_member_enrol | The User Enrollment event occurs whenever a new user enrolls in the TrueLoyal loyalty program. |
event_member_update | This event will occur when the member's attributes are changed. |
event_member_delete | The member delete event occurs whenever a user or users are deleted from the admin console. |
event_member_tierupgrade | The tier upgrade event occurs whenever a customer earns enough points to move up to a higher tier. |
event_member_tierdowngrade | The tier downgrade event occurs whenever a customer is downgraded to a lower tier for not having enough points to stay on the current tier. |
event_member_otp_generation | The member_otp_generation event occurs whenever a user requests an OTP for user authentication into the TrueLoyal loyalty program. |
Transactions
Events about members' points transactions.
| Event | Description |
|---|---|
event_points_earned | The Points Awarded event occurs when a user or users are awarded loyalty points. |
event_points_redeemed | The Points Redeemed event occurs whenever a user redeems his loyalty points. |
event_points_deducted | The Points Deducted event occurs whenever points are deducted from a user’s loyalty point balance. |
event_points_expired | The Points Expired event occurs whenever loyalty points in a customer's loyalty account balance expire. |
event_points_rejected | This event will occur whenever a user's or users pending points are rejected in moderation. |
Referrals
Events about the Refer a Friend activity.
| Event | Description |
|---|---|
event_friend_incentive_request | This event occurs when a friend clicks on the referral link shared by a user and enters their email to claim a reward. |
event_referral_link_share | This event will occur when the referral link is shared through email or via social channels. |
event_referral_success | This event will occur when the referred friend clicks on the referral link and makes his first purchase. |
System
Reminders and offers sent to members by the loyalty program.
| Event | Description |
|---|---|
event_winback_offer | The winback offer occurs when a user has been inactive for an extended period of time. |
event_available_rewards_reminder | The available rewards reminder event occurs when the user earns enough points to redeem rewards. |
event_points_expiration_reminder | The points expiration reminder occurs whenever a user's points are about to expire. |
event_rewards_within_reach_reminder | The rewards within reach reminder event occurs whenever a user earns 80% of the required points to redeem the reward. |
Campaigns
Events sent when members enter or exit a campaign.
| Event | Description |
|---|---|
event_campaign_entered | This event will occur when a member or members enter a campaign. |
event_campaign_exited | This event will occur when a member or members exit a campaign. |