When configuring a webhook, you can choose the events you would like to receive payloads for. Subscribing only to the events that you are going to implement will help limit the HTTP requests to your server. Currently, the Zinrelo Loyalty Program supports the following events:

Sr.No.	Event Name	Event Type	Description
1.	Member Enrollment Event	event_member_enrol	When a new user enrolls in the loyalty program.
2.	Points Earned Event	event_points_earned	When points are awarded (approved) to a user.
3.	Points Redeemed Event	event_points_redeemed	When a user redeems points.
4.	Points Deducted Event	event_points_deducted	When points are deducted from a user’s loyalty points balance.
5.	Tier Upgrade Event	event_member_tierupgrade	When a customer upgrades to a higher tier.
6.	Tier Downgrade Event	event_member_tierdowngrade	When a customer downgrades to a lower tier.
7.	Points Expired Event	event_points_expired	When customer's points expire.
8.	Friend Incentive Request Event	event_friend_incentive_request	When a coupon is issued to the referrer for a successful referral.
9.	Member Updated Event	event_member_update	When the member's attributes are changed.
10.	Referral link shared via Email or Social Channels Event	event_referral_link_share	When the referral link is shared through email or via social channels.
11.	Referral Successful Event	event_referral_success	When the referred friend clicks on the referral link and makes his first purchase.
12.	Points Rejected Event	event_points_rejected	When a user's pending points are rejected in moderation.
13.	Member Deleted Event	event_member_delete	When a user is deleted from the admin console.
14.	Winback Offer Event	event_winback_offer	When a user has been inactive for an extended period of time.
15.	Available Rewards Reminder Event	event_available_rewards_reminder	When a user earns enough points to redeem rewards.
16.	Member OTP Generation Event	event_member_otp_generation	When a user requests an OTP for user authentication into the Zinrelo loyalty program.
17.	Points Expiration Reminder Event	event_points_expiration_reminder	When a user's points are about to expire.
18.	Rewards within reach Reminder Event	event_rewards_within_reach_reminder	When a user earns 80% of the required points to redeem the reward.
19.	Campaign Entered	event_campaign_entered	When a member or members enter a campaign.
20.	Campaign Exited	event_campaign_exited	When a member or members exit a campaign.

Member Enrollment Event

The User Enrollment event occurs whenever a new user enrolls in the Zinrelo loyalty program. The request body for this event contains the event type and payload in the format shown below:

{
  "request_id": "6332aec45fd7d2000d77b8a2",
  "total_count": 1,
  "events": [
    {
      "id": "6332aec49fe239670bc1bcde",
      "event_type": "event_member_enrol",
      "data": {
        "member_info": {
          "id": "6332aec45fd7d2000d77b89e",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "johndoe21",
          "member_status": "active",
          "member_tags": ["memberenrolled", "memberadded"],
          "number_of_purchases": 10,
          "number_of_redemptions": 1,
          "birthdate": "08/26/1989 00:00:00",
          "enrollment_date": "09/27/2022 00:00:00",
          "last_modified_date": "09/27/2022 00:00:00",
          "first_purchase_date": "10/26/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "12/29/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "12/29/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 500,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "12/29/2023 00:00:00"
          },
          "lifetime_points_earned": 10,
          "lifetime_points_expired": 0,
          "available_points": 100,
          "lifetime_points_deducted": 50,
          "lifetime_points_redeemed": 70,
          "referral_URL": "https://zinrelo.com/ref/JOH6FWL5",
          "custom_attributes": {
            "Nationality": "Indian"
          },
          "revenue": 200,
          "aov": 10,
          "deleted_date": null
        }
      }
    }
  ],
  "created_date": "09/27/2022 08:05:24"
}

Points Earned Event

The Points Awarded event occurs when a user or users are awarded loyalty points. In the case of activities where moderation is required, the event occurs once the points have been approved. The payload is shown below:

{
  "request_id": "638706181f4a31001225c480",
  "total_count": 2,
  "events": [
    {
      "id": "6387061987c5ca4b159b8377",
      "event_type": "event_points_earned",
      "data": {
        "member_info": {
          "id": "63805bc5d34967000d6a2c7f",
          "first_name": "Anna",
          "last_name": "Scott",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017134",
          "member_id": "annascott46778",
          "member_status": "active",
          "member_tags": "earnedpoints",
          "number_of_purchases": 13,
          "number_of_redemptions": 4,
          "birthdate": "07/16/1986 00:00:00",
          "enrollment_date": "11/25/2022 00:00:00",
          "last_modified_date": "11/30/2022 00:00:00",
          "first_purchase_date": "11/25/2022 00:00:00",
          "instagram_handle": "www.instagram.com/anna",
          "last_purchase_date": "11/30/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/anna",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "03/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualifid_points": 13,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "02/28/2023 23:59:59"
          },
          "referral_code": "TES7GQL4",
          "lifetime_points_earned": 514116,
          "lifetime_points_expired": 0,
          "available_points": 485762,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 28354,
          "referral_URL": "https://zinrelo.com/ref/TES7GQL4",
          "custom_attributes": {
            "City_Name": "Paris",
            "Marital_Status": "Married",
            "Income_Source": "Service",
            "Age_In_Years": "45",
            "Gender_Identity": "Female",
            "Graduation_Date": "15/12/1989 00:00:00"
          },
          "revenue": 13,
          "aov": null,
          "deleted_date": null
        },
        "transaction_info": {
          "id": "63805bc7d34967000c755c8d",
          "transaction_type": "award",
          "member_id": "annascott46778",
          "transaction_attributes": {
            "order_id": "order11990845",
            "coupon_code": "3199",
            "reason": "earnedpoints",
            "tags": "pointsawarded",
            "products": [
              {
                "product_id": "prod21",
                "product_price": "10",
                "product_title": "Shoes",
                "product_category": "Puma,shkoes,adi!@#",
                "product_quantity": "1",
                "product_url": "http://www.website.com/product1.html",
                "is_excluded": false,
                "bonus_multiplier": 0,
                "product_points_per_quantity": 10,
                "product_image_url": "https://nyoobserver.files.wordpress.com/2014/03/walking-stick.jpg"
              },
              {
                "product_id": "prod1m",
                "product_price": "10",
                "product_title": "Stick",
                "product_category": "mugs,cups,sale",
                "product_quantity": "1",
                "product_url": "http://www.website.com/product1.html",
                "is_excluded": false,
                "bonus_multiplier": 0,
                "product_points_per_quantity": 10,
                "product_image_url": "https://nyoobserver.files.wordpress.com/2014/04/walking-stick.jpg"
              },
              {
                 "product_id": "prod2m",
                "product_price": "10",
                "product_title": "Stick",
                "product_category": "mugs,cups,sale, floor, refresh",
                "product_quantity": "1",
                "product_url": "http://www.website.com/product1.html",
                "is_excluded": false,
                "bonus_multiplier": 0,
                "product_points_per_quantity": 10,
                "product_image_url": "https://nyoobserver.files.wordpress.com/2014/03/walking-stick.jpg"
              }
            ]
          },
          "approver_details": {
            "approver_id": null,
            "approver_name": "System"
          },
          "approved_date": "11/30/2022 07:28:23",
          "last_modified_date": "11/30/2022 07:28:23",
          "created_date": "11/30/2022 06:08:07",
          "award_info": {
            "activity_id": "made_a_purchase",
            "activity_name": "Purchase on website",
            "points_status": "approved",
            "points": 1
          },
          "points_expiration_date": "12/07/2022 14:54:58",
          "auto_approval_date": ""
        }
      }
    },
    {
      "id": "6387061987c5ca4b159b8378",
      "event_type": "event_points_earned",
      "data": {
        "member_info": {
          "id": "63805bc5d34967000d6a2c7f",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "537 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94307"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john.doe23",
          "member_status": "active",
          "member_tags": "pointsawarded",
          "number_of_purchases": 13,
          "number_of_redemptions": 4,
          "birthdate": "08/26/1986 00:00:00",
          "enrollment_date": "11/25/2022 00:00:00",
          "last_modified_date": "11/30/2022 00:00:00",
          "first_purchase_date": "11/25/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "11/30/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "current_period_start": "03/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 13,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "02/28/2023 23:59:59"
          },
          "referral_code": "TES7GQL4",
          "lifetime_points_earned": 514116,
          "lifetime_points_expired": 0,
          "available_points": 485762,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 28354,
          "referral_URL": "https://zinrelo.com/ref/TES7GQL4",
          "custom_attributes": {
            "City_Name": "Paris",
            "Marital_Status": "Married",
            "Income_Source": "Business",
            "Age_In_Years": "35",
            "Gender_Identity": "Male",
            "Graduation_Date": "03/12/2000 00:00:00"
          },
          "revenue": 13,
          "aov": 1.8,
          "deleted_date": null
        },
        "transaction_info": {
          "id": "63805f2b04d91e0012341d8f",
          "transaction_type": "award",
          "member_id": "john.doe23",
          "transaction_attributes": {
            "reason": "pointearned",
            "tags": []
          },
          "approver_details": {
            "approver_id": null,
            "approver_name": "System"
          },
          "approved_date": "11/30/2022 07:28:23",
          "last_modified_date": "11/30/2022 07:28:23",
          "created_date": "11/25/2022 06:22:35",
          "award_info": {
            "activity_id": "referral",
            "activity_name": "Refer a Friend",
            "points_status": "approved",
            "points": 9999
          },
          "points_expiration_date": "12/07/2022 14:54:58",
          "auto_approval_date": ""
        }
      }
    }
  ],
  "created_date": "11/30/2022 07:28:24"
}

Note: In the case of "submit_a_receipt" activity, the response will show "receipt_uid" in the "additional_data" field.

Points Redeemed Event

The Points Redeemed event occurs whenever a user redeems his loyalty points. The payload is shown below:

{
  "request_id": "6332b104700381000ae573bd",
  "total_count": 1,
  "events": [
    {
      "id": "6332b106fab4f0e2bf7cef24",
      "event_type": "event_points_redeemed",
      "data": {
        "member_info": {
          "id": "6329aced6d6081000a596007",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john_doe",
          "member_status": "active",
          "member_tags": [
            "redemption1",
            "redemption2"
          ],
          "number_of_purchases": 17,
          "number_of_redemptions": 1,
          "birthdate": "08/26/1989 00:00:00",
          "enrollment_date": "09/20/2022 00:00:00",
          "last_modified_date": "09/27/2022 00:00:00",
          "first_purchase_date": "09/20/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "09/26/2022 00:00:00",
          "anniversary_date": "02/11/2020 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "12/29/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 500,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "12/29/2023 00:00:00"
          },
          "lifetime_points_earned": 0,
          "lifetime_points_expired": 0,
          "available_points": 4752,
          "lifetime_points_deducted": 28,
          "lifetime_points_redeemed": 500,
          "referral_URL": "https://zinrelo.com/ref/JOH350RU",
          "custom_attributes": {
            "Nationality": "American"
          },
          "revenue": 500,
          "aov": 120,
          "deleted_date": null
        },
        "transaction_info": {
          "id": "6332b103700381000ae573bb",
          "transaction_type": "redeem",
          "member_id": "john_doe",
          "transaction_attributes": {
            "tags": ["pointsredeemed", "redemptionmade"],
            "reason": "purchasemade",
            "source_of_redemption": "manual"
          },
          "approver_details": {
            "approver_id": null,
            "approver_name": "System"
          },
          "approved_date": "11/27/2022 08:14:59",
          "last_modified_date": "11/27/2022 08:14:59",
          "created_date": "11/27/2022 08:14:59",
          "reward_info": {
            "reward_id": "reward_5c45d",
            "reward_name": "&#36;5 OFF COUPON",
            "points_status": "redeemed",
            "points": 500,
            "coupon_code": "500DSRM",
            "reward_link": null
          }
        }
      }
    }
  ],
  "created_date": "09/27/2022 08:15:00"
}

Points Deducted Event

The Points Deducted event occurs whenever points are deducted from a user’s loyalty point balance. The points can be deducted from the Zinrelo store or by using API calls. The payload is shown below:

{
  "request_id": "6332b44fa9f094000beae74e",
  "total_count": 1,
  "events": [
    {
      "id": "6332b44f6810fce4d056292c",
      "event_type": "event_points_deducted",
      "data": {
        "member_info": {
          "id": "6332aec45fd7d2000d77b89e",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "johndoe21",
          "member_status": "active",
          "member_tags": ["deduction1", "deduction2"],
          "number_of_purchases": 1,
          "number_of_redemptions": 0,
          "birthdate": "08/26/1989 00:00:00",
          "enrollment_date": "09/27/2022 00:00:00",
          "last_modified_date": "09/27/2022 00:00:00",
          "first_purchase_date": "09/27/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "09/27/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "01/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 60000,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "12/31/2022 23:59:59"
          },
          "lifetime_points_earned": 0,
          "lifetime_points_expired": 0,
          "available_points": 54100,
          "lifetime_points_deducted": 6000,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://zinrelo.com/ref/JOH6FWL5",
          "custom_attributes": {
            "Number of purchases": 1
          },
          "revenue": 6000,
          "aov": 100,
          "deleted_date": null
        },
        "transaction_info": {
          "id": "6332b44fa9f094000beae74c",
          "transaction_type": "deduct",
          "member_id": "johndoe21",
          "transaction_attributes": {
            "reason": "return",
            "tags": ["deductionmade", "pointsdeducted"]
          },
          "approver_details": {
            "approver_id": null,
            "approver_name": "System"
          },
          "approved_date": "11/27/2022 08:29:03",
          "last_modified_date": "11/27/2022 08:29:03",
          "created_date": "11/27/2022 08:29:03",
          "deduct_info": {
            "points_status": "deducted",
            "points": 6000
          }
        }
      }
    }
  ],
  "created_date": "09/27/2022 08:29:03"
}

Tier Upgrade Event

The tier upgrade event occurs whenever a customer earns enough points to move up to a higher tier. The tier upgrade is processed immediately, and the webhook is triggered at the time of the upgrade. The payload is shown below:

{
  "request_id": "6332b666700381000d0dc366",
  "total_count": 1,
  "events": [
    {
      "id": "6332b669673e44cc09b78c0c",
      "event_type": "event_member_tierupgrade",
      "data": {
        "member_info": {
          "id": "632c66dbf4dc13000bed3f3b",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john_doe",
          "member_status": "active",
          "member_tags": [
            "ab1",
            "ab2"
          ],
          "number_of_purchases": 4,
          "number_of_redemptions": 0,
          "birthdate": "09/09/1900 00:00:00",
          "enrollment_date": "09/22/2022 00:00:00",
          "last_modified_date": "09/27/2022 00:00:00",
          "first_purchase_date": "09/26/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "09/27/2022 00:00:00",
          "anniversary_date": "02/11/2020 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "01/01/2022 00:00:00",
            "loyalty_tier_name": "Gold",
            "qualified_points": 1000,
            "loyalty_tier_id": "zrl_gold",
            "current_period_end": "12/31/2022 23:59:59"
          },
          "lifetime_points_earned": 0,
          "lifetime_points_expired": 0,
          "available_points": 1060,
          "lifetime_points_deducted": 100,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://zinrelo.com/ref/JOH81EEI",
          "custom_attributes": {
            "Favourite Destination": "London"
          },
          "revenue": 106,
          "aov": 1.5,
          "deleted_date": null
        }
      }
    }
  ],
  "created_date": "09/27/2022 08:37:58"
}

Tier Downgrade Event

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. The tier downgrade criteria are evaluated at the end of a "Tier Evaluation Period" and also when points are deducted. The payload is shown below:

{
  "request_id": "63340d3ab63c5d000b65ab31",
  "total_count": 1,
  "events": [
    {
      "id": "63340d3b561d49af9f5ce4c0",
      "event_type": "event_member_tierdowngrade",
      "data": {
        "member_info": {
          "id": "6333fba90ae9d6000b38e518",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john_doe",
          "member_status": "active",
          "member_tags": ["member1", "member2"],
          "number_of_purchases": 7,
          "number_of_redemptions": 0,
          "birthdate": "08/26/1989 00:00:00",
          "enrollment_date": "09/28/2022 00:00:00",
          "last_modified_date": "09/28/2022 00:00:00",
          "first_purchase_date": "09/28/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "09/28/2022 00:00:00",
          "anniversary_date": "12/06/1989 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "09/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 0,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "09/30/2022 23:59:59"
          },
          "lifetime_points_earned": 900,
          "lifetime_points_expired": 0,
          "available_points": 900,
          "lifetime_points_deducted": 6200,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://zinrelo.com/ref/JOH1L48L",
          "custom_attributes":  {
            "Last traveled": "London"
          },
          "revenue": 700,
          "aov": 7,
          "deleted_date": null
        }
      }
    }
  ],
  "created_date": "09/28/2022 09:00:42"
}

Points Expired Event

The Points Expired event occurs whenever loyalty points in a customer's loyalty account balance expire. This event is triggered as soon as the status of the points is marked as expired. The payload is shown below:

{
  "request_id": "63341215563aef00174f73a7",
  "total_count": 1,
  "events": [
    {
      "id": "6334121b4f113d58b2ed3ef5",
      "event_type": "event_points_expired",
      "data": {
        "member_info": {
          "id": "6329aeaddee54a000cbce5ec",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john_doe",
          "member_status": "active",
          "member_tags": ["member1", "member2"],
          "number_of_purchases": 10,
          "number_of_redemptions": 0,
          "birthdate": "09/21/1900 00:00:00",
          "enrollment_date": "09/20/2022 00:00:00",
          "last_modified_date": "09/28/2022 00:00:00",
          "first_purchase_date": "09/20/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "09/21/2022 00:00:00",
          "anniversary_date": "09/21/1900 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "09/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 10390,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "09/30/2022 23:59:59"
          },
          "lifetime_points_earned": 11034,
          "lifetime_points_expired": 11034,
          "available_points": 0,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://zinrelo.com/ref/JOH7EI9V",
          "custom_attributes": {
            "Gender": "Male",
            "Number of purchases": 1,
            "List of favourite place": ["London" "Paris"],
            "Review date": "12/10/2022 00:00:00"
          },
          "revenue": 1000,
          "aov": 10,
          "deleted_date": null
        },
        "transaction_info": {
          "id": "632acf6cdee54a000b092934",
          "transaction_type": "award",
          "member_id": "john_doe",
          "expiry_info": {
            "points_status": "expired",
            "points": 1000
          },
          "approved_date": "09/21/2022 08:46:36",
          "approver_details": {
            "approver_id": null,
            "approver_name": "System"
          },
          "last_modified_date": "09/28/2022 09:10:17",
          "created_date": "09/21/2022 08:46:35"
        }
      }
    }
  ],
  "created_date": "09/28/2022 09:21:24"
}

Friend Incentive Request Event

This event occurs when a friend clicks on the referral link shared by a user and enters their email to claim a reward. This event is related to the "Refer a Friend" activity. This event is triggered as soon as the coupon is dispatched to the friend's email address. The payload is shown below:

 {
  "request_id": "6333fb9e1ddab5000ba5e74a",
  "total_count": 1,
  "events": [
    {
      "id": "6333fba0fa6dbb793c3ecb73",
      "event_type": "event_friend_incentive_request",
      "data": {
        "friend_info": {
          "email_address": "[email protected]"
        },
        "incentive_info": {
          "coupon": "FRIEND10",
          "referrer_info": {
            "referral_link": "https://zinrelo.com/ref/WEB7AMEU",
            "member_id": "anna598",
            "id": "63b3ec0a4df04512da0882d3"
          }
        }
      }
    }
  ],
  "created_date": "09/28/2022 07:45:34"
}

When a friend is already enrolled in the program, he will see the following payload when he clicks the referral link:

{
  "request_id": "6336e12cca5ac5000af2805e",
  "total_count": 1,
  "events": [
    {
      "id": "6336e12eeecc0c196e9e50d7",
      "event_type": "event_friend_incentive_request",
      "data": {
        "friend_info": {
          "id": "633689b8fe0c0000093bc10a",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "johndoe55",
          "member_status": "active",
          "member_tags": ["member1", "member2"],
          "number_of_purchases": 1,
          "number_of_redemptions": 0,
          "birthdate": "08/26/1989 00:00:00",
          "enrollment_date": "09/30/2022 00:00:00",
          "last_modified_date": "09/30/2022 00:00:00",
          "first_purchase_date": "09/30/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "09/30/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "09/01/2022 00:00:00",
            "loyalty_tier_name": "Gold",
            "qualified_points": 1000,
            "loyalty_tier_id": "zrl_gold",
            "current_period_end": "09/30/2022 23:59:59"
          },
          "lifetime_points_earned": 1100,
          "lifetime_points_expired": 0,
          "available_points": 1100,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 0,
          "referral_URL": "zinrelo.com/ref/JOH1HQK8",
          "custom_attributes": {
            "Gender": ["Male", "Female"],
            "Number of purchases": 1,
            "List of favourite place": ["London" "Paris"],
            "Review date": "12/10/2022 00:00:00"
          },
          "revenue": 100,
          "aov": 1.7,
          "deleted_date": null
        }
      }
    }
  ],
  "created_date": "09/30/2022 12:29:32"
}

Member Updated Event

This event will occur when the member's attributes are changed. The payload is shown below:

{
  "request_id": "6332b7ea700381000c191cd6",
  "total_count": 1,
  "events": [
    {
      "id": "6332b7eb673e44cc09b78c0e",
      "event_type": "event_member_update",
      "data": {
        "member_info": {
          "id": "632c66dbf4dc13000bed3f3b",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "jd",
          "member_status": "active",
          "member_tags": [
            "ab1",
            "ab2"
          ],
          "number_of_purchases": 4,
          "number_of_redemptions": 0,
          "birthdate": "09/09/1900 00:00:00",
          "enrollment_date": "09/22/2022 00:00:00",
          "last_modified_date": "09/27/2022 00:00:00",
          "first_purchase_date": "09/26/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "09/27/2022 00:00:00",
          "anniversary_date": "02/11/2020 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "01/01/2022 00:00:00",
            "loyalty_tier_name": "Gold",
            "qualified_points": 0,
            "loyalty_tier_id": "zrl_gold",
            "current_period_end": "12/31/2022 23:59:59"
          },
          "lifetime_points_earned": 0,
          "lifetime_points_expired": 0,
          "available_points": 1060,
          "lifetime_points_deducted": 100,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://zinrelo.com/ref/JOH81EEI",
          "custom_attributes": {
            "traveled destination": "Europe"
          },
          "revenue": 106,
          "aov": 1.2,
          "deleted_date": null
        }
      }
    }
  ],
  "created_date": "09/27/2022 08:44:26"
}

Referral link shared via Email or Social Channels Event

This event will occur when the referral link is shared through email or via social channels. Only the shared_event will change to email or Twitter; the rest of the payload will be the same. The payload is shown below:

{
  "request_id": "635f612657041f0011f38144",
  "total_count": 1,
  "events": [
    {
      "data": {
        "member_info": {
          "last_name": "Scott",
          "twitter_handle": "www.twitter.cpm/anna",
          "revenue": 0,
          "lifetime_points_expired": 0,
          "last_modified_date": "10/17/2022 00:00:00",
          "available_points": 3400,
          "lifetime_points_earned": 3400,
          "referral_URL": "https://zinrelo.com/ref/ANNA2Q49X",
          "member_status": "active",
          "email_address": "[email protected]",
          "id": "632c664bf860bf0516e2d26f",
          "first_name": "Anna",
          "member_tags": [
            "referralshared",
            "referralapproved"
          ],
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "12/20/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 1000,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": null
          },
          "custom_attributes": {
            "Number of purchases": 2
          },
          "first_purchase_date": "10/20/2022 00:00:00",
          "lifetime_points_deducted": 0,
          "phone_number": "+1-6507017756",
          "instagram_handle": "www.instagram.com/anna",
          "aov": 20,
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "deleted_date": null,
          "last_purchase_date": "12/18/2022 00:00:00",
          "lifetime_points_redeemed": 100,
          "preferred_language": "English",
          "number_of_purchases": 4,
          "number_of_redemptions": 1,
          "birthdate": "10/31/1987 00:00:00",
          "anniversary_date": "10/29/2022 00:00:00",
          "enrollment_date": "09/22/2022 00:00:00",
          "member_id": "anna.scott234"
        },
        "share_info": {
          "channel_shared": "email"
        },
        "email_share_info": {
          "friend_email": [
            "[email protected]",
            "[email protected]",
            "[email protected]"
          ]
        }
      },
      "event_type": "event_referral_link_share",
      "id": "634d3789f21e109d10119c57"
    }
  ],
  "created_date": "10/31/2022 05:46:14"
}

Note: When the referral is shared through social channels, the email_share_info will not be in the payload.

The payload will look like this:

{
  "request_id": "635f612657041f0011f38144",
  "total_count": 1,
  "events": [
    {
      "data": {
        "member_info": {
          "last_name": "Scott",
          "twitter_handle": "www.twitter.com/anna",
          "revenue": 0,
          "lifetime_points_expired": 0,
          "last_modified_date": "10/17/2022 00:00:00",
          "available_points": 3400,
          "lifetime_points_earned": 3400,
          "referral_URL": "https://zinrelo.com/ref/ANNA2Q49X",
          "member_status": "active",
          "email_address": "[email protected]",
          "id": "632c664bf860bf0516e2d26f",
          "first_name": "Anna",
          "member_tags": [
            "referralshared",
            "referralapproved"
          ],
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "12/20/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 0,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "12/20/2023 00:00:00"
          },
          "custom_attributes": {
            "Preferences": "T-shirt"
          },
          "first_purchase_date": "10/20/2022 00:00:00",
          "lifetime_points_deducted": 0,
          "phone_number": "+1-6507017756",
          "instagram_handle": "www.instagram.com/anna",
          "aov": 5,
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "deleted_date": null,
          "last_purchase_date": "12/18/2022 00:00:00",
          "lifetime_points_redeemed": 100,
          "preferred_language": "English",
          "number_of_purchases": 4,
          "number_of_redemptions": 1,
          "birthdate": "10/31/1987 00:00:00",
          "anniversary_date": "10/29/2022 00:00:00",
          "enrollment_date": "09/22/2022 00:00:00",
          "member_id": "anna.scott234"
        },
        "share_info": {
          "channel_shared": "twitter"
        }
      },
      "event_type": "event_referral_link_share",
      "id": "634d3789f21e109d10119c57"
    }
  ],
  "created_date": "10/31/2022 05:46:14"
}

Referral Successful Event

This event will occur when the referred friend clicks on the referral link and makes his first purchase. The payload is shown below:

{
  "request_id": "638718fdf9e076000ab268f6",
  "total_count": 1,
  "events": [
    {
      "id": "638718ff5efcad6bb4286b36",
      "event_type": "event_referral_success",
      "data": {
        "friend_info": {
          "id": "638718faf9e07600094f239c",
          "first_name": "Anna",
          "last_name": "Scott",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017756",
          "member_id": "anna.scott286",
          "member_status": "active",
          "member_tags": ["referral", "referredfriend"],
          "number_of_purchases": 1,
          "number_of_redemptions": 0,
          "birthdate": "10/31/1987 00:00:00",
          "enrollment_date": "11/30/2022 00:00:00",
          "last_modified_date": "11/30/2022 00:00:00",
          "first_purchase_date": "11/30/2022 00:00:00",
          "instagram_handle": "www.instagram.com/anna",
          "last_purchase_date": "11/30/2022 00:00:00",
          "anniversary_date": "10/29/2022 00:00:00",
          "twitter_handle": "www.twitter.com/anna",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "03/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 1190,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "02/28/2023 23:59:59"
          },
          "referral_code": "TES855D6",
          "lifetime_points_earned": 1200,
          "lifetime_points_expired": 0,
          "available_points": 1200,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://shopsocially.com/ref/TES855D6",
          "custom_attributes": {
            "City_Name": "Paris",
            "Marital_Status": "Married",
            "Income_Source": "Service",
            "Age_In_Years": "45",
            "Gender_Identity": "Female",
            "Graduation_Date": "15/12/1989 00:00:00"
          },
          "revenue": 1190,
          "aov": 20,
          "deleted_date": null
        },
        "referrer_info": {
          "id": "63870ad3f9e076000b1ab907",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john.doe23",
          "member_status": "active",
          "member_tags": ["referrer", "referred"],
          "number_of_purchases": 2,
          "number_of_redemptions": 2,
          "birthdate": "08/26/1989 00:00:00",
          "enrollment_date": "11/30/2022 00:00:00",
          "last_modified_date": "11/30/2022 00:00:00",
          "first_purchase_date": "11/30/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "11/30/2022 00:00:00",
          "anniversary_date": "05/03/2021 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "current_period_start": "03/01/2022 00:00:00",
            "loyalty_tier_name": "Max-Pro",
            "qualified_points": 2380,
            "loyalty_tier_id": "tier_cb4b5",
            "current_period_end": "02/28/2023 23:59:59"
          },
          "referral_code": "SAM02XIU",
          "lifetime_points_earned": 38035,
          "lifetime_points_expired": 0,
          "available_points": 12681,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 25354,
          "referral_URL": "https://shopsocially.com/ref/SAM02XIU",
          "custom_attributes": {
            "City_Name": "Paris",
            "Marital_Status": "Married",
            "Income_Source": "Business",
            "Age_In_Years": "35",
            "Gender_Identity": "Male",
            "Graduation_Date": "03/12/2000 00:00:00"
          },
          "revenue": 2380,
          "aov": null,
          "deleted_date": null
        },
        "referral_success_activity_info": {
          "activity_id": "made_a_purchase",
          "activity_name": "Purchase on website",
          "order_info": {
            "order_total": "600",
            "currency": "USD",
            "order_id": "order13401703",
            "order_subtotal": "1190",
            "reason": "reference",
            "device_type": "desktop",
            "coupons": "3199"
          }
        },
        "referrer_reward_info": [
          {
            "id": "638718fcf9e076000ab268e4",
            "transaction_type": "award",
            "member_id": "johndoe55",
            "transaction_attributes": {
              "reason": "referredafriend",
              "tags": []
            },
            "approver_details": {
              "approver_id": null,
              "approver_name": "System"
            },
            "approved_date": "11/30/2022 08:49:00",
            "last_modified_date": "11/30/2022 08:49:00",
            "created_date": "11/30/2022 08:49:00",
            "award_info": {
              "activity_id": "referral",
              "activity_name": "Refer a Friend",
              "points_status": "approved",
              "points": 35645
            },
            "points_expiration_date": "12/10/2022 08:49:00",
            "auto_approval_date": ""
          },
          {
            "id": "638718fdf9e076000ab268f1",
            "transaction_type": "coupon_award",
            "member_id": "john.doe23",
            "transaction_attributes": {
              "reason": "reference",
              "tags": []
            },
            "approver_details": {
              "approver_id": null,
              "approver_name": "System"
            },
            "approved_date": "11/30/2022 08:49:01",
            "last_modified_date": "11/30/2022 08:49:01",
            "created_date": "11/30/2022 08:49:01",
            "award_info": {
                "coupon_code": "34",
                "activity_id": "referral",
                "points": 0,
                "points_status": "approved",
                "activity_name": "Refer a Friend"
            }
          }
        ]
      }
    }
  ],
  "created_date": "11/30/2022 08:49:01"
}

Note: The order_info field will be null for all activities other than purchase activities.

If a guest makes a purchase and is not enrolled in the loyalty program, the friend info in payload will appear as follows:

    "friend_info": {
        "email_address": "[email protected]",
        "member_id": "anna.scott286"
    }

Points Rejected Event

This event will occur whenever a user's or users pending points are rejected in moderation. The payload is shown below:

{
  "request_id": "638705ba3541f8000e30bd4d",
  "total_count": 2,
  "events": [
    {
      "id": "638705bb87c5ca4b159b8373",
      "event_type": "event_points_rejected",
      "data": {
        "member_info": {
          "id": "63805f96d34967000b5111ed",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john.doe23",
          "member_status": "active",
          "member_tags": [
            "rejected",
            "pushedback",
            "purchaserejected"
                      ],
          "number_of_purchases": 0,
          "number_of_redemptions": 0,
          "birthdate": "01/31/1900 00:00:00",
          "enrollment_date": "11/25/2022 00:00:00",
          "last_modified_date": "11/25/2022 00:00:00",
          "first_purchase_date": "11/25/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "11/25/2022 00:00:00",
          "anniversary_date": "11/25/2022 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "03/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 0,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "02/28/2023 23:59:59"
          },
          "referral_code": "K1718C2A",
          "lifetime_points_earned": 100,
          "lifetime_points_expired": 0,
          "available_points": 100,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://zinrelo.com/ref/K1718C2A",
          "custom_attributes": {
            "City_Name": "Paris",
            "Marital_Status": "Married",
            "Income_Source": "Business",
            "Age_In_Years": "35",
            "Gender_Identity": "Male",
            "Graduation_Date": "03/12/2000 00:00:00"
          },
          "revenue": 0,
          "aov": 0,
          "deleted_date": null
        },
        "transaction_info": {
          "id": "63806091d34967000a27a8c0",
          "transaction_type": "award",
          "member_id": "john.doe23",
          "transaction_attributes": {
            "order_id": "N17987314111q1ewy28971",
            "coupon_code": "A1346BC",
            "reason": "THird",
            "tags": [
              "purchasereturned",
              "rejected"
            ],
            "pow_01": null,
            "products": [
              {
                "product_id": "9801198",
                "product_price": "50",
                "product_title": "RelaxedFitSweatshirt-Mintgreen",
                "product_category": "Essentials",
                "product_quantity": "1",
                "product_url": null,
                "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/[email protected]?v=1528970252"
              },
              {
                "product_id": "98012",
                "product_price": "25",
                "product_title": "Sweatshirt",
                "product_category": "Sale",
                "product_quantity": "2",
                "product_url": null,
                "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/[email protected]?v=1528970252"
              }
            ],
            "order_subtotal": 1,
            "order_total": 110,
            "coupons": "a",
            "currency": "$"
          },
          "approver_details": {
            "approver_id": null,
            "approver_name": "System"
          },
          "approved_date": "",
          "last_modified_date": "11/30/2022 07:26:50",
          "created_date": "11/25/2022 06:28:32",
          "award_info": {
            "activity_id": "made_a_purchase",
            "activity_name": "Purchase on website",
            "points_status": "rejected",
            "points": 1
          },
          "points_expiration_date": "12/05/2022 06:28:32",
          "auto_approval_date": ""
        }
      }
    },
    {
      "id": "638705bb87c5ca4b159b8374",
      "event_type": "event_points_rejected",
      "data": {
        "member_info": {
          "id": "63805f2ad34967000b5111e2",
          "first_name": "Anna",
          "last_name": "Scott",
          "email_address": "[email protected]",
          "address": {
            "city": "Superior",
            "country": "US",
            "line2": "",
            "line1": "1000 S. McCaslin Blvd., Suite 301",
            "state": "CO",
            "postal_code": "15702"
          },
          "phone_number": "+82-1234567890",
          "member_id": "anna.scott286",
          "member_status": "active",
          "member_tags": [
            "maderejected",
            "rejected"
          ],
          "number_of_purchases": 0,
          "number_of_redemptions": 0,
          "birthdate": "01/31/1900 00:00:00",
          "enrollment_date": "11/25/2022 00:00:00",
          "last_modified_date": "11/25/2022 00:00:00",
          "first_purchase_date": "11/25/2022 00:00:00",
          "instagram_handle": "www.instagram.com/anna",
          "last_purchase_date": "12/12/2022 00:00:00",
          "anniversary_date": "11/25/2022 00:00:00",
          "twitter_handle": "www.twitter.com/anna",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "03/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 0,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "02/28/2023 23:59:59"
          },
          "referral_code": "K171XD9M",
          "lifetime_points_earned": 100,
          "lifetime_points_expired": 0,
          "available_points": 100,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://zinrelo.com/ref/K171XD9M",
          "custom_attributes": {
            "City_Name": "Paris",
            "Marital_Status": "Married",
            "Income_Source": "Service",
            "Age_In_Years": "45",
            "Gender_Identity": "Female",
            "Graduation_Date": "15/12/1989 00:00:00"
          },
          "revenue": 0,
          "aov": 0,
          "deleted_date": null
        },
        "transaction_info": {
          "id": "638060e7d34967000a27a8d9",
          "transaction_type": "award",
          "member_id": "anna.scott286",
          "transaction_attributes": {
            "order_id": "N17987314111q1eswy28971",
            "coupon_code": "a",
            "reason": "THird",
            "tags": [
              "reject",
              "rejectionmade"
            ],
            "pow_01": null,
            "products": [
              {
                "product_id": "9801198",
                "product_price": "50",
                "product_title": "RelaxedFitSweatshirt-Mintgreen",
                "product_category": "Essentials",
                "product_quantity": "1",
                "product_url": null,
                "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/[email protected]?v=1528970252"
              },
              {
                "product_id": "98012",
                "product_price": "25",
                "product_title": "Sweatshirt",
                "product_category": "Sale",
                "product_quantity": "2",
                "product_url": null,
                "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/[email protected]?v=1528970252"
              }
            ],
            "order_subtotal": 1,
            "order_total": 110,
            "coupons": "a",
            "currency": "$"
          },
          "approver_details": {
            "approver_id": null,
            "approver_name": "System"
          },
          "approved_date": "",
          "last_modified_date": "11/30/2022 07:26:50",
          "created_date": "11/25/2022 06:29:59",
          "award_info": {
            "activity_id": "made_a_purchase",
            "activity_name": "Purchase on website",
            "points_status": "rejected",
            "points": 1
          },
          "points_expiration_date": "12/05/2022 06:29:59",
          "auto_approval_date": ""
        }
      }
    }
  ],
  "created_date": "11/30/2022 07:26:50"
}

Winback Offer Event

The winback offer occurs when a user has been inactive for an extended period of time. The payload is shown below:

{
  "request_id": "638729c94f8f0345970b6d96",
  "total_count": 1,
  "events": [
    {
      "id": "63872a654f8f0345970b6d99",
      "event_type": "event_winback_offer",
      "data": {
        "member_info": {
          "id": "john286",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john.doe23",
          "member_status": "active",
          "member_tags": "winbackmember",
          "number_of_purchases": 7,
          "number_of_redemptions": 3,
          "birthdate": "08/26/1986 00:00:00",
          "enrollment_date": "02/05/2022 00:00:00",
          "last_modified_date": "12/10/2022 00:00:00",
          "first_purchase_date": "02/05/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "12/10/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "03/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 1000,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "02/28/2023 23:59:59"
          },
          "referral_code": "ERGH12309",
          "lifetime_points_earned": 5000,
          "lifetime_points_expired": 0,
          "available_points": 5000,
          "lifetime_points_deducted": 100,
          "lifetime_points_redeemed": 1000,
          "referral_URL": "https://zinrelo.com/ref/ERGH12309",
          "custom_attributes": {
            "Subscription Plan": "Basic",
            "Active Camera": 2
          },
          "revenue": 2000,
          "aov": 20,
          "deleted_date": null
        },
        "offer_info": {
          "offer_valid_till": "11/30/2022, 15:30:41",
          "bonus_points": 100,
          "activity_to_complete": {
            "id": "63206d4d19da5f27de385ead",
            "activity_id": "made_a_purchase",
            "metadata": {
                "Category": "T-Shirt",
                "Location": "London",
                "Gender": "Male",
            },
            "activity_name": "Purchase on website",
            "is_active": true,
            "approval_method": "immediate",
            "show_on_guest_dashboard": true,
            "activity_card_background_image_url": "",
            "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.",
            "enduser_activity_description_html": "",
            "last_modified_date": "11/23/2022 10:29:40",
            "created_date": "09/13/2022 11:45:17",
            "is_qualified_for_tier_upgrade": true,
            "rules_config": [
              {
                "rule_type": "Fixed Points",
                "rule_value": 123,
                "is_active": false,
                "conditions_matching_policy": "match_all",
                "conditions": [
                  {
                    "operator": "Contain any of",
                    "attribute": "Transaction Tags",
                    "value": [
                      "winback",
                      "sendoffer"
                    ]
                  }
                ]
              }
            ],
            "activity_benefit_type": "points",
            "points_config": {
              "points_computation_type": "multiplier_based",
              "attribute_to_multiply": "order_subtotal",
              "multiplier": 1
            }
          }
        }
      }
    }
  ],
  "created_date": "11/30/2022 10:00:41"
}

Available Rewards Reminder Event

The available rewards reminder event occurs when the user earns enough points to redeem rewards. The payload is shown below:

{
  "request_id": "638715523541f8001030bd4d",
  "total_count": 1,
  "events": [
    {
      "id": "638715525efcad6bb4286b21",
      "event_type": "event_available_rewards_reminder",
      "data": {
        "member_info": {
          "id": "63871549f9e07600094f2310",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john.doe23",
          "member_status": "active",
          "member_tags": [],
          "number_of_purchases": 2,
          "number_of_redemptions": 0,
          "birthdate": "08/26/1986 00:00:00",
          "enrollment_date": "11/30/2022 00:00:00",
          "last_modified_date": "11/30/2022 00:00:00",
          "first_purchase_date": "11/30/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "11/30/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "11/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 700,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "11/30/2022 23:59:59"
          },
          "referral_code": "RES3FQN9",
          "lifetime_points_earned": 700,
          "lifetime_points_expired": 0,
          "available_points": 700,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://zinrelo.com/ref/RES3FQN9",
          "custom_attributes": {
            "Gender": "Male",
            "Number of purchases": 1,
            "List of favourite place": ["London" "Paris"],
            "Review date": "12/10/2022 00:00:00"
          },
          "revenue": 200,
          "aov": 5,
          "deleted_date": null
        },
        "reward_info": {
          "count": 1,
          "rewards": [
            {
              "reward_name": "$5 OFF COUPON",
              "enduser_reward_confirmation_html": "<div class=\"coupon_code_div\">_COUPON_CODE_</div><div style=\"margin-top: 15px;\"> A copy of the code has been emailed to _USER_EMAIL_.</div>",
              "reward_card_background_image_url": "",
              "implementation_type": "coupon_code",
              "enduser_reward_post_confirmation_html": "Go to the <a href=\"{{PRODUCT_URL}}\" target=\"_blank\"> product page </a> and add this product to cart. Apply the coupon code at checkout",
              "show_on_guest_dashboard": false,
              "last_modified_date": "11/17/2022 11:40:31",
              "is_active": true,
              "product_url": "https://john-mystore.myshopify.com/products/battlefield",
              "reward_sub_type": "Product Redemption",
              "eligible_tiers_list": [
                "zrl_platinum",
                "zrl_gold",
                "zrl_silver"
              ],
              "created_date": "09/13/2022 11:06:54",
              "enduser_reward_short_description": "For {{POINTS}} points",
              "points_to_be_redeemed": 500,
              "reward_type": "Coupon Based Rewards",
              "redemption_eligibility_criteria": "Tier Based",
              "id": "6320644e3ef462000ccca295",
              "reward_id": "reward_e562f",
              "product_id": "prod-01",
              "metadata": {
                "Category": "T-Shirt",
                "Location": "London",
                "Gender": "Male",
              }
            }
          ]
        }
      }
    }
  ],
  "created_date": "11/30/2022 08:33:22"
}

Member OTP Generation Event

The member_otp_generation event occurs whenever a user requests an OTP for user authentication into the Zinrelo loyalty program. The payload is shown below:

{
  "request_id": "638706a8f9e076000d6c61f5",
  "total_count": 1,
  "events": [
    {
      "id": "638706a987c5ca4b159b837b",
      "event_type": "event_member_otp_generation",
      "data": {
        "member_info": {
          "id": "63805bc5d34967000d6a2c7f",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john.doe23",
          "member_status": "active",
          "member_tags": "memberotp",
          "number_of_purchases": 13,
          "number_of_redemptions": 4,
          "birthdate": "08/26/1986 00:00:00",
          "enrollment_date": "11/25/2022 00:00:00",
          "last_modified_date": "11/30/2022 00:00:00",
          "first_purchase_date": "11/25/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "11/30/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "03/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 13,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "02/28/2023 23:59:59"
          },
          "referral_code": "TES7GQL4",
          "lifetime_points_earned": 514116,
          "lifetime_points_expired": 0,
          "available_points": 485762,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 28354,
          "referral_URL": "https://zinrelo.com/ref/TES7GQL4",
          "custom_attributes": {
            "City_Name": "Paris",
            "Marital_Status": "Married",
            "Income_Source": "Business",
            "Age_In_Years": "35",
            "Gender_Identity": "Male",
            "Graduation_Date": "03/12/2000 00:00:00"
          },
          "revenue": 13,
          "aov": 0.7,
          "deleted_date": null
        },
        "otp_info": {
          "otp": "470393",
          "minutes_valid": 5,
          "valid_till": "11/30/2022, 07:35:48"
        }
      }
    }
  ],
  "created_date": "11/30/2022 07:30:48"
}

Points Expiration Reminder Event

The points expiration reminder occurs whenever a user's points are about to expire. The payload is shown below:

{
  "request_id": "637cc4a7e332e9d94de7fd95",
  "total_count": 1,
  "events": [
    {
      "id": "637cc4a8f674a0b9d34dcaed",
      "event_type": "event_points_expiration_reminder",
      "data": {
        "member_info": {
          "id": "637bb8ca6191c1000df60a78",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john.doe23",
          "member_status": "active",
          "member_tags": "pointsexpiration",
          "number_of_purchases": 3,
          "number_of_redemptions": 0,
          "birthdate": "08/26/1986 00:00:00",
          "enrollment_date": "11/21/2022 00:00:00",
          "last_modified_date": "11/22/2022 00:00:00",
          "first_purchase_date": "11/21/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "11/22/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "11/01/2022 00:00:00",
            "loyalty_tier_name": "Gold",
            "qualified_points": 1600,
            "loyalty_tier_id": "zrl_gold",
            "current_period_end": "11/30/2022 23:59:59"
          },
          "lifetime_points_earned": 3100,
          "lifetime_points_expired": 0,
          "available_points": 3100,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://zinrelo.com/ref/UPD0ZJGL",
          "custom_attributes": {
            "Gender": "Male",
            "Number of purchases": 1,
            "List of favourite place": ["London" "Paris"],
            "Review date": "12/10/2022 00:00:00"
          },
          "revenue": 300,
          "aov": 3.5,
          "deleted_date": null
        },
        "expiry_info": {
          "expiration_date": "11/24/2022 00:00:00",
          "points": 3100,
          "days_to_expire": 2
        }
      }
    }
  ],
  "created_date": "11/22/2022 12:46:31"
}

Rewards within reach Reminder Event

The rewards within reach reminder event occurs whenever a user earns 80% of the required points to redeem the reward. The payload is shown below:

{
  "request_id": "64880b23c111d90011ee4eb9",
  "total_count": 1,
  "events": [
    {
      "id": "64880b2594832e4e92d871ae",
      "event_type": "event_rewards_within_reach_reminder",
      "data": {
        "member_info": {
          "id": "64880b215a684b000d281e1c",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "john.doe23",
          "member_status": "active",
          "member_tags": ["rewardsreminder", "remindingrewards"],
          "number_of_purchases": 1,
          "number_of_redemptions": 0,
          "birthdate": "08/26/1986 00:00:00",
          "enrollment_date": "06/13/2023 06:22:25",
          "last_modified_date": "06/13/2023 06:22:27",
          "first_purchase_date": "06/13/2023 06:22:26",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "06/13/2023 06:22:26",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "03/01/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 500,
            "loyalty_tier_id": "tier_silver",
            "current_period_end": "02/28/2023 23:59:59"
          },
          "referral_code": "KES1HX1E",
          "lifetime_points_earned": 600,
          "lifetime_points_expired": 0,
          "available_points": 600,
          "lifetime_points_deducted": 0,
          "lifetime_points_redeemed": 0,
          "referral_URL": "https://zinrelo.com/ref/SAM02XIU",
          "custom_attributes": {            
            "City_Name": "Paris",
            "Marital_Status": "Married",
            "Income_Source": "Business",
            "Age_In_Years": "35",
            "Gender_Identity": "Male",
            "Graduation_Date": "03/12/2000 00:00:00"
          },
          "revenue": 50,
          "aov": 70.2,
          "deleted_date": null
        },
        "reward_info": {
          "count": 1,
          "rewards": [
            {
              "enduser_reward_post_confirmation_html": "Go to the <a href=\"{{PRODUCT_URL}}\" target=\"_blank\"> product page </a> and add this product to cart. Apply the coupon code at checkout",
              "earning_period_operator": "Lifetime",
              "enduser_reward_confirmation_html": "<b>{{POINTS}} Points</b> WILL be deducted from your account balance. Do you wish to redeem this reward?",
              "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/86d0f83a4a99cc52c5cb04c4a4509bc2.jpeg",
              "implementation_type": "coupon_code",
              "is_active": true,
              "show_on_guest_dashboard": false,
              "last_modified_date": "11/29/2022 08:36:05",
              "points_earned": 1,
              "reward_name": "₹5 OFF COUPON",
              "id": "62e90f019396a278eb9baf66",
              "reward_sub_type": "Fixed Amount Discount",
              "created_date": "08/02/2022 11:48:17",
              "enduser_reward_short_description": "For {{POINTS}} points",
              "points_to_be_redeemed": 1500,
              "reward_type": "Coupon Based Rewards",
              "redemption_eligibility_criteria": "Points Based",
              "points_earned_operator": "Greater Than",
              "reward_id": "reward_c852d",
              "reward_value": "5",
              "metadata": {
                "Category": "T-Shirt",
                "Location": "London",
                "Gender": "Male",
              }
            }
          ]
        }
      }
    }
  ],
  "created_date": "06/13/2023 06:22:27"
}

Member Deleted Event

The member delete event occurs whenever a user or users are deleted from the admin console. The payload is shown below:

{
  "request_id": "63870a9c3541f8001430bd45",
  "total_count": 8,
  "events": [
    {
      "id": "63870a9d18f3ba1e30ef2069",
      "event_type": "event_member_delete",
      "data": {
        "member_info": {
          "member_id": "anna.scott46778"
        }
      }
    },
    {
      "id": "63870a9d18f3ba1e30ef206a",
      "event_type": "event_member_delete",
      "data": {
        "member_info": {
          "member_id": "john.doe23"
        }
      }
    },
    {
      "id": "63870a9d18f3ba1e30ef206b",
      "event_type": "event_member_delete",
      "data": {
        "member_info": {
          "member_id": "john4598"
        }
      }
    },
    {
      "id": "63870a9d18f3ba1e30ef206c",
      "event_type": "event_member_delete",
      "data": {
        "member_info": {
          "member_id": "scott25792"
        }
      }
    },
    {
      "id": "63870a9d18f3ba1e30ef206d",
      "event_type": "event_member_delete",
      "data": {
        "member_info": {
          "member_id": "anna.scott489709"
        }
      }
    },
    {
      "id": "63870a9d18f3ba1e30ef206e",
      "event_type": "event_member_delete",
      "data": {
        "member_info": {
          "member_id": "johndoe34957"
        }
      }
    },
    {
      "id": "63870a9d18f3ba1e30ef206f",
      "event_type": "event_member_delete",
      "data": {
        "member_info": {
          "member_id": "anna136989"
        }
      }
    },
    {
      "id": "63870a9d18f3ba1e30ef2070",
      "event_type": "event_member_delete",
      "data": {
        "member_info": {
          "member_id": "john76455"
        }
      }
    }
  ],
  "created_date": "11/30/2022 07:47:40"
}

Campaign Events

The campaign events will occur when a member or members enter or exit the campaign.

Campaign Entered

This event will occur when a member or members enter a campaign. The payload is shown below:

{
  "request_id": "63be6cba1caba8442643bc17",
  "total_count": 1,
  "events": [
    {
      "id": "63be6cba707f85cbe5b874e3",
      "event_type": "event_campaign_entered",
      "data": {
        "member_info": {
          "id": "6385e0e96c3148000beb356b",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "johndoe21",
          "member_status": "active",
          "member_tags": ["incampaign", "entrycampaign"],
          "number_of_purchases": 10,
          "number_of_redemptions": 1,
          "birthdate": "08/26/1989 00:00:00",
          "enrollment_date": "09/27/2022 00:00:00",
          "last_modified_date": "09/27/2022 00:00:00",
          "first_purchase_date": "10/26/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "12/29/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "12/29/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 500,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "12/29/2023 00:00:00"
          },
          "referral_code": "Anna286",
          "lifetime_points_earned": 10,
          "lifetime_points_expired": 0,
          "available_points": 100,
          "lifetime_points_deducted": 50,
          "lifetime_points_redeemed": 70,
          "referral_URL": "https://zinrelo.com/ref/JOH6FWL5",
          "custom_attributes": {
             "Nationality": "Indian"
          },
          "revenue": 115,
          "aov": null,
          "deleted_date": null
        },
        "campaign_info": {
          "event_name": "Campaign Entries",
          "event_ID": "campaign_entry2457",
          "delay_in_days": 0,
          "campaign_name": "runningcampaign",
          "campaign_ID": "campaign_7744b",
          "promotion_info": {
            "promotion_id": "63bb91fcc88247000c83a868",
            "promotion_type": "no_action",
            "configuration_settings": null
          }
        }
      }
    }

Campaign Exited

This event will occur when a member or members exit a campaign. The payload is shown below:

{
  "request_id": "63be6dfb071e220010516de6",
  "total_count": 1,
  "events": [
    {
      "id": "63be6dfda74c1ca07736e435",
      "event_type": "event_campaign_exited",
      "data": {
        "member_info": {
          "id": "6385e0e96c3148000beb356b",
          "first_name": "John",
          "last_name": "Doe",
          "email_address": "[email protected]",
          "address": {
            "city": "Palo Alto",
            "country": "US",
            "line2": "530 Lytton Ave",
            "line1": "Suite #200",
            "state": "CA",
            "postal_code": "94301"
          },
          "phone_number": "+1-6507017759",
          "member_id": "johndoe21",
          "member_status": "active",
          "member_tags": ["outofcampaign", "exitcampaign"],
          "number_of_purchases": 10,
          "number_of_redemptions": 1,
          "birthdate": "08/26/1989 00:00:00",
          "enrollment_date": "09/27/2022 00:00:00",
          "last_modified_date": "09/27/2022 00:00:00",
          "first_purchase_date": "10/26/2022 00:00:00",
          "instagram_handle": "www.instagram.com/john",
          "last_purchase_date": "12/29/2022 00:00:00",
          "anniversary_date": "12/06/2014 00:00:00",
          "twitter_handle": "www.twitter.com/john",
          "preferred_language": "English",
          "tier_info": {
            "tier_qualification_units": 100,
            "current_period_start": "12/29/2022 00:00:00",
            "loyalty_tier_name": "Silver",
            "qualified_points": 500,
            "loyalty_tier_id": "zrl_silver",
            "current_period_end": "12/29/2023 00:00:00"
          },
          "referral_code": "Anna286",
          "lifetime_points_earned": 10,
          "lifetime_points_expired": 0,
          "available_points": 100,
          "lifetime_points_deducted": 50,
          "lifetime_points_redeemed": 70,
          "referral_URL": "https://zinrelo.com/ref/JOH6FWL5",
          "custom_attributes": {
             "Nationality": "Indian"
          },
          "revenue": 115,
          "aov": null,
          "deleted_date": null
        },
        "campaign_info": {
          "delay_in_days": 0,
          "event_name": "exit",
          "campaign_ID": "campaign_7744b",
          "promotion_info": {
            "promotion_type": "no_action",
            "promotion_id": "63bb91fcc88247000c83a868",
            "configuration_settings": null
          },
          "event_ID": "campaign_exited247",
          "campaign_name": "Exit Campaign"
        }
      }
    }

📘
Please Note:
Currently, the "tier_qualification_units" field is not available for Salesforce Commerce Cloud (SFCC) plugin.

Webhook Events

Member Enrollment Event

Points Earned Event

Points Redeemed Event

Points Deducted Event

Tier Upgrade Event

Tier Downgrade Event

Points Expired Event

Friend Incentive Request Event

Member Updated Event

Referral link shared via Email or Social Channels Event

Referral Successful Event

Points Rejected Event

Winback Offer Event

Available Rewards Reminder Event

Member OTP Generation Event

Points Expiration Reminder Event

Rewards within reach Reminder Event

Member Deleted Event

Campaign Events

Campaign Entered

Campaign Exited

📘
Please Note:

Member Enrollment Event

Points Earned Event

Points Redeemed Event

Points Deducted Event

Tier Upgrade Event

Tier Downgrade Event

Points Expired Event

Friend Incentive Request Event

Member Updated Event

Referral link shared via Email or Social Channels Event

Referral Successful Event

Points Rejected Event

Winback Offer Event

Available Rewards Reminder Event

Member OTP Generation Event

Points Expiration Reminder Event

Rewards within reach Reminder Event

Member Deleted Event

Campaign Events

Campaign Entered

Campaign Exited

📘Please Note:

📘
Please Note: