Loyalty
Milestone (Targets) & Streaks
This section contains the schemas of various milestones (also called targets) related event notifications. These will be sent to the respective brand's webhooks which brands can consume & use at their end.
Supported event notifications are:
- Target Achieved Value Updated event
- Target Value Updated event
- Target Value Achieved event
- Target period start
- Target period end
- Unified target achieved
- Unified target un-achieved
- Target enrollment
- Streak level achievement
- Streak level unachievement
- Streak enrolment
- Streak unenrolment
- Streak start
- Streak end
Target Achieved Value Updated event (targetAchievedValueUpdated)
Notifies when a target achieved value has been updated. For example, a user purchases a line-item that updates the target value.
{
"eventId": "58aa15c9-1a08-422d-9272-f2a1cdc3f8c1",
"eventType": "1000006_targetAchievedValueUpdated",
"consumerGroupId": null,
"actionType": "START",
" timeStamp": 1683867642403,
"attributes": {
"createdAt": 1683867642385,
"data": {
"customerIdentifiers": {
"customerId": 85950037
},
"eventName": "TransactionAdd",
"eventId": 15,
"targetDetails": {
"id": 243,
"name": "League Stage Reward_TxnCount1",
"targetGroupId": 163,
"targetGroupName": "League Stage Reward",
"targetPeriodId": 61,
"targetPeriodName": "L1"
},
"currentE ventTargetValue": "1",
"achievedTargetValue": "14.000",
"definedTargetValue": "1.000",
"triggeringActivity": {
"name": "TransactionAdd",
"identifiers": [
{
"key": "TransactionId",
"value": "175771018"
}
],
"enteredBy": {
"id": 100007771
},
"additionalAttributes": [
]
},
"milestoneDetails": [
],
"transactionId": 175771018
},
"loyaltyEventId": "",
"eventName": "targetAchievedValueUpdated",
"refId": "1000006_d4658fc5bd809b780b32ad88b1e3c442",
"apiRequestId": "d4658fc5bd809b780b32ad88b1e3c442",
"orgId": 1000006
}
}Target Value Achieved Event
Notifies when a user achieves the set target.
{
"eventId": "59589150-8626-4841-bfc5-9f53f81af6ec",
"eventType": "2013_targetValueAchieved",
"consumerGroupId": "1eb18702-acaf-463c-91f8-39acc62a7c97",
"actionType": "START",
"timeSta mp": 1683878597209,
"attributes": {
"createdAt": 1683878590899,
"data": {
"customerIdentifiers": {
"customerId": 504662785
},
"eventName": "TransactionAdd",
"eventId": 15,
"targetDetails": {
"id": 2112,
"name": "Order more times via app or ahente to earn points",
"targetGroupId": 1065,
"targetGroupName": "Mission_1_May2023_Omni_Frequency",
"targetPeriodId": 1462,
"target PeriodName": "P1"
},
"currentEventTargetValue": "1",
"achievedTargetValue": "3.000",
"definedTargetValue": "3.000",
"triggeringActivity": {
"name": "TransactionAdd",
"identifiers": [
{
"key": "TransactionId",
"value": "240560693"
}
],
"enteredBy": {
"id": 13026505
},
"additionalAttributes": [
]
},
"transactionId": 240560693
},
"loyaltyEventId": "",
"eventName": "targetValueAchieved",
"refId": "2013_77e8f7100269c43d7869f786e85972c3",
"apiRequestId": "77e8f7100269c43d7869f786e85972c3",
"orgId": 2013
}
}Target Period Completed Event
Notifies the completion of a target period for a user.
{
"eventName": "targetPeriodCompleted",
"data": {
"customerIdentifiers": {
"customerId": 5986,
"firstName": "GUJZCZBJE",
"lastName": "XWCPPWAMF",
"loyaltyType": "SVDSH",
"instore": {
"id": 8219,
"mobile": "XBTHUHTK",
"email": "RUFMWNJNM",
"externalId": "EOXUQ",
"cardnumber": "CCNCTWARTF",
"cardexternalid": "YKJJHOYINJ",
"cardNumbers": [
"QUKDYUHJTX"
]
},
"facebook": {
"accounts": [
{
"accountId": "LGATUJCHVG",
"identifiers": [
{
"identifierType": "TFTSLQJ",
"identifierValue": "ADZ"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "JWHYLGF",
"identifiers": [
{
"identifierType": "XGCPOK",
"identifierValue": "ARBYGKFUR"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "UIAU",
"identifiers": [
{
"identifierType": "QGPSOLJWY",
"identifierValue": "ABUY"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "CMOV",
"identifiers": [
{
"identifierType": "GHLRL",
"identifierValue": "ZZE"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "TGT",
"identifiers": [
{
"identifierType": "JKZPAYK",
"identifierValue": "UVTFCI"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "BGPJCYHFT",
"identifiers": [
{
"identifierType": "XUOMQIAASX",
"identifierValue": "WJFUBKGWD"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "CRNXIEHP",
"identifiers": [
{
"identifierType": "QADMZCEA",
"identifierValue": "IEC"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "KXRELR",
"identifiers": [
{
"identifierType": "HJANHON",
"identifierValue": "NKLFYVI"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "YTSUEBY",
"identifiers": [
{
"identifierType": "XPRT",
"identifierValue": "NFQGOV"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "XKZJLT",
"identifiers": [
{
"identifierType": "OUQHSDMVR",
"identifierValue": "RNOJZ"
}
]
}
]
}
},
"targetDetails": {
"id": 1599,
"name": "PXWHUGOHE",
"targetGroupId": 1311,
"targetGroupName": "NETQVIXEVZ",
"targetPeriodId": 2736,
"targetPeriodName": "KXJAEGWS",
"description": "LADGQW"
},
"achievedTargetValue": "BMPPHDS",
"definedTargetValue": "XIMIYEHQN",
"triggeringActivity": {
"name": "QNKC",
"identifiers": [
{
"key": "ACOLY",
"value": "MXKTX"
}
],
"enteredBy": {
"id": 6210,
"till": {
"code": "BBPBE",
"name": "LMV"
},
"store": {
"code": "LVE",
"name": "APUKKQDD",
"externalId": "VESBCXFCY",
"externalId1": "FDPZKOWYF",
"externalId2": "GNEOA"
}
},
"entityInformation": {
"entityType": "RBSFDUIB",
"entityId": 6103
},
"additionalAttributes": [
{
"key": "RROIITNZ",
"value": "QSNJZ"
}
]
},
"milestoneDetails": [
{
"id": 1298,
"name": "OOTNIFWHA",
"valueType": "LYV",
"definedValue": "HSPDZUF",
"achievedDate": 4440
}
]
},
"eventId": "EKY",
"orgId": 7257,
"refId": "SRGCV",
"apiRequestId": "UFEQCNEEH",
"createdAt": 7915,
"loyaltyEventId": "TFHBNGXBN",
"traceAttributes": {
"ZJIPBBO": "QDHIQ",
"HDBA": "UDJH",
"KPEFS": "DPCCYBUEK"
}
}Target Value Update Event
Notifies when the target value associated with the user has been updated.
{
"eventName": "targetValueUpdated",
"data": {
"customerIdentifiers": {
"customerId": 2527,
"firstName": "XYJJSKE",
"lastName": "CHEMK",
"loyaltyType": "ZFZYJ",
"instore": {
"id": 8709,
"mobile": "OIATBO",
"email": "CMMTLDMF",
"externalId": "YKHVT",
"cardnumber": "PRXJJD",
"cardexternalid": "MOBNDIV",
"cardNumbers": [
"NNVIFQK"
]
},
"facebook": {
"accounts": [
{
"accountId": "YBNVGBQRE",
"identifiers": [
{
"identifierType": "EIAOXKYBFN",
"identifierValue": "KNTE"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "PTDPSXK",
"identifiers": [
{
"identifierType": "CYXZZFCPC",
"identifierValue": "COMAT"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "LOOBI",
"identifiers": [
{
"identifierType": "WBLMJFUV",
"identifierValue": "BSNGZGTBN"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "JAMV",
"identifiers": [
{
"identifierType": "VBZDYU",
"identifierValue": "VAUYPP"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "YXIBKT",
"identifiers": [
{
"identifierType": "CBG",
"identifierValue": "OCSPJDBBJ"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "IBGOYQBB",
"identifiers": [
{
"identifierType": "YCQTDRBVO",
"identifierValue": "NUPUY"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "HFVEV",
"identifiers": [
{
"identifierType": "JOTOS",
"identifierValue": "ZASD"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "FNQORHYAPB",
"identifiers": [
{
"identifierType": "CSDXMSJS",
"identifierValue": "LWMIA"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "DSHEA",
"identifiers": [
{
"identifierType": "FXWCVW",
"identifierValue": "ZGGMS"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "JENIHL",
"identifiers": [
{
"identifierType": "NDCCF",
"identifierValue": "WUY"
}
]
}
]
}
},
"targetDetails": {
"id": 4143,
"name": "SVHXO",
"targetGroupId": 9705,
"targetGroupName": "OHELNMDXMK",
"targetPeriodId": 1203,
"targetPeriodName": "UNT",
"description": "SJCCPZROZ"
},
"achievedTargetValue": "OSKRYFAUAY",
"definedTargetValue": "SXDA"
},
"eventId": "OWCGLNF",
"orgId": 7660,
"refId": "CLRNYYI",
"apiRequestId": "YFHG",
"createdAt": 3061,
"loyaltyEventId": "YMBME",
"traceAttributes": {
"UEPWFKEEF": "GBCEMWAK",
"WLZCFWHSDA": "HIUJ",
"ZGTKWB": "HPOONUTW",
"HJPLYIPS": "EOHYCVJMQY"
}
}Unified Target Achieved Event
Notifies when a user achieves the set target for a unified target.
{
"event": {
"body": {
"apiRequestId": "8725941269715d666d0d18d7ba1d4137",
"createdAt": 1714025846289,
"data": {
"customerIdentifiers": {
"customerId": 383453066,
"instore": {
"mobile": "916661610044"
},
"loyaltyType": "loyalty"
},
"targetData": [
{
"achievedTargetValue": "3000.000",
"definedTargetValue": "1000.000",
"targetId": 49272,
"targetName": "TARGETSFORUNIFIED1",
"targetPeriodId": 32436,
"targetPeriodName": "Period1"
}
],
"transactionId": 2151566715,
"triggeringActivity": {
"additionalAttributes": [],
"enteredBy": {
"id": 50670145,
"store": {
"code": "cc_1",
"externalId": "cc1",
"externalId1": "",
"externalId2": "",
"name": "CentralZone1"
},
"till": {
"code": "tillhg",
"name": "tillhg"
}
},
"identifiers": [
{
"key": "eventLogId",
"value": "26192434"
},
{
"key": "transactionId",
"value": "2151566715"
}
],
"name": "TransactionAdd"
},
"unifiedTargetGroupDetails": {
"targetGroupId": 25780,
"targetGroupName": "uniFIEDTargetsANYCase",
"unifiedTargetsAchievementCondition": {
"aggregation": "SUM",
"combinationType": "ANY",
"ruleExpression": "(49272 | 49273 | 49274)",
"thresholdValue": 5000
}
}
},
"eventId": "aa1fabd3-7dac-4e15-8d4a-3a1c75e80d5d",
"eventName": "unifiedTargetsAchieved",
"loyaltyEventId": "26192434",
"orgId": 51174,
"refId": "51174_8725941269715d666d0d18d7ba1d4137"
},
"client_ip": "3.225.18.198",
"headers": {
"": ":",
"accept": "text/plain, application/json, application*+json, **",
"content-length": "1168",
"content-type": "application/json",
"host": "eo9bacvfjgkxwz6.m.pipedream.net",
"user-agent": "Java/1.8.0_272"
},
"method": "POST",
"path": "",
"query": {},
"url": "https://eo9bacvfjgkxwz6.m.pipedream.net"
}
}Unified Target Unachieved Event
Notifies when a user does not meet the defined unified target within the time-frame.
{
"event": {
"body": {
"apiRequestId": "8725941269715d666d0d18d7ba1d4137",
"createdAt": 1714025846289,
"data": {
"customerIdentifiers": {
"customerId": 383453066,
"instore": {
"mobile": "916661610044"
},
"loyaltyType": "loyalty"
},
"targetData": [
{
"achievedTargetValue": "1000.000",
"definedTargetValue": "3000.000",
"targetId": 49272,
"targetName": "TARGETSFORUNIFIED1",
"targetPeriodId": 32436,
"targetPeriodName": "Period1"
}
],
"transactionId": 2151566715,
"triggeringActivity": {
"additionalAttributes": [],
"enteredBy": {
"id": 50670145,
"store": {
"code": "cc_1",
"externalId": "cc1",
"externalId1": "",
"externalId2": "",
"name": "CentralZone1"
},
"till": {
"code": "tillhg",
"name": "tillhg"
}
},
"identifiers": [
{
"key": "eventLogId",
"value": "26192434"
},
{
"key": "transactionId",
"value": "2151566715"
}
],
"name": "TransactionAdd"
},
"unifiedTargetGroupDetails": {
"targetGroupId": 25780,
"targetGroupName": "uniFIEDTargetsANYCase",
"unifiedTargetsAchievementCondition": {
"aggregation": "SUM",
"combinationType": "ANY",
"ruleExpression": "(49272 | 49273 | 49274)",
"thresholdValue": 5000
}
}
},
"eventId": "aa1fabd3-7dac-4e15-8d4a-3a1c75e80d5d",
"eventName": "unifiedTargetsUnAchieved",
"loyaltyEventId": "26192434",
"orgId": 51174,
"refId": "51174_8725941269715d666d0d18d7ba1d4137"
},
"client_ip": "3.225.18.198",
"headers": {
"": ":",
"accept": "text/plain, application/json, application*+json, **",
"content-length": "1168",
"content-type": "application/json",
"host": "eo9bacvfjgkxwz6.m.pipedream.net",
"user-agent": "Java/1.8.0_272"
},
"method": "POST",
"path": "",
"query": {},
"url": "https://eo9bacvfjgkxwz6.m.pipedream.net"
}
}Target Customer Enrolment Event (targetCustomerEnrolment)
Notifies when a user is enrolled to a target.
{
"eventName": "targetCustomerEnrolment",
"data": {
"customerIdentifiers": {
"customerId": 3863,
"firstName": "ZYXM",
"lastName": "CARSDEV",
"loyaltyType": "SIVLVXMVE",
"instore": {
"id": 6872,
"mobile": "DIILHYLYRD",
"email": "HFQ",
"externalId": "LLHXQ",
"cardnumber": "APXQS",
"cardexternalid": "WJEZRPNFU",
"cardNumbers": [
"VDD"
]
},
"facebook": {
"accounts": [
{
"accountId": "ZDP",
"identifiers": [
{
"identifierType": "EZP",
"identifierValue": "FEWINPWR"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "GKX",
"identifiers": [
{
"identifierType": "YDSHYPMUA",
"identifierValue": "NRQOD"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "JBSCNCML",
"identifiers": [
{
"identifierType": "GKFKW",
"identifierValue": "ADFPJV"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "NPRVZFORG",
"identifiers": [
{
"identifierType": "BZYTTJ",
"identifierValue": "QVKCNXL"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "GBTFHRL",
"identifiers": [
{
"identifierType": "APEBBUYIL",
"identifierValue": "FGDBFKW"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "WFP",
"identifiers": [
{
"identifierType": "LYZL",
"identifierValue": "RBZKCLKTJZ"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "VUNVO",
"identifiers": [
{
"identifierType": "WBYHSEEVV",
"identifierValue": "ELQ"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "KNRHNX",
"identifiers": [
{
"identifierType": "MHKJBWXI",
"identifierValue": "YVOZRS"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "JBUXMV",
"identifiers": [
{
"identifierType": "YEDSYML",
"identifierValue": "LCTGZYOQS"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "FARKLZ",
"identifiers": [
{
"identifierType": "PCWWVGHWIB",
"identifierValue": "XLUG"
}
]
}
]
}
},
"eventId": 1094,
"defaultTargetValue": "UMWTEP",
"targetId": 1456,
"targetName": "OXQJJMLAG",
"targetGroupId": 5363,
"targetGroupName": "RLUGUR",
"source": "FET",
"targetPeriodId": 4769,
"targetPeriodName": "PIHT",
"targetPeriodStartDate": "WFPMVEL",
"targetCycleStartDate": "RTFWEJ",
"description": "FXAFKFIVEY",
"milestoneDetails": [
{
"id": 5552,
"name": "QTRPSQVLQ",
"valueType": "PUNHMJGV",
"definedValue": "XYYYVWFU",
"achievedDate": 3143
}
]
},
"eventId": "SYTR",
"orgId": 2849,
"refId": "MGLM",
"apiRequestId": "ZOFC",
"createdAt": 7503,
"loyaltyEventId": "OSTAYD",
"traceAttributes": {
"ICXXIEWRMY": "NZSWXC",
"GGI": "JHBDOPEU",
"EKFH": "ERISPQKPC",
"ASFKYUGZ": "LXWDOUB",
"BSDBPAQO": "GKROUZ",
"RQHNHM": "NCV"
}
}Target Period Started Event (targetPeriodStarted)
Notifies when the target evaluation period begins.
{
"eventName": "targetPeriodStarted",
"data": {
"customerIdentifiers": {
"customerId": 944,
"firstName": "CZARYVMKF",
"lastName": "RPXRUGG",
"loyaltyType": "PLBGRGTZNX",
"instore": {
"id": 1512,
"mobile": "BNKTEF",
"email": "SRPPS",
"externalId": "IHPJPCL",
"cardnumber": "TZOH",
"cardexternalid": "AUBGKG",
"cardNumbers": [
"MPRXJYP"
]
},
"facebook": {
"accounts": [
{
"accountId": "FJV",
"identifiers": [
{
"identifierType": "STSMQYVVM",
"identifierValue": "JLI"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "PJIET",
"identifiers": [
{
"identifierType": "XEOQWAOND",
"identifierValue": "XINNUEU"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "FAGFWQ",
"identifiers": [
{
"identifierType": "VDFH",
"identifierValue": "KZJTOJ"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "XTXA",
"identifiers": [
{
"identifierType": "RSOQULQNSZ",
"identifierValue": "MCEHRADG"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "IBKGNWDB",
"identifiers": [
{
"identifierType": "AXMRPNTJQY",
"identifierValue": "AIRRYPX"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "DIFODDNTTN",
"identifiers": [
{
"identifierType": "KPQPXMPXYM",
"identifierValue": "OMWKQVJWH"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "JUUG",
"identifiers": [
{
"identifierType": "UAU",
"identifierValue": "NKIEHDD"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "VEH",
"identifiers": [
{
"identifierType": "OIXFTACHSM",
"identifierValue": "PBR"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "GYXFXWSCP",
"identifiers": [
{
"identifierType": "SCOZM",
"identifierValue": "CTFKH"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "GPEDITVWUC",
"identifiers": [
{
"identifierType": "HPKES",
"identifierValue": "TCDGIESALU"
}
]
}
]
}
},
"targetDetails": {
"id": 4091,
"name": "MVHRMHKSD",
"targetGroupId": 2897,
"targetGroupName": "QAWWVAJG",
"targetPeriodId": 4150,
"targetPeriodName": "MQLYD",
"description": "DBHC"
},
"definedTargetValue": "FTHEHKWXP",
"triggeringActivity": {
"name": "AIWRCMKFRL",
"identifiers": [
{
"key": "QYUEZXDEYT",
"value": "NCP"
}
],
"enteredBy": {
"id": 8462,
"till": {
"code": "QUCODGXO",
"name": "OPQPSXR"
},
"store": {
"code": "UTDJUF",
"name": "KEQHWO",
"externalId": "KCGA",
"externalId1": "CGVDP",
"externalId2": "IKCJKQ"
}
},
"entityInformation": {
"entityType": "BACCBZTNDI",
"entityId": 2909
},
"additionalAttributes": [
{
"key": "TUR",
"value": "UGMZXUWHWM"
}
]
}
},
"eventId": "YIF",
"orgId": 3507,
"refId": "MQBEA",
"apiRequestId": "ITNQLRIUYS",
"createdAt": 1681,
"loyaltyEventId": "WYNP",
"traceAttributes": {
"BOOSGYM": "QLJDUSNG",
"XIE": "TNX",
"MKT": "ALMK",
"TOHI": "BHVNVQ"
}
}Streak Level Achievement Event (streakLevelAchieved)
Notifies when a user has achieved a streak level.
{
"eventId": "e91fd520-7765-4b09-951d-300ba47b5f8d",
"eventType": "streakLevelAchieved",
"consumerGroupId": null,
"actionType": "START",
"timeStamp": 1719841226275,
"attributes": {
"createdAt": 1719841226189,
"data": {
"customerIdentifiers": {
"customerId": 345875284
},
"streakData": [
{
"userCurrentStreakValue": "1",
"streakLevelName": "test_streak_achievement_EN_1",
"streakName": "test_streak_achievement_EN_1",
"streakId": "5717",
"userStreakId": "61401",
"streakLevelAchievedDate": "2024-07-01T13:40:26.172+0000"
}
],
"targetData": [
{
"id": 90856,
"name": "test_streak_achievement_EN",
"targetGroupId": 42728,
"targetGroupName": "test_streak_achievement_EN",
"targetPeriodId": 53200,
"targetPeriodName": "Cycle_2"
}
],
"triggeringActivity": {
"name": "TransactionAdd",
"identifiers": [
{
"key": "eventLogId",
"value": "12529131"
},
{
"key": "transactionId",
"value": "null"
}
],
"enteredBy": {},
"additionalAttributes": []
}
},
"loyaltyEventId": "12529131",
"eventName": "streakLevelAchieved",
"refId": "50282_ee19addfc1c74a506ef735ee0757e191",
"apiRequestId": "ee19addfc1c74a506ef735ee0757e191",
"orgId": 50282
}
}Streak Level Unachievement Event (streakLevelUnAchieved)
Notifies when a streak level has not been achieved within the time-frame.
{
"eventId": "462c3420-af0f-4300-b915-f5ea62461158",
"eventType": "streakLevelUnAchieved",
"consumerGroupId": null,
"actionType": "START",
"timeStamp": 1719841505207,
"attributes": {
"createdAt": 1719841505183,
"data": {
"customerIdentifiers": {
"customerId": 345875236
},
"streakData": [
{
"userCurrentStreakValue": "1",
"streakLevelName": "test_streak_achievement_EN_1",
"streakName": "test_streak_achievement_EN_1",
"streakId": "5717",
"userStreakId": "61399",
"streakLevelAchievedDate": "2024-07-01T13:35:31.000+0000"
}
],
"targetData": [
{
"id": 90856,
"name": "test_streak_achievement_EN",
"targetGroupId": 42728,
"targetGroupName": "test_streak_achievement_EN",
"targetPeriodId": 53202,
"targetPeriodName": "Cycle_4"
}
],
"triggeringActivity": {
"name": "ReturnBill",
"identifiers": [
{
"key": "eventLogId",
"value": "12529287"
},
{
"key": "transactionId",
"value": "null"
}
],
"enteredBy": {},
"additionalAttributes": []
}
},
"loyaltyEventId": "12529287",
"eventName": "streakLevelUnAchieved",
"refId": "50282_2d3d46947206e5a142c6e42a544f4e57",
"apiRequestId": "2d3d46947206e5a142c6e42a544f4e57",
"orgId": 50282
}
}Streak Enrolment Event (streakCustomerEnrolment)
Notifies when a user has been enrolled to a streak.
{
"eventId": "d1ef2bf6-7b14-4dbe-aadb-8d911c4b0c08",
"eventType": "50952_streakCustomerEnrolment",
"consumerGroupId": "e833d224-2e60-448b-b3eb-d2b1de2cff24",
"actionType": "START",
"timeStamp": 1722860014707,
"attributes": {
"createdAt": 1722859984403,
"data": {
"customerIdentifiers": {
"customerId": 382513745
},
"streakEnrolmentData": [
{
"streakName": "tesseractuiTest1_1",
"numberOfLevel": 1,
"levelValues": [
],
"startDate": "2024-08-05 01:30:00",
"endDate": "2024-08-06 01:29:59"
}
],
"targetData": [
{
"id": 67105,
"name": "tesseractuiTest1",
"targetGroupId": 36996,
"targetGroupName": "tesseractuiTest1",
"targetPeriodId": 50708,
"targetPeriodName": "Cycle_5"
}
],
"triggeringActivity": {
"name": "enrolmentIntoStreak",
"identifiers": [
{
"key": "ENROL_VIA_API",
"value": "a824a8cc43669c9e0091b56725520660"
}
],
"additionalAttributes": [
]
}
},
"eventName": "streakCustomerEnrolment",
"refId": "50952_a824a8cc43669c9e0091b56725520660",
"apiRequestId": "a824a8cc43669c9e0091b56725520660",
"orgId": 50952
}
}Streak unenrolment (streakCustomerUnEnrolment)
This event is triggered when a user is unenrolled from a streak.
{
"eventName": "streakCustomerUnEnrolment",
"data": {
"customerIdentifiers": {
"customerId": 557461034
},
"streakUnEnrolmentData": [
{
"streakName": "test streaks BE with SUM_1",
"numberOfLevel": 2,
"levelValues": [
],
"startDate": "2024-08-01 04:00:00",
"endDate": "2024-08-02 03:59:59"
}
],
"targetData": [
{
"id": 1519,
"name": "test streaks BE with SUM",
"targetGroupId": 1332,
"targetGroupName": "test streaks BE with SUM",
"targetPeriodId": 6422,
"targetPeriodName": "Cycle_1"
}
],
"triggeringActivity": {
"name": "streak unenrollment",
"identifiers": [
{
"key": "UNENROL_VIA_API",
"value": "2ee80f8a3a7fc7259fcf1ca82e299453"
}
],
"additionalAttributes": [
]
}
},
"orgId": 100323,
"refId": "100323_2ee80f8a3a7fc7259fcf1ca82e299453",
"apiRequestId": "2ee80f8a3a7fc7259fcf1ca82e299453",
"createdAt": 1723016690026
}Streak Start Event (streakStart)
Notifies when a streak has started for a user. A streak starts when a user begins a series of consecutive actions or engagements as defined by the brand.
{
"eventName": "streakStart",
"eventId": "7e0c5f62-4a65-4dd9-8324-78461258dfa9",
"orgId": 51512,
"refId": "51512_c9b01aa8-cb98-4dd4-be66-586f34c44b97",
"apiRequestId": "c9b01aa8-cb98-4dd4-be66-586f34c44b97",
"createdAt": 1721912551142,
"data": {
"customerIdentifiers": {
"customerId": 387114334
},
"targetDetails": {
"id": 65260,
"name": "Streak 24 July",
"targetGroupId": 36006,
"targetGroupName": "Streak 24 July",
"targetPeriodId": 49006,
"targetPeriodName": "Cycle_1"
},
"streakStartData": [
{
"streakName": "Streak 24 July",
"descriptionOfTheStreak": "Streak 24 July",
"numberOfLevel": 2,
"levelValues": ["3","5"],
"userStreakValueAtTheStart": "0",
"startDate": "2024-07-24 14:15:59"
}
],
"triggeringActivity": {
"name": "streakStartEvent",
"identifiers": [
{
"key": "TargetRuleId",
"value": "65260"
}
],
"additionalAttributes": []
}
},
"loyaltyEventId": ""
}Streak End Event (streakEnd)
Notifies when a streak has ended for a user.
{
"eventName": "streakEnd",
"eventId": "7e0c5f62-4a65-4dd9-8324-78461258dfa9",
"orgId": 51512,
"refId": "51512_c9b01aa8-cb98-4dd4-be66-586f34c44b97",
"apiRequestId": "c9b01aa8-cb98-4dd4-be66-586f34c44b97",
"createdAt": 1721912551142,
"data": {
"customerIdentifiers": {
"customerId": 387114334
},
"targetDetails": {
"id": 65260,
"name": "Streak 24 July",
"targetGroupId": 36006,
"targetGroupName": "Streak 24 July",
"targetPeriodId": 49006,
"targetPeriodName": "Cycle_1"
},
"streakEndData": [
{
"streakName": "Streak 24 July",
"descriptionOfTheStreak": "Streak 24 July",
"numberOfLevel": 2,
"levelValues": ["3","5"],
"numberOfLevelsAchievedByTheUser": "0",
"levelsAchievedByTheUser": [],
"userStreakValueByTheEnd": 0,
"endDate": "2024-07-25 23:59:59"
}
],
"triggeringActivity": {
"name": "streakStartEvent",
"identifiers": [
{
"key": "TargetRuleId",
"value": "65260"
}
],
"additionalAttributes": []
}
},
"loyaltyEventId": ""
}Event notification for the change in milestone achieved value on return of purchases
As of now, whenever a customer makes a purchase, all the milestone values which can be impacted with that purchase will be impacted, and the information of the new milestone achieved value, etc.. will be sent as an event notification.
However, whenever a customer returns a transaction, the milestone value which previously increased because of that purchase will also be decreased accordingly. But there is no event notification for such instances. To understand with an example:
Step 1: Milestone on lifetime purchases created, and milestone value is 10,000.
Step 2: Customer made a transaction worth 3000.
Step 3: Customer’s milestone achieved value increased from 0 → 3000
Step 4: Brand will get an event notification about the above step.
Step 5: After days, the customer returned the purchase of step-2.
Step 6: Now the milestone achieved value will decrease from 3000 → 0.
Step 7: But brands/customers are not getting any event notification of the same.
Now, with this latest enhancement, brands will get notified even in the case of return transactions about the decreased milestone value.
If the “Name” key is “ReturnBill”, it’s a return transaction where milestone value is decreased by the “currentEventTargetValue” (400 here). We are not returning negative since it can lead to integration issues.
Points
eventLogId lets you look up detailed points activity (like earning, spending, or adjustments) for a specific event using the Points Ledger Explode API. The following events include eventLogId in the payload:
PointsIssued, IssuedPointsReversed, PointsTransferredInitiated, PointsTransferredReceived, PromisedToCurrentPointsConversion, PointsRedeemed, RedeemedPointsReversed, ManualPointsAdjustment, AlternateCurrenciesIssued, IssuedAlternateCurrenciesReversed, PromisedToCurrentAlternateCurrencyConversion, promotionIssued, pointsExpired
Points Issued Event (pointsIssued)
Notifies when points are issued to a user.
Parameter | New Description from Table 1 |
|---|---|
| Name of the event, e.g., "pointsIssued". |
| Unique identifier for the event. |
| Unique ID that is generated when the event is triggered. |
| Unique identifier for the organisation. |
| This is a combination of org id and loyalty event ID and is used for internal debugging. |
| Identifier for the API request. |
| Timestamp when the event was created. |
| Data related to the event. |
| Identifiers related to the customer. |
| Unique identifier for the customer. |
| Information about the entity involved in the event. |
| Type of entity, e.g., "USER". |
| Unique identifier for the entity. |
| Details about the activity that triggered the event. Possible values:
|
| Name of the triggering activity. |
| Identifiers related to the activity. |
| Key identifier, e.g., "CustomerId". |
| Value of the key identifier. |
| User who entered the activity. |
| Unique identifier for the user. |
| Information about the entity involved in the event. |
| Type of entity, e.g., "USER". |
| Unique identifier for the entity. |
| Additional attributes related to the activity. |
| Details about the loyalty program. |
| Unique identifier for the user. |
| List of program tiers. |
| Tier number, e.g., 1. |
| Tier name, e.g., "Silver". |
| Unique identifier for the loyalty program. |
| Current points in the loyalty program. |
| Lifetime points in the loyalty program. |
| Total points issued in the event. |
| Regular points issued in the event. |
| Breakdown of regular points issued (empty in this case). |
| Promotional points issued in the event. |
| Promised points issued in the event (empty in this case). |
| Identifier for the loyalty event. |
*The addition of behavioralEventAttributes is done on a demand basis. To enable it, you need to enable the configuration awardedReferenceEnrichmentEnabled . Raise a JIRA ticket with the sustenance team to enable this feature.
Example of points Issued on Transaction/Add
{
"eventName": "pointsIssued",
"eventId": "4647d7b7-61c0-480f-8dfe-40ff87f8a445",
"eventLogId": 39125117,
"orgId": 51186,
"refId": "51186_627e870bd278ed95deb5a046b4e9a647",
"apiRequestId": "627e870bd278ed95deb5a046b4e9a647",
"createdAt": 1750224535590,
"data": {
"customerIdentifiers": {
"customerId": 387979652,
"instore": {
"mobile": "919300000020",
"cardNumbers": []
}
},
"entityInformation": {
"entityType": "USER",
"entityId": 387979652
},
"triggeringActivity": {
"name": "ManualCurrencyAllocation",
"identifiers": [
{
"key": "BillId",
"value": "2152322568"
},
{
"key": "billNumber",
"value": "1750151307"
}
],
"enteredBy": {
"id": 50671937,
"entityInformation": {
"entityType": "USER",
"entityId": 387979652
}
},
"additionalAttributes": []
},
"loyaltyProgramDetails": {
"id": 2649,
"name": "VidhiJainOrgDefaultProgram",
"isDefault": true,
"pointsToCurrencyRatio": 5,
"tiers": [
{
"tierNumber": 1,
"tierName": "CLASSIC"
},
{
"tierNumber": 2,
"tierName": "SILVER"
},
{
"tierNumber": 3,
"tierName": "GOLD"
}
]
},
"loyaltyProgramId": 2649,
"programCurrentPoints": 120,
"programLifetimePoints": 120,
"totalPointsIssued": 100,
"regularPointsIssued": 100,
"regularPointsBreakup": [
{
"points": 100,
"expiryAt": "2025-06-29"
}
],
"promotionalPointsIssued": [],
"promisedPointsIssued": [],
"loyaltyEventId": "627e870bd278ed95deb5a046b4e9a647"
}
}
Points Redeemed Event (pointsRedeemed)
Notifies when a user has redeemed points.
Parameter | Data Type | Description |
|---|---|---|
eventId | String | Unique identifier for the event. |
eventLogId | Integer | Unique ID that is generated when the event is triggered. |
eventType | String | Type of event (e.g., "pointsRedeemed"). |
consumerGroupId | Integer | Identifier for the consumer group (null if not applicable). |
actionType | String | Action type of the event (e.g., "START"). |
timeStamp | Integer | Timestamp of the event in milliseconds since epoch. |
attributes | Object | Contains details about the attributes of the event. |
| Integer | Timestamp when the event was created (milliseconds since epoch). |
| Object | Contains specific data related to the event. |
-- customerIdentifiers | Object | Contains identifiers for the customer. |
--- customerId | Integer | Unique identifier for the customer. |
--- instore | Object | Contains in-store customer information. |
---- mobile | String | Mobile number of the customer. |
String | Email address of the customer. | |
-- entityInformation | Object | Contains information about the entity involved in the event. |
--- entityType | String | Type of the entity (e.g., "USER"). |
--- entityId | Integer | Unique identifier for the entity. |
-- triggeringActivity | Object | It contains information about the activity that triggered the event. |
--- name | String | Name of the triggering activity (e.g., "PointsRedemption"). |
--- identifiers | Array of Objects | List of identifiers related to the triggering activity. |
---- key | String | Key identifier (e.g., "bill Id"). |
---- value | String | Value corresponding to the key (e.g., "-1"). |
--- enteredBy | Object | Information about the user who entered the activity. |
---- id | Integer | Unique identifier for the user who entered the activity. |
--- entityInformation | Object | Contains information about the entity related to the triggering activity. |
---- entityType | String | Type of the entity (e.g., "USER"). |
---- entityId | Integer | Unique identifier for the entity. |
--- additionalAttributes | Array | Additional attributes related to the triggering activity (empty in this case). |
-- loyaltyProgramDetails | Object | Contains details about the loyalty program. |
--- id | Integer | Unique identifier for the loyalty program. |
--- name | String | Name of the loyalty program (e.g., "Louis PhilippeDefaultProgram"). |
--- isDefault | Boolean | Indicates if the program is the default program. |
--- pointsToCurrencyRatio | Float | Points-to-currency conversion ratio.. |
--- tiers | Array of Objects | List of tiers in the loyalty program. |
---- tierNumber | Integer | Number of the tier (e.g., 1 for Silver). |
---- tierName | String | Name of the tier (e.g., "Silver"). |
loyaltyProgramId | Integer | Unique identifier for the loyalty program. |
totalPointsRedeemed | Float | Total points redeemed in this transaction. |
redemptionSummaryId | Integer | Unique identifier for the redemption summary. |
redeemedPointsCurrencyValue | Float | Currency value of the redeemed points. |
redemptionNotes | String | Notes regarding the redemption (empty in this case). |
redemptionBillNumber | String | Bill number associated with the redemption. |
isGroupRedemption | Boolean | Indicates if the redemption is part of a group. |
-- redemptionFromEarningPrograms | Array of Objects | Details of redemption from earning programs. |
--- programId | Integer | Unique identifier for the earning program. |
--- points Redeemed | Float | Total points redeemed from the earning program. |
--- programCurrentPoints | Float | Current points in the program after redemption. |
loyaltyEventId | String | Unique identifier for the loyalty event. |
eventName | String | Name of the event (e.g., "pointsRedeemed"). |
refId | String | This is a combination of org id and loyalty event ID and is used for internal debugging purpose |
apiRequestId | String | Unique identifier for the API request. |
orgId | Integer | Unique identifier for the organization. |
Sample schema of group program redemption.
{
"eventId": "3b231837-db52-48cb-a405-cc162f2e1bd6",
"eventLogId": 34805323,
"eventType": "pointsRedeemed",
"consumerGroupId": null,
"actionType": " START",
"timeStamp": 1683874869558,
"attributes": {
"createdAt": 1683874869545,
"data": {
"customerIdentifiers": {
"customerId": 161943766,
"instore": {
"mobile": "917984690285",
"email ": "[email protected]"
}
},
"entityInformation": {
"entityType": "USER",
"entityId": 161943766
},
"triggeringActivity": {
"name": "PointsRedemption",
"identifiers": [
{
"key": "bill Id",
"value": "-1"
},
{
"key": "redemptionId",
"value": "xMQy8y"
}
],
"enteredBy": {
"id": 200316761
},
"entityInformation": {
"entityType": "USER",
"entityId": 161943766
},
"additionalAttributes": [
]
},
"loyaltyProgramDetails": {
"id": 101,
"name": "Louis PhilippeDefaultProgram",
"isDefault": true,
"pointsToCurrencyRatio": 0.5,
"tiers": [
{
"tierNumber": 1,
"tierName": " Silver"
},
{
"tierNumber": 2,
"tierName": "Gold"
},
{
"tierNumber": 3,
"tierName": "Platinum"
}
]
},
"loyaltyProgramId": 101,
"totalPointsRedeemed": 1500.0,
"redemptionSummaryId": 9547005,
"redeemedPointsCurrencyValue": 750.0,
"redemptionNotes": "",
"redemptionBillNumber": "SA8269614",
"isGroupRedemption": false,
"redemptionFromEarningPrograms": [
{
"programId": 101,
"points Redeemed": 1500.0,
"programCurrentPoints": 0.0
}
]
},
"loyaltyEventId": "SHjlZN6x2e",
"eventName": "pointsRedeemed",
"refId": "150098_SHjlZN6x2e",
"apiRequestId": "6f2131aeb479a10e5987a f16c915904b",
"orgId": 150098
}
}Sample schema of Participating Program Redemption
{
"eventName":"pointsRedeemed",
"eventId":"ABC-87484sdas&$",
"eventLogId": 34805312
"orgId":1655,
"refId":"1655_684494987",
"createdAt":156474848484,
"data":{
"customerIdentifiers":{
"customerId":876,
"Instore":{
"mobile":"919740000000",
"email":"[email protected]",
"externalId":"536236462453"
},
"wechat":{
"accounts":[
{
"accountId":"HDHSDHS32347287D",
"identifiers":[
{
"identifierType":"wechatId",
"identifierValue":"SGHDGAHA74278sdfG"
}
]
},
{
"accountId":"JKLMNOPuy4y3554Y",
"identifiers":[
{
"identifierType":"wechatId",
"identifierValue":"cbdhdhhad74278sdfj"
}
]
}
]
}
},
"triggeringActivity":{
"name":"pointsRedemption",
"identifiers":[
{
"key":"billId",
"value":"123456"
}
],
"enteredAt":{
"id":949,
"store":{
"code":"str1.brand",
"name":"str1.brand",
"externalId":"DFSDHGFSH6642664617",
"externalId1":"GDGSDHDGH3744277474",
"externalId2":"GHSDGHGHH6776246444"
},
"till":{
"code":"till1.str1.brand",
"name":"till1.str1.brand"
}
}
},
"loyaltyProgramId":1487,
"totalPointsRedeemed":235,
"redeemedPointsCurrencyValue":470,
"redemptionFromEarningPrograms":[
{
"programId":1487,
"pointsRedeemed":235,
"programCurrentPoints":500
}
]
}
}Promised Points Conversion to Current Points Event (promisedToCurrentPointsConversion)
Notifies when promised points are converted to current points in a loyalty program.
Parameter | Data Type | Description |
|---|---|---|
eventId | String | Unique identifier for the event. |
eventLogId | Integer | Unique ID that is generated when the event is triggered. |
eventType | String | It combines the orgid and event name (e.g., "1000006_promisedToCurrentPointsConversion"). |
consumerGroupId | Null | Identifier for the consumer group (null if not applicable). |
actionType | String | Action type of the event (e.g., "START"). |
timeStamp | Integer | Timestamp of the event in milliseconds since epoch. |
attributes | Object | Contains details about the event attributes. |
| Integer | Timestamp when the event was created (milliseconds since epoch). |
| Object | Contains specific data related to the event. |
-- customerIdentifiers | Object | Contains identifiers for the customer. |
--- customerId | Integer | Unique identifier for the customer. |
--- instore | Object | Contains in-store customer information. |
---- mobile | String | Mobile number of the customer. |
String | Email address of the customer. | |
-- entityInformation | Object | Contains information about the entity involved in the event. |
--- entityType | String | Type of the entity (e.g., "USER"). |
--- entityId | Integer | Unique identifier for the entity. |
-- earningActivityReference | Array of Objects | List of references to earning activities. |
--- name | String | Name of the earning activity (e.g., "TransactionAdd"). |
--- enteredAt | Float | Timestamp of when the activity was entered (in milliseconds). |
--- pointsConverted | Float | Points converted during the activity. |
--- identifiers | Array of Objects | List of identifiers related to the earning activity. |
---- key | String | Key identifier (e.g., "billNumber"). |
---- value | String | The value corresponding to the key. |
---- key (second) | String | Second key identifier (e.g., "EventLogId"). |
---- value (second) | String | The value corresponds to the second key. |
-- loyaltyProgramDetails | Object | Contains details about the loyalty program. |
--- id | Integer | Unique identifier for the loyalty program. |
--- name | String | Name of the loyalty program (e.g., "Tata 1mg"). |
--- isDefault | Boolean | Indicates if the program is the default program. |
--- pointsToCurrencyRatio | Float | Points-to-currency conversion ratio. |
--- tiers | Array of Objects | List of tiers in the loyalty program. |
---- tierNumber | Integer | Number of the tier (e.g., 1 for Base). |
---- tierName | String | Name of the tier (e.g., "Base"). |
loyaltyProgramId | Integer | Unique identifier for the loyalty program. |
pointsConverted | Float | Total points converted in this transaction. |
programCurrentPoints | Float | Current points in the program. |
programLifetimePoints | Float | Total points earned in the program lifetime. |
pointsConversionSource | String | Source of the points conversion (e.g., "systemTrigger"). |
pointsConvertedBreakup | Array | Breakdown of the converted points (empty in this case). |
loyaltyEventId | String | Unique identifier for the loyalty event. |
eventName | String | Name of the event (e.g., "promisedToCurrentPointsConversion"). |
refId | String | This is a combination of org id and loyalty event ID and is used for internal debugging purposes. |
apiRequestId | String | Unique identifier for the API request. |
orgId | Integer | Unique identifier for the organization. |
{
"eventId": "f993741a-89f3-46c8-b70f-6f45cfce7dba",
"eventLogId": 34805016,
"eventType": "1000006_promisedToCurrentPointsConversion",
"consumerGroupId": null,
"actionType": "START",
"timeStamp": 1683867642290,
"attributes": {
"createdAt": 1683867642243,
"data": {
"customerIdentifiers": {
"customerId": 130354474,
"instore": {
"mobile": "d9ace8e94d6f779ff845a401f9dd50a7",
"email": "d9ace8e94d6f779ff845a401f9dd50a7"
}
},
"entityInformation": {
"entityType": "USER",
"entityId": 130354474
},
"earningActivityReference": [
{
"name": "TransactionAdd",
"enteredAt": 1.657437873E12,
"pointsConverted": 0.0,
"identifiers": [
{
"key": "billNumber",
"value": "PO19022266733111"
},
{
"ke y": "EventLogId",
"value": "448823777"
}
]
}
],
"loyaltyProgramDetails": {
"id": 1000038,
"name": "Tata 1mg",
"isDefault": false,
"pointsToCurrencyRatio": 1.0,
"tiers": [
{
"tierNumber": 1,
"tierName": "Base"
},
{
"tierNumber": 2,
"tierName": "1MGCare"
}
]
},
"loyaltyProgramId": 1000038,
"pointsConverted": 0.269,
"programCurrentPoints": 0.269,
"programLifetimePoints": 13.269,
"pointsConversionSource": "systemTrigger",
"pointsConvertedBreakup": [
]
},
"loyaltyEventId": "9mQMu01tPA6me2X",
"eventName": "promisedToCurrentPointsConversion",
"refId": "1000006_9m QMu01tPA6me2X",
"apiRequestId": "6f9d2624-efa9-4010-a6e4-3022cfeb905b",
"orgId": 1000006
}
}Points Expired Event (pointsExpired)
Notifies when points earned by a user has expired.
| Parameter | Data Type | Description |
|---|---|---|
| eventName | String | Name of the event (e.g., "pointsExpired"). |
| eventId | String | Unique identifier for the event. |
| eventLogId | Integer | Unique ID that is generated when the event is triggered. |
| orgId | Integer | Unique identifier for the organization. |
| refId | String | This is used for internal debugging purposes. |
| createdAt | Integer | Timestamp when the event was created. |
| data | Object | Contains specific data related to the event. |
| -- customerIdentifiers | Object | Contains identifiers for the customer. |
| --- customerId | Integer | Unique identifier for the customer. |
| --- instore | Object | Contains in-store customer information. |
| ---- mobile | String | Mobile number of the customer. |
| String | Email address of the customer. | |
| ---- externalId | String | External identifier for the customer. |
| -- triggeringActivity | Object | Contains information about the activity that triggered the event (empty in this case). |
| loyaltyProgramId | Integer | Unique identifier for the loyalty program. |
| pointsExpired | Integer | Total points that have expired. |
{
"eventName":"pointsExpired",
"eventId":"abacd-12345-ABCD",
"eventLogId": 34111814,
"orgId":1655,
"refId":"1655_684494987",
"createdAt":156474848484,
"data":{
"customerIdentifiers":{
"customerId":876,
"instore":{
"mobile":"919740000000",
"email":"[email protected]",
"externalId":"536236462453"
}
},
"triggeringActivity":{
},
"loyaltyProgramId":1487,
"pointsExpired":1000
}
}Points Expired Reminder Event (pointsExpiryReminder)
Notifies when a user's points are about to expire.
| Field | Data Type | Description |
|---|---|---|
| eventName | String | Name of the event (e.g., "pointsExpiryReminder"). |
| eventId | String | Unique identifier for the event. |
| orgId | Integer | Unique identifier for the organization. |
| refId | String | This is used for internal debugging purposes |
| apiRequestId | String | Unique identifier for the API request. |
| createdAt | Integer | Timestamp when the event was created (milliseconds since epoch). |
| data | Object | Contains specific data related to the event. |
| -- customerIdentifiers | Object | Contains identifiers for the customer. |
| --- customerId | Integer | Unique identifier for the customer. |
| -- entityInformation | Object | Contains information about the entity involved in the event. |
| --- entityType | String | Type of the entity (e.g., "USER"). |
| --- entityId | Integer | Unique identifier for the entity. |
| -- loyaltyProgramDetails | Object | Contains details about the loyalty program. |
| --- id | Integer | Unique identifier for the loyalty program. |
| --- name | String | Name of the loyalty program (e.g., "DefaultProgram"). |
| --- isDefault | Boolean | Indicates if the program is the default program. |
| --- pointsToCurrencyRatio | Float | Points-to-currency conversion ratio. |
| --- tiers | Array of Objects | List of tiers in the loyalty program. |
| ---- tierNumber | Integer | Number of the tier (e.g., 1 for "A"). |
| ---- tierName | String | Name of the tier (e.g., "A"). |
| loyaltyProgramId | Integer | Unique identifier for the loyalty program. |
| pointsScheduledForExpiry | Integer | Total points scheduled for expiry. |
| scheduledExpiryDate | String | Date when the points are scheduled to expire (formatted as YYYY-MM-DD). |
| loyaltyEventId | Null | Unique identifier for the loyalty event (null if not applicable). |
{
"eventName": "pointsExpiryReminder",
"eventId": "bd69ac73-0c7c-471a-b2cd-1f8251b34b60",
"orgId": 50750,
"refId": "50750_7616f6fc-9cc3-4b92-9cfa-b1177ea25a6c",
"apiRequestId": "2cb3ea1a-0841-4cd4-ac6a-1adb1c3891d6",
"createdAt": 1685864957859,
"data": {
"customerIdentifiers": {
"customerId": 381750905
},
"entityInformation": {
"entityType": "USER",
"entityId": 381750905
},
"loyaltyProgramDetails": {
"id": 1933,
"name": "DefaultProgram",
"isDefault": true,
"pointsToCurrencyRatio": 1,
"tiers": [
{
"tierNumber": 1,
"tierName": "A"
},
{
"tierNumber": 2,
"tierName": "B"
},
{
"tierNumber": 3,
"tierName": "C"
}
]
},
"loyaltyProgramId": 1933,
"pointsScheduledForExpiry": 300,
"scheduledExpiryDate": "2023-06-19"
},
"loyaltyEventId": null
}Points Transferred Initiated Event (pointsTransferredInitiated)
Notifies when a points transfer for a user is initiated.
| Parameter | Data Type | Description |
|---|---|---|
| eventId | String | Unique identifier for the event. |
| eventLogId | Integer | Unique ID that is generated when the event is triggered. |
| eventType | String | Type of the event (e.g., "pointsTransferredInitiated"). |
| consumerGroupId | Integer | Identifier for the consumer group (null if not applicable). |
| actionType | String | Action type for the event (e.g., "START"). |
| timeStamp | Integer | Timestamp when the event occurred (milliseconds since epoch). |
| attributes | Object | Contains specific attributes related to the event. |
| -- createdAt | Integer | Timestamp when the attributes were created (milliseconds since epoch). |
| -- data | Object | Contains specific data related to the event. |
| --- customerIdentifiers | Object | Contains identifiers for the customer initiating the transfer. |
| ---- customerId | Integer | Unique identifier for the customer. |
| ---- instore | Object | Contains in-store customer information. |
| ----- mobile | String | Mobile number of the customer. |
| String | Email address of the customer. | |
| --- entityInformation | Object | Contains information about the entity initiating the transfer. |
| ---- entityType | String | Type of the entity (e.g., "USER"). |
| ---- entityId | Integer | Unique identifier for the entity. |
| --- loyaltyProgramDetails | Object | Contains details about the loyalty program. |
| ---- id | Integer | Unique identifier for the loyalty program. |
| ---- name | String | Name of the loyalty program (e.g., "newshard_orgDefaultProgram"). |
| ---- isDefault | Boolean | Indicates if the program is the default program. |
| ---- pointsToCurrencyRatio | Float | Points-to-currency conversion ratio. |
| ---- tiers | Array of Objects | List of tiers in the loyalty program. |
| ----- tierNumber | Integer | Number of the tier (e.g., 1 for "Silver"). |
| ----- tierName | String | Name of the tier (e.g., "Silver"). |
| loyaltyProgramId | Integer | Unique identifier for the loyalty program. |
| totalPointsTransferred | Float | Total points that were transferred. |
| --- transferReceivingCustomerIdentifiers | Object | Contains identifiers for the customer receiving the transfer. |
| ---- customerId | Integer | Unique identifier for the receiving customer. |
| ---- instore | Object | Contains in-store information for the receiving customer. |
| ----- mobile | String | Mobile number of the receiving customer. |
| String | Email address of the receiving customer. | |
| --- transferReceivingEntityInformation | Object | Contains information about the entity receiving the points. |
| ---- entityType | String | Type of the entity (e.g., "USER"). |
| ---- entityId | Integer | Unique identifier for the receiving entity. |
| --- redemptionFromEarningPrograms | Array of Objects | List of redemption details from earning programs. |
| ---- programId | Integer | Unique identifier for the earning program. |
| ---- pointsRedeemed | Float | Total points redeemed from the program. |
| ---- programCurrentPoints | Float | Current points available in the program. |
| loyaltyEventId | String | Unique identifier for the loyalty event. |
| eventName | String | Name of the event (e.g., "pointsTransferredInitiated"). |
| refId | String | This is a combination of org id and loyalty event ID and is used for internal debugging purposes. |
| apiRequestId | String | Unique identifier for the API request. |
| orgId | Integer | Unique identifier for the organization |
{
"eventId": "3c9d293a-f9bd-4a49-a54a-63d4af500b46",
"eventLogId": 34805034,
"eventType": "pointsTransferredInitiated",
"consumerGroupId": null,
"actionType": "START",
"timeStamp": 1683873247544,
"attributes": {
"createdAt": 1683873247465,
"data": {
"customerIdentifiers": {
"customerId": 545513704,
"instore": {
"mobile": " 917136866183",
"email": "[email protected]"
}
},
"entityInformation": {
"entityType": "USER",
"entityId": 545513704
},
"loyaltyProgramDetails": {
"id": 784,
"name": "newshard_orgDefaultProgram",
"isDefault": true,
"pointsToCurrencyRatio": 1.0,
"tiers": [
{
"tierNumber": 1,
"tierName": "Silver"
},
{
"tierNumber": 2,
"tierName": "Gold"
},
{
"tierNumber": 3,
"tierName": "Platinum"
}
]
},
"loyaltyProgramId": 784,
"totalPointsTransferred": 10.0,
"transferReceivingCustomerIdentifiers": {
"customerId": 545513705,
"instore": {
"mobile": "9189000 03219",
"email": "[email protected]"
}
},
"transferReceivingEntityInformation": {
"entityType": "USER",
"entityId": 545513705
},
"redemptionFromEarningPrograms": [
{
" programId": 784,
"pointsRedeemed": 10.0,
"programCurrentPoints": 90.0
}
]
},
"loyaltyEventId": "HNoDBilpg9",
"eventName": "pointsTransferredInitiated",
"refId": "1138_HNoDBilpg9",
"apiRe questId": "36f63b513c9f787526903e840ea4d04f",
"orgId": 1138
}
}Points Transferred Received (pointsTransferredReceived)
Notifies when a points transfer request of a user is received. Points transfer allows users to transfer their loyalty points to other users or user groups.
| Parameter | Data Type | Description |
|---|---|---|
| eventId | String | Unique identifier for the event. |
| eventLogId | Integer | Unique ID that is generated when the event is triggered. |
| eventType | String | Type of the event (e.g., "pointsTransferredReceived"). |
| consumerGroupId | Null | Identifier for the consumer group (null if not applicable). |
| actionType | String | Action type for the event (e.g., "START"). |
| timeStamp | Integer | Timestamp when the event occurred (milliseconds since epoch). |
| attributes | Object | Contains specific attributes related to the event. |
| -- createdAt | Integer | Timestamp when the attributes were created (milliseconds since epoch). |
| -- data | Object | Contains specific data related to the event. |
| --- customerIdentifiers | Object | Contains identifiers for the customer receiving the points. |
| ---- customerId | Integer | Unique identifier for the customer. |
| ---- instore | Object | Contains in-store customer information. |
| ----- mobile | String | Mobile number of the customer. |
| String | Email address of the customer. | |
| --- entityInformation | Object | Contains information about the entity receiving the points. |
| ---- entityType | String | Type of the entity (e.g., "USER"). |
| ---- entityId | Integer | Unique identifier for the entity. |
| --- loyaltyProgramDetails | Object | Contains details about the loyalty program. |
| ---- id | Integer | Unique identifier for the loyalty program. |
| ---- name | String | Name of the loyalty program (e.g., "newshard_orgDefaultProgram"). |
| ---- isDefault | Boolean | Indicates if the program is the default program. |
| ---- pointsToCurrencyRatio | Float | Points-to-currency conversion ratio. |
| ---- tiers | Array of Objects | List of tiers in the loyalty program. |
| ----- tierNumber | Integer | Number of the tier (e.g., 1 for "Silver"). |
| ----- tierName | String | Name of the tier (e.g., "Silver"). |
| loyaltyProgramId | Integer | Unique identifier for the loyalty program. |
| totalPointsTransferred | Float | Total points that were transferred. |
| --- transferInitiatingCustomerIdentifiers | Object | Contains identifiers for the customer initiating the transfer. |
| ---- customerId | Integer | Unique identifier for the initiating customer. |
| ---- instore | Object | Contains in-store information for the initiating customer. |
| ----- mobile | String | Mobile number of the initiating customer. |
| String | Email address of the initiating customer. | |
| --- transferInitiatingEntityInformation | Object | Contains information about the entity initiating the transfer. |
| ---- entityType | String | Type of the entity (e.g., "USER"). |
| ---- entityId | Integer | Unique identifier for the initiating entity. |
| loyaltyEventId | String | Unique identifier for the loyalty event. |
| eventName | String | Name of the event (e.g., "pointsTransferredReceived"). |
| refId | String | This is a combination of org id and loyalty event ID and is used for internal debugging purposes. |
| apiRequestId | String | Unique identifier for the API request. |
| orgId | Integer | Unique identifier for the organization. |
{
"eventId": "bb12e156-edfe-4a2d-9831-b1224ebb3d77",
"eventLogId": 34805034,
"eventType": "pointsTransferredReceived",
"consumerGroupId": null,
"actionType": "START",
"timeStamp": 1683873247673,
"attributes": {
"createdAt": 1683873247470,
"data": {
"customerIdentifiers": {
"customerId": 545513705,
"instore": {
"mobile": "91 8900003219",
"email": "[email protected]"
}
},
"entityInformation": {
"entityType": "USER",
"entityId": 545513705
},
"loyaltyProgramDetails": {
"id": 784,
"name": "n ewshard_orgDefaultProgram",
"isDefault": true,
"pointsToCurrencyRatio": 1.0,
"tiers": [
{
"tierNumber": 1,
"tierName": "Silver"
},
{
"tierNumber": 2,
"tierName": "Gold"
},
{
"tierNumber": 3,
"tierName": "Platinum"
}
]
},
"loyaltyProgramId": 784,
"totalPointsTransferred": 10.0,
"transferInitiatingCustomerIdentifiers": {
"customerId": 545513704,
"instore": {
"mobile": "91713686 6183",
"email": "[email protected]"
}
},
"transferInitiatingEntityInformation": {
"entityType": "USER",
"entityId": 545513704
}
},
"loyaltyEventId": "HNoDBilpg9",
"e ventName": "pointsTransferredReceived",
"refId": "1138_HNoDBilpg9",
"apiRequestId": "36f63b513c9f787526903e840ea4d04f",
"orgId": 1138
}
}
Redeemed Points Reversed Event (redeemedPointsReversed)
Notifies when redeemed points are reversed. Reversal of redeemed points occurs when a user does not use points they have redeemed for a transaction, or when the transaction for which points were redeemed is returned.
| Parameter | Data Type | Description |
|---|---|---|
| eventId | String | Unique identifier for the event. |
| eventLogId | Integer | Unique ID that is generated when the event is triggered. |
| eventType | String | Type of the event (e.g., "redeemedPointsReversed"). |
| consumerGroupId | Null | Identifier for the consumer group (null if not applicable). |
| actionType | String | Action type for the event (e.g., "START"). |
| timeStamp | Integer | Timestamp when the event occurred (milliseconds since epoch). |
| attributes | Object | Contains specific attributes related to the event. |
| -- createdAt | Integer | Timestamp when the attributes were created (milliseconds since epoch). |
| -- data | Object | Contains specific data related to the event. |
| --- customerIdentifiers | Object | Contains identifiers for the customer. |
| ---- customerId | Integer | Unique identifier for the customer. |
| ---- instore | Object | Contains in-store customer information. |
| ----- mobile | String | Mobile number of the customer. |
| String | Email address of the customer. | |
| --- entityInformation | Object | Contains information about the entity involved in the event. |
| ---- entityType | String | Type of the entity (e.g., "USER"). |
| ---- entityId | Integer | Unique identifier for the entity. |
| --- triggeringActivity | Object | Contains details about the activity that triggered the event. |
| ---- name | String | Name of the triggering activity (e.g., "PointsRedemptionReversal"). |
| ---- identifiers | Array of Objects | List of identifiers associated with the triggering activity. |
| ----- key | String | Key of the identifier (e.g., "redemptionId"). |
| ----- value | String | Value of the identifier (e.g., "CgDAgY"). |
| ---- enteredBy | Object | Information about who entered the activity. |
| ----- id | Integer | Unique identifier for the user who entered the activity. |
| ---- additionalAttributes | Array | Additional attributes related to the triggering activity. |
| --- loyaltyProgramDetails | Object | Contains details about the loyalty program. |
| ---- id | Integer | Unique identifier for the loyalty program. |
| ---- name | String | Name of the loyalty program (e.g., "Abbott ID_ProdDefaultProgram"). |
| ---- isDefault | Boolean | Indicates if the program is the default program. |
| ---- pointsToCurrencyRatio | Float | Points-to-currency conversion ratio. |
| ---- tiers | Array of Objects | List of tiers in the loyalty program. |
| ----- tierNumber | Integer | Number of the tier (e.g., 1 for "Bronze"). |
| ----- tierName | String | Name of the tier (e.g., "Bronze"). |
| --- loyaltyProgramId | Integer | Unique identifier for the loyalty program. |
| --- redeemedPointsReversed | Float | Total points that were reversed. |
| --- redeemedPointsReversedDetails | Object | Contains details about the reversed points. |
| ---- available | Float | Number of available reversed points. |
| ---- expired | Float | The number of expired reversed points. |
| --- redemptionSummaryId | Integer | Unique identifier for the redemption summary. |
| --- redemptionReversalToEarningPrograms | Array of Objects | List of earning programs affected by the reversal. |
| ---- programId | Integer | Unique identifier for the earning program. |
| ---- redeemedPointsReversed | Float | Amount of points reversed for the earning program. |
| ---- redeemedPointsReversedDetails | Object | Contains details about the reversed points for the earning program. |
| ----- available | Float | Number of available reversed points for the earning program. |
| ----- expired | Float | The number of expired reversed points for the earning program. |
| ---- programCurrentPoints | Float | Current points in the earning program after the reversal. |
| -- loyaltyEventId | String | Unique identifier for the loyalty event. |
| -- eventName | String | Name of the event (e.g., "redeemedPointsReversed"). |
| -- refId | String | This is a combination of org id and API request ID and is used for internal debugging purposes. |
| -- apiRequestId | String | Unique identifier for the API request. |
| -- orgId | Integer | Unique identifier for the organization |
{
"eventId": "a5058d77-370f-4544-a420-8337f9d5fbf1",
"eventLogId": 34805097,
"eventType": "redeemedPointsReversed",
"consumerGroupId": null,
"actionType": "START",
"timeStamp": 1683871439535,
"attributes": {
"createdAt": 1683871439518,
"data": {
"customerIdentifiers": {
"customerId": 6687782,
"instore": {
"mobile": "628577693 2889",
"email": "[email protected]"
}
},
"entityInformation": {
"entityType": "USER",
"entityId": 6687782
},
"triggeringActivity": {
"name": "PointsRedemptionReversal",
"identifiers": [
{
"key": "redemptionId",
"value": "CgDAgY"
}
],
"enteredBy": {
"id": 200279007
},
"additionalAttributes": [
]
},
"loyaltyProgramDetails": {
"id": 1095,
"name": "Abbott ID_ProdDef aultProgram",
"isDefault": true,
"pointsToCurrencyRatio": 1.0,
"tiers": [
{
"tierNumber": 1,
"tierName": "Bronze"
},
{
"tierNumber": 2,
"tierName": "Silver"
},
{
"tierNumber": 3,
"tierName ": "Gold"
},
{
"tierNumber": 4,
"tierName": "Platinum"
}
]
},
"loyaltyProgramId": 1095,
"redeemedPointsReversed": 300.0,
"redeemedPointsReversedDetails": {
"available": 300.0,
"expired": 0.0
},
"redemptionSummaryId": 2613711,
"redemptionReversalToEarningPrograms": [
{
"programId": 1095,
"redeemedPointsReversed": 300.0,
"redeemedPointsReversedDetails": {
"available": 300.0,
"expired": 0.0
},
"programCurrentPoints": 2600.0
}
]
},
"loyaltyEventId": "a261d029212a09eea3e99a18024d76a9",
"eventName": "redeemedPointsReversed",
"refId": "151193_a261d029212a09eea3e99a18024d 76a9",
"apiRequestId": "a261d029212a09eea3e99a18024d76a9",
"orgId": 151193
}
}Updated Single Points Expiry (singlePointsExpiryUpdated)
Notifies when the points expiry date is updated under the Single Points Expiry feature. Single Points Expiry is a feature in Capillary's Loyalty+ platform that allows points across all loyalty programs for different events to have a common expiry date.
| Parameter | Data Type | Description |
|---|---|---|
| eventId | String | Unique identifier for the event. |
| eventType | String | Type of the event (e.g., "singlePointsExpiryUpdated"). |
| consumerGroupId | Null | Identifier for the consumer group (null if not applicable). |
| actionType | String | Action type for the event (e.g., "START"). |
| timeStamp | Integer | Timestamp when the event occurred (milliseconds since epoch). |
| attributes | Object | Contains specific attributes related to the event. |
| -- createdAt | Integer | Timestamp when the attributes were created (milliseconds since epoch). |
| -- data | Object | Contains specific data related to the event. |
| --- customerIdentifiers | Object | Contains identifiers for the customer. |
| ---- customerId | Integer | Unique identifier for the customer. |
| --- entityInformation | Object | Contains information about the entity involved in the event. |
| ---- entityType | String | Type of the entity (e.g., "USER"). |
| ---- entityId | Integer | Unique identifier for the entity. |
| --- updatedPointsExpiry | Array of Objects | List of updated points expiry details. |
| ---- programId | Integer | Unique identifier for the loyalty program. |
| ---- points | Float | Number of points associated with the expiry update. |
| ---- pointsType | String | Type of points (e.g., "billRegular", "billPromotions"). |
| ---- oldExpiryDate | String | The previous expiry date of the points (in YYYY-MM-DD format). |
| ---- newExpiryDate | String | The new expiry date of the points (in YYYY-MM-DD format). |
| --- eventName | String | Name of the event (e.g., "singlePointsExpiryUpdated"). |
| --- refId | String | This is a combination of org id and apiRequestId and is used for internal debugging purposes. |
| --- apiRequestId | String | Unique identifier for the API request. |
| --- orgId | Integer | Unique identifier for the organization. |
{
"eventId": "a9f1dd54-0477-4a4f-a509-ed5c35cbce7a",
"eventType": "singlePointsExpiryUpdated",
"consumerGroupId ": null,
"actionType": "START",
"timeStamp": 1683867690435,
"attributes": {
"createdAt": 1683867690421,
"data": {
"customerIdentifiers": {
"customerId": 146272039
},
"entityInformation": {
"entityType": "USER",
"entityId": 146272039
},
"updatedPointsExpiry": [
{
"programId": 1000028,
"points": 3.0,
"pointsType": "billRegular",
"oldExpiryDate": "2024-03-23",
"newExpiryDate ": "2024-05-10"
},
{
"programId": 1000028,
"points": 5.0,
"pointsType": "billRegular",
"oldExpiryDate": "2024-05-10",
"newExpiryDate": "2024-05-10"
},
{
"programId": 1000007,
"points": 56.0,
"pointsType": "billPromotions",
"oldExpiryDate": "2024-03-23",
"newExpiryDate": "2024-05-10"
},
{
"programId": 1000007,
"points": 91.0,
"pointsType": "billPromotions",
"oldExpir yDate": "2024-05-10",
"newExpiryDate": "2024-05-10"
}
]
},
"eventName": "singlePointsExpiryUpdated",
"refId": "1000006_68421c2fbcbeead306651eeb514ef109",
"apiRequestId": "68421c2fbcbe ead306651eeb514ef109",
"orgId": 1000006
}
}Issued Points Reversed Event (issuedPointsReversed)
Notifies when points issued for a user has been reversed. For example, a user has returned a purchase and the points issued have been reversed.
| Parameter | Data Type | Description |
|---|---|---|
| eventName | String | Name of the event (e.g., "issuedPointsReversed"). |
| eventId | String | Unique identifier for the event. |
| eventLogId | Integer | Unique ID that is generated when the event is triggered. |
| data | Object | Contains specific data related to the event. |
| -- customerIdentifiers | Object | Contains identifiers for the customer. |
| --- customerId | Integer | Unique identifier for the customer. |
| --- instore | Object | Contains instore identification details of the customer. |
| ---- mobile | String | Mobile number of the customer. |
| String | Email address of the customer. | |
| -- entityInformation | Object | Contains information about the entity involved in the event. |
| --- entityType | String | Type of the entity (e.g., "USER"). |
| --- entityId | Integer | Unique identifier for the entity. |
| -- triggeringActivity | Object | Contains details of the activity that triggered this event. |
| --- name | String | Name of the triggering activity (e.g., "ReturnBill"). |
| --- identifiers | Array of Objects | List of identifiers related to the triggering activity. |
| ---- key | String | Identifier key (e.g., "billId", "billNumber"). |
| ---- value | String | Value corresponding to the key. |
| --- enteredBy | Object | Information about who entered the triggering activity. |
| ---- id | Integer | Unique identifier for the person who entered the activity. |
| --- entityInformation | Object | Information about the entity involved in the triggering activity. |
| ---- entityType | String | Type of the entity (e.g., "USER"). |
| ---- entityId | Integer | Unique identifier for the entity. |
| --- additionalAttributes | Array | Additional attributes related to the triggering activity (empty if none). |
| -- loyaltyProgram Details | Object | Contains details about the loyalty program. |
| --- id | Integer | Unique identifier for the loyalty program. |
| --- name | String | Name of the loyalty program (e.g., "Shell Indonesia_ProdDefaultProgram"). |
| --- isDefault | Boolean | Indicates if this is the default program. |
| --- pointsToCurrencyRatio | Float | Ratio of points to currency value. |
| --- tiers | Array of Objects | List of tiers in the loyalty program. |
| ---- tierNumber | Integer | The number of the tier. |
| ---- tierName | String | Name of the tier. |
| -- loyaltyProgramId | Integer | Unique identifier for the loyalty program. |
| -- programCurrentPoints | Float | Current points available in the loyalty program. |
| -- programLifetimePoints | Float | Total lifetime points accumulated in the loyalty program. |
| -- totalIssuedPointsReversed | Float | Total points issued that have been reversed. |
| -- regularPointsReversed | Float | Total regular points that have been reversed. |
| -- promisedPointsReversed | Float | Total promised points that have been reversed. |
| -- promotionalPointsReversed | Array | List of promotional points that have been reversed (empty if none). |
| -- currentEventPromisedPointsReturned | Float | Total promised points returned in the current event. |
| -- currentEventRegularPointsReturned | Float | Total regular points returned in the current event. |
| -- currentEventTotalPointsReturned | Float | Total points returned in the current event. |
| -- currentEventPromotionPointsReturnedDetails | Array | Details of promotional points returned in the current event (empty if none). |
| orgId | Integer | Unique identifier for the organization. |
| refId | String | This is a combination of org id and loyalty event ID and is used for internal debugging purposes. |
| apiRequestId | String | Unique identifier for the API request. |
| createdAt | Integer | Timestamp when the event was created (milliseconds since epoch). |
| loyaltyEventId | String | Unique identifier for the loyalty event. |
{
"eventName": "issuedPointsReversed",
"eventId": "a9f1dd54-0477-4a4f-a509-ed5c35cbce7a",
"eventLogId": 34805034,
"data": {
"customerIdentifiers": {
"customerId": 6767040,
"instore": {
"mobile": "6289652442647",
"email": "[email protected]"
}
},
"entityInformation": {
"entityType": "USER",
"entityId": 6767040
},
"triggeringActivity": {
"name": "ReturnBill",
"identifiers": [
{
"key": "billId",
"value": "65658330"
},
{
"key": "billNumber",
"value": "2_6594_12743097_6586"
}
],
"enteredBy": {
"id": 200291531
},
"entityInformation": {
"entityType": "USER",
"entityId": 6767040
},
"additionalAttributes": [
]
},
"loyaltyProgram Details": {
"id": 1098,
"name": "Shell Indonesia_ProdDefaultProgram",
"isDefault": true,
"pointsToCurrencyRatio": 1.0,
"tiers": [
{
"tierNumber": 1,
"tierName": "NONE"
}
]
},
"loyaltyProgramId": 1098,
"programCurrentPoints": 0.0,
"programLifetimePoints": 0.0,
"totalIssuedPointsReversed": 2.0,
"regularPointsReversed": 2.0,
"promisedPointsReversed": 0.0,
"promotionalPointsReversed": [
],
"currentEventPromisedPointsReturned": 0.0,
"currentEventRegularPointsReturned": 2.0,
"currentEventTotalPointsReturned": 2.0,
"currentEventPromotionPointsReturnedDetails": [
]
},
"or gId": 151195,
"refId": "151195_Jqo9Kup5Bm",
"apiRequestId": "1f575ed0ef2095a1c56714d6b1e961c0",
"createdAt": 1683874940147,
"loyaltyEventId": "Jqo9Kup5Bm"
}
Manual Points Adjustment Event (manualPointsAdjustment)
Notifies whenever points are adjusted/deducted manually.
{
"eventName": "manualPointsAdjustment",
"data": {
"customerIdentifiers": {
"customerId": 1758,
"firstName": "UQDSNI",
"lastName": "AAWFXYIU",
"loyaltyType": "QRGZ",
"instore": {
"id": 7189,
"mobile": "HQPJVKEWIO",
"email": "IBMEMP",
"externalId": "UKCUFFFU",
"cardnumber": "TTRX",
"cardexternalid": "XNCLUWP",
"cardNumbers": [
"KIAZ"
]
},
"facebook": {
"accounts": [
{
"accountId": "MZBUUYLJFY",
"identifiers": [
{
"identifierType": "APKVE",
"identifierValue": "SYRI"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "IOZ",
"identifiers": [
{
"identifierType": "VNWVKXSH",
"identifierValue": "ELLM"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "DQEIBNUG",
"identifiers": [
{
"identifierType": "RBLGXPLDE",
"identifierValue": "AHQJZKP"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "CPJAMEI",
"identifiers": [
{
"identifierType": "MWJUGII",
"identifierValue": "DPA"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "GIT",
"identifiers": [
{
"identifierType": "YTGWQO",
"identifierValue": "HEUAERYR"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "SADEF",
"identifiers": [
{
"identifierType": "BKICFEMEL",
"identifierValue": "XUJCBLIC"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "SWKTBMWXWT",
"identifiers": [
{
"identifierType": "HMUVXJSQDC",
"identifierValue": "LOJK"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "IKH",
"identifiers": [
{
"identifierType": "UIVK",
"identifierValue": "WZMZVQZAV"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "TXUZCEH",
"identifiers": [
{
"identifierType": "GYNVKPV",
"identifierValue": "TKTHDVOVGK"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "EWEYBM",
"identifiers": [
{
"identifierType": "CZEI",
"identifierValue": "WVRZ"
}
]
}
]
}
},
"triggeringActivity": {
"name": "MNAMWHHEA",
"identifiers": [
{
"key": "KJQQMRFB",
"value": "COFVYLXLQ"
}
],
"enteredBy": {
"id": 4518,
"till": {
"code": "CEESGN",
"name": "XUR"
},
"store": {
"code": "UOVSN",
"name": "XTHGLSQJ",
"externalId": "GLMPVHORI",
"externalId1": "SQP",
"externalId2": "AWVZXGL"
}
},
"entityInformation": {
"entityType": "RGNVYWH",
"entityId": 7399
},
"additionalAttributes": [
{
"key": "ZOPCTILV",
"value": "QIZ"
}
]
},
"totalPoinstDeducted": "KVLBL",
"programPointsSplit": [
{
"pointsAwardedId": 5563,
"programId": 5201,
"points": "MTI",
"pointsType": "VTGKSKGRSX"
}
],
"reason": "RNRS"
},
"eventId": "LQRMEP",
"eventLogId": 34805085,
"orgId": 3645,
"refId": "YJKTQHW",
"apiRequestId": "ZVWB",
"createdAt": 2131,
"loyaltyEventId": "QICGTBS",
"traceAttributes": {
"LNYTCZ": "OOKQVJP",
"FSAXZ": "DXFIGJN",
"BCCTVSRU": "VNSDASROL",
"IQMTZR": "BWDCJRK",
"TGO": "UYNYM"
}
}Points Expiry Change Event (pointsExpiryChange)
Notifies when a points expiry date changes.
{
"eventName": "pointsExpiryChange",
"data": {
"customerIdentifiers": {
"customerId": 4641,
"firstName": "WVKZIOEWT",
"lastName": "FEQKBQT",
"loyaltyType": "QSGORU",
"instore": {
"id": 3349,
"mobile": "YGUBCIUA",
"email": "XXNDOK",
"externalId": "YYVHQYQ",
"cardnumber": "XVUZ",
"cardexternalid": "SNEG",
"cardNumbers": [
"WJOZ"
]
},
"facebook": {
"accounts": [
{
"accountId": "OPQOYMKUHT",
"identifiers": [
{
"identifierType": "DPQGYCLK",
"identifierValue": "ENIFFN"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "NGTH",
"identifiers": [
{
"identifierType": "WUHZMJOTS",
"identifierValue": "QSZHE"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "APBUCK",
"identifiers": [
{
"identifierType": "IBVUKGMS",
"identifierValue": "ZII"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "CCAPRK",
"identifiers": [
{
"identifierType": "WGBMHJPIMN",
"identifierValue": "TOZXM"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "BWWNBYQVV",
"identifiers": [
{
"identifierType": "FJNFWMLO",
"identifierValue": "PHKNDXPZRU"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "SITHI",
"identifiers": [
{
"identifierType": "MUAU",
"identifierValue": "FXFEFNU"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "IUVXQIWW",
"identifiers": [
{
"identifierType": "EPTRNQYDE",
"identifierValue": "XUJJIWRI"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "ZDWBVR",
"identifiers": [
{
"identifierType": "VZYVLN",
"identifierValue": "KPSV"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "YALFSGSQZ",
"identifiers": [
{
"identifierType": "MKNAYDWFB",
"identifierValue": "EXUIQ"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "RUVLRDYSU",
"identifiers": [
{
"identifierType": "UZPBAHR",
"identifierValue": "CUTZWOO"
}
]
}
]
}
},
"entityInformation": {
"entityType": "FRXKWQICWL",
"entityId": 8959
},
"triggeringActivity": {
"name": "POVHEWMEL",
"identifiers": [
{
"key": "PGOZULPW",
"value": "EAOXDT"
}
],
"enteredBy": {
"id": 4214,
"till": {
"code": "KQWMO",
"name": "NHRYABBXUZ"
},
"store": {
"code": "RCSWZCKED",
"name": "XVDSQAGDWY",
"externalId": "QUW",
"externalId1": "HOYRXJ",
"externalId2": "DEXNVCZF"
}
},
"entityInformation": {
"entityType": "NVQDGZBR",
"entityId": 5911
},
"additionalAttributes": [
{
"key": "HNWKJVLAU",
"value": "VMAAZEOOP"
}
]
},
"loyaltyProgramDetails": {
"id": 8128,
"name": "YEWWHFCVW",
"isDefault": false,
"pointsToCurrencyRatio": 2962.620522120906,
"tiers": [
{
"tierNumber": 1894,
"tierName": "GSLSFZYWZ"
}
]
},
"updatedPointsExpiryBreakup": [
{
"pointAwardedRefID": 1171,
"pointsAwardedRefType": "LVVD",
"promotionID": 4623,
"points": 7844.736601561621,
"pointsPreviousExpiryDate": "AHL",
"expiryUpdateReasonType": "UXCLOEI",
"expiryUpdateReasonNote": "AZTRNNS",
"newExpiryDate": "FRN",
"newExpirySetType": "NFQFBKVG"
}
]
},
"eventId": "ERPX",
"orgId": 4671,
"refId": "FIDLZHB",
"apiRequestId": "VNABEYLQI",
"createdAt": 8366,
"loyaltyEventId": "NYJZAGJDW",
"traceAttributes": {
"QMZPAITQOM": "WPU",
"YPHESNB": "NKSFFI",
"XJBWMHAK": "IFDHCBY"
}
}Promised/External Points Conversion Event
Notifies when a Promised/External Points are converted for a customer.
{
"createdAt": 1739857872597,
"loyaltyEventId": "WAN63O3tpr",
"eventName": "promisedToCurrentPointsConversion",
"eventLogId": 34219968,
"refId": "50402_WAN63O3tpr",
"apiRequestId": "9467677c550449826d9207cec30848c1",
"orgId": 50402,
"data": {
"customerIdentifiers": {
"customerId": 348201654,
"instore": {
"mobile": "672919878345733",
"cardNumbers": []
}
},
"entityInformation": {
"entityType": "USER",
"entityId": 348201654
},
"earningActivityReference": [
{
"name": "TransactionAdd",
"enteredAt": 1.73985783E12,
"pointsConverted": 1200.0,
"identifiers": [
{
"key": "billNumber",
"value": "1739857829"
},
{
"key": "EventLogId",
"value": "34219920"
}
]
}
],
"loyaltyProgramDetails": {
"id": 1143,
"name": "Nirvana DefaultProgram",
"isDefault": true,
"pointsToCurrencyRatio": 1.0,
"tiers": [
{
"tierNumber": 1,
"tierName": "Bronze"
},
{
"tierNumber": 2,
"tierName": "Silver"
},
{
"tierNumber": 3,
"tierName": "Gold"
}
]
},
"loyaltyProgramId": 1143,
"pointsConverted": 1200.0,
"pointsConvertedType": "EXTERNAL_TRIGGER_BASED_POINTS",
"programCurrentPoints": 1200.0,
"programLifetimePoints": 1200.0,
"pointsConversionSource": "systemTrigger",
"pointsConvertedBreakup": []
}
}
```json
```json
{
"createdAt": 1739859870860,
"loyaltyEventId": "mBbJnPSQ0XOIwF5",
"eventName": "promisedToCurrentPointsConversion",
"eventLogId": 34220447,
"refId": "50402_mBbJnPSQ0XOIwF5",
"apiRequestId": "2d726c58-0bd0-4cec-8cc1-e80c5f5325db",
"orgId": 50402,
"data": {
"customerIdentifiers": {
"customerId": 348201817,
"instore": {
"mobile": "672919878345735",
"cardNumbers": []
}
},
"entityInformation": {
"entityType": "USER",
"entityId": 348201817
},
"earningActivityReference": [
{
"name": "TransactionAdd",
"enteredAt": 1.739859807E12,
"pointsConverted": 100.0,
"identifiers": [
{
"key": "billNumber",
"value": "1739859806"
},
{
"key": "EventLogId",
"value": "34220423"
}
]
}
],
"loyaltyProgramDetails": {
"id": 1143,
"name": "Nirvana DefaultProgram",
"isDefault": true,
"pointsToCurrencyRatio": 1.0,
"tiers": [
{
"tierNumber": 1,
"tierName": "Bronze"
},
{
"tierNumber": 2,
"tierName": "Silver"
},
{
"tierNumber": 3,
"tierName": "Gold"
}
]
},
"loyaltyProgramId": 1143,
"pointsConverted": 100.0,
"pointsConvertedType": "PROMISED_POINTS",
"programCurrentPoints": 0.0,
"programLifetimePoints": 0.0,
"pointsConversionSource": "systemTrigger",
"pointsConvertedBreakup": []
}
}
```json
```json
{
"createdAt": 1739860477069,
"loyaltyEventId": "",
"eventName": "promisedToCurrentPointsConversion",
"eventLogId": 34220923,
"refId": "",
"apiRequestId": "0755f2991e6773b2e818e6a151a3d108",
"orgId": 50402,
"data": {
"customerIdentifiers": {
"customerId": 348201817
},
"earningActivityReference": [],
"pointsConverted": 600.0,
"eventDateTime": "2025-02-18 06:34:37",
"pointsConversionSource": "externalTrigger",
"eventLogId": 34220923,
"billId": 37245321,
"pointsConvertedBreakup": [
{
"entityName": "BILL",
"entityDetails": {
"id": 37245321
},
"promotionalPointsBreakup": [],
"nonPromotionalPointsBreakup": [
{
"points": "600.000",
"programId": 1143
}
]
}
]
}
}Alternate currencies
An alternate currency is a type of reward currency, similar to points, that brands can create and use within their loyalty programs to incentivise customer behavuior.
Alternate currencies issued (alternateCurrenciesIssued)
Notifies when alternate currencies are issued to a user.
{
"data": {
"customerIdentifiers": {
"customerId": 386959475,
"instore": {
"email": "[email protected]",
"mobile": "917237869215"
}
},
"entityInformation": {
"entityId": 386959475,
"entityType": "USER"
},
"loyaltyProgramDetails": {
"id": 2645,
"isDefault": true,
"name": "Test_OrgDefaultProgram",
"pointsToCurrencyRatio": 1,
"tiers": [
{
"tierName": "Default_tier",
"tierNumber": 1
},
{
"tierName": "Silver_tier",
"tierNumber": 2
},
{
"tierName": "Gold_tier",
"tierNumber": 2
}
]
},
"loyaltyProgramId": 2645,
"alternateCurrencies": [
{
"alternateCurrencyName": "stars",
"alternateCurrencyIdentifier": "dsgagg",
"programCurrentAlternateCurrencies": 130,
"programLifetimeAlternateCurrencies": 130,
"promisedAlternateCurrenciesIssued": [
{
"promisedAlternateCurrencies": 10,
"isExternalTriggerBased": true,
"promisedAlternateCurrenciesConversionDate": "2024-05-17",
"promotionIdentifier": "sdged181-7e91-4abe-86cd-sgdcee9b8ccf"
}
],
"promotionalAlternateCurrenciesIssued": [
{
"promotionName": "promo1",
"promotionIdentifier": "528d181-7e91-4abe-86cd-598cee9b8ccf",
"promotionAlternateCurrencies": 100,
"promotionAlternateCurrenciesExpiryDate": "2025-05-31",
"promotionType": "CUSTOMER_PROMOTION"
},
{
"promotionName": "promo2",
"promotionIdentifier": "a6cb5a7e-3d84-4f1f-87c6-5f26006f6392",
"promotionAlternateCurrencies": 10,
"promotionAlternateCurrenciesExpiryDate": "2025-05-31",
"promotionType": "CUSTOMER_PROMOTION"
}
],
"regularAlternateCurrenciesBreakup": [
{
"alternateCurrencies": 10,
"expiryAt": "2025-05-31"
}
],
"regularAlternateCurrenciesIssued": 0,
"totalAlternateCurrenciesIssued": 130
},
{
"alternateCurrencyName": "coins",
"alternateCurrencyIdentifier": "gwggdg",
"programCurrentAlternateCurrencies": 130,
"programLifetimeAlternateCurrencies": 130,
"promisedAlternateCurrenciesIssued": [
{
"promisedAlternateCurrencies": 10,
"isExternalTriggerBased": true,
"promisedAlternateCurrenciesConversionDate": "2024-05-17",
"promotionIdentifier": "sdged181-7e91-4abe-86cd-sgdcee9b8ccf"
}
],
"promotionalAlternateCurrenciesIssued": [
{
"promotionName": "promo1",
"promotionIdentifier": "528d181-7e91-4abe-86cd-598cee9b8ccf",
"promotionAlternateCurrencies": 100,
"promotionAlternateCurrenciesExpiryDate": "2025-05-31",
"promotionType": "CUSTOMER_PROMOTION"
},
{
"promotionName": "promo2",
"promotionIdentifier": "a6cb5a7e-3d84-4f1f-87c6-5f26006f6392",
"promotionAlternateCurrencies": 10,
"promotionAlternateCurrenciesExpiryDate": "2025-05-31",
"promotionType": "CUSTOMER_PROMOTION"
}
],
"regularAlternateCurrenciesBreakup": [
{
"alternateCurrencies": 10,
"expiryAt": "2025-05-31"
}
],
"regularAlternateCurrenciesIssued": 0,
"totalAlternateCurrenciesIssued": 130
}
],
"triggeringActivity": {
"additionalAttributes": {},
"enteredBy": {
"id": 50672906
},
"entityInformation": {
"entityId": 386959475,
"entityType": "USER"
},
"identifiers": [
{
"key": "CustomerId",
"value": "386959475"
}
],
"name": "TargetCompleted"
}
},
"eventId": "1de73162-daf8-4c39-bc63-0af20bb4371e",
"eventLogId": 34805034,
"eventName": "alternateCurrenciesIssued",
"loyaltyEventId": "1c1716568b10135aa4e59fda77935ea2014b3bfc",
"orgId": 51182,
"refId": "51182_1c1716568b10135aa4e59fda77935ea2014b3bfc"
}
Issued Alternate Currency Reversed (issuedAlternateCurrenciesReversed)
Notifies when alternate currencies issued to the user are reversed. For example, issued alternate currencies for a line-item is reversed when a customer returns the item.
{
"data": {
"customerIdentifiers": {
"customerId": 386959475,
"instore": {
"email": "[email protected]",
"mobile": "917237869215"
}
},
"entityInformation": {
"entityId": 386959475,
"entityType": "USER"
},
"loyaltyProgramDetails": {
"id": 2645,
"isDefault": true,
"name": "Test_OrgDefaultProgram",
"pointsToCurrencyRatio": 1,
"tiers": [
{
"tierName": "Default_tier",
"tierNumber": 1
},
{
"tierName": "Silver_tier",
"tierNumber": 2
},
{
"tierName": "Gold_tier",
"tierNumber": 2
}
]
},
"loyaltyProgramId": 2645,
"alternateCurrencies": [
{
"currentEventPromisedAlternateCurrenciesReturned": 10,
"currentEventRegularAlternateCurrenciesReturned": 10,
"currentEventTotalAlternateCurrenciesReturned": 130,
"currentEventPromotionAlternateCurrenciesReturnedDetails": [
{
"promotionIdentifier": "528d181-7e91-4abe-86cd-598cee9b8ccf",
"promotionAlternateCurrencies": 100,
"promotionType": "BILL"
},
{
"promotionIdentifier": "a6cb5a7e-3d84-4f1f-87c6-5f26006f6392",
"promotionAlternateCurrencies": 10,
"promotionType": "BILL"
}
],
"alternateCurrencyName": "stars",
"alternateCurrencyIdentifier": "dsgagg",
"programCurrentAlternateCurrencies": 0,
"programLifetimeAlternateCurrencies": 0,
"promisedAlternateCurrenciesReversed": 10,
"promotionalAlternateCurrenciesReversed": [
{
"promotionIdentifier": "528d181-7e91-4abe-86cd-598cee9b8ccf",
"promotionAlternateCurrencies": 100,
"promotionType": "CUSTOMER_PROMOTION"
},
{
"promotionIdentifier": "a6cb5a7e-3d84-4f1f-87c6-5f26006f6392",
"promotionAlternateCurrencies": 10,
"promotionType": "CUSTOMER_PROMOTION"
}
],
"regularAlternateCurrenciesReversed": 10,
"totalAlternateCurrenciesReversed": 130
},
{
"alternateCurrencyName": "coins",
"alternateCurrencyIdentifier": "gwggdg",
"programCurrentAlternateCurrencies": 0,
"programLifetimeAlternateCurrencies": 0,
"promisedAlternateCurrenciesReversed": 10,
"promotionalAlternateCurrenciesReversed": [
{
"promotionIdentifier": "528d181-7e91-4abe-86cd-598cee9b8ccf",
"promotionAlternateCurrencies": 100,
"promotionType": "BILL"
},
{
"promotionIdentifier": "a6cb5a7e-3d84-4f1f-87c6-5f26006f6392",
"promotionAlternateCurrencies": 10,
"promotionType": "BILL"
}
],
"regularAlternateCurrenciesReversed": 10,
"totalAlternateCurrenciesReversed": 130
}
],
"triggeringActivity": {
"additionalAttributes": {},
"enteredBy": {
"id": 50672906
},
"entityInformation": {
"entityId": 386959475,
"entityType": "USER"
},
"identifiers": [
{
"key": "billId",
"value": "0"
},
{
"key": "billNumber",
"value": "454545"
}
],
"name": "ReturnBill"
},
"eventId": "1de73162-daf8-4c39-bc63-0af20bb4371e",
"eventLogId": 34805034,
"eventName": "issuedalternateCurrenciesReversed",
"loyaltyEventId": "1c1716568b10135aa4e59fda77935ea2014b3bfc",
"orgId": 51182,
"refId": "51182_1c1716568b10135aa4e59fda77935ea2014b3bfc"
}
}
Promised Alternate Currencies Issued Event (promisedToCurrentAlternateCurrencyConversion)
Notifies when promised alternate currencies are issued to the user.
{
"eventName": "promisedToCurrentAlternateCurrencyConversion",
"eventId": "74cb223f-fefe-4703-84a7-d3a40670c086",
"eventLogId": 35496773,
"orgId": 51174,
"refId": "",
"apiRequestId": "335e474bd1382e95fc39111a869dbef1",
"createdAt": 1740371965437,
"data": {
"customerIdentifiers": {
"customerId": 387676494
},
"entityInformation": {
"entityType": "USER",
"entityId": 387676494
},
"earningAlternateCurrencyReference": [],
"loyaltyProgramDetails": {
"id": 0,
"tiers": []
},
"loyaltyProgramId": 0,
"alternateCurrencyConverted": [
{
"alternateCurrencyIdentifier": "yJngjy",
"alternateCurrencyName": "#ac2_PROMISED",
"alternateCurrencyValue": "200.000"
},
{
"alternateCurrencyIdentifier": "lfHckz",
"alternateCurrencyName": "SBI_PROMISED",
"alternateCurrencyValue": "200.000"
}
],
"alternateCurrencyConversionSource": "externalTrigger",
"alternateCurrencyConvertedBreakup": [
{
"alternateCurrencyEntityDetails": {
"alternateCurrencyIdentifier": "yJngjy",
"alternateCurrencyName": "#ac2_PROMISED",
"alternateCurrencyValue": "200.000",
"billNumber": "2152008945",
"itemCode": "0"
},
"promotionalAlternateCurrencyBreakup": [
{
"alternateCurrencyIdentifier": "yJngjy",
"alternateCurrencyName": "#ac2_PROMISED",
"alternateCurrencyValue": "200.000",
"programId": 2607,
"promotionId": 1133576797,
"promotionName": "UnlockACandNormalPoints"
}
],
"nonPromotionalAlternateCurrencyBreakup": []
},
{
"alternateCurrencyEntityDetails": {
"alternateCurrencyIdentifier": "lfHckz",
"alternateCurrencyName": "SBI_PROMISED",
"alternateCurrencyValue": "200.000",
"billNumber": "2152008945",
"itemCode": "0"
},
"promotionalAlternateCurrencyBreakup": [
{
"alternateCurrencyIdentifier": "lfHckz",
"alternateCurrencyName": "SBI_PROMISED",
"alternateCurrencyValue": "100.000",
"programId": 2607,
"promotionId": 1133576797,
"promotionName": "UnlockACandNormalPoints"
}
],
"nonPromotionalAlternateCurrencyBreakup": [
{
"alternateCurrencyIdentifier": "lfHckz",
"alternateCurrencyName": "SBI_PROMISED",
"alternateCurrencyValue": "100.000",
"programId": 2607
}
]
}
]
},
"loyaltyEventId": ""
}Loyalty customer
Loyalty Customer Merge Event (loyaltyCustomerMerge)
Notifies on merging of loyalty users.
{
"eventName": "loyaltyCustomerMerge",
"data": {
"survivorCustomerIdentifiers": {
"customerId": 163879182
},
"victimCustomerIdentifiers": {
"customerId": 163879181
},
"triggeringActivity": {
"name": "customerMerge",
"identifiers": [
],
"additionalAttributes": [
]
},
"enteredBy": {
"id": -1
},
"survivorCustomerLoyaltySummary": [
{
"loyaltyProgramId": 18,
"lifetimePoints": 200.0,
"currentPoints": 200.0,
"promisedPoints": 0.0,
"tierNumber": 3
}
]
},
"orgId": 150014,
"refId": "150014_13960169",
"apiRequestId": "13960169",
"createdAt": 1683871320301
}
Updated about 7 hours ago