Event schema (Payload)
This page provides the schema of transaction and customer events with sample data.
Customer
Customer Added Event (customerAdded)
Notifies when a user is added.
Parameter | Datatype | Description |
---|---|---|
eventName | String | Name of the event. |
eventId | String | Used by the consumer of the event notification for idempotency check, i.e., to check if the event is duplicate or unique before saving the event. If duplicate, the consumer should ignore the event. |
orgId | Integer | Capillary organization ID |
refId | String | Reference ID for the internal debugging purpose. |
customerId | Integer | Unique identifier for the customer. |
mobile | Integer | Mobile number of the customer. |
String | Email ID of the customer. | |
externalId | String | External ID associated with the customer. |
card_number | Integer | Card number associated with the customer. |
apiRequestId | String | Internal request ID generated for the API request. |
createdAt | Integer | Unix timestamp in milliseconds when the event was stored in Capillary. |
{
"eventId": "81b1f0ce-8119-4826-9cca-610bd31d4038",
"eventType": "150698_customerAdded",
"consumerGroupId": null,
"actionType": "START",
"timeStamp": 1683874799984,
"attributes": {
"createdAt": 1683874799971,
"data": {
"loyaltyType": "LOYALTY",
"source": "instore",
"firstName": "ROSMA",
"lastName": "DEW I",
"enteredAt": 1683883798000,
"enteredBy": {
"id": 200320889,
"till": {
"code": "kanmo.idn.mothercare.rpm",
"name": "kanmo.idn.mothercare.rpm"
},
"store": {
"code": "kanmo.idn.mother care.rpm",
"name": "Mothercare RSIA Paramount Makassar",
"externalId": "MOTHERCARERPM",
"externalId1": "",
"externalId2": ""
}
},
"customerIdentifiers": {
"customerId": 164875382,
"instore": {
"mobile": "6282396092287",
"email": "rosmadewidewi@gmail.com",
"externalId": "226682932023"
}
}
},
"eventName": "customerAdded",
"refId": "150698_164875382",
"apiRequestId ": "0c52fc98594959bf0d577218bf565798",
"orgId": 150698
}
}
Customer Updated Event (customerUpdated)
Notifies when details of a user are updated. For example, name, extended fields, custom fields, and user status. User subscription updates are not supported.
Parameter | Datatype | Description |
---|---|---|
loyaltyType | Enum | Type of customer loyalty - LOYALTY, NON_LOYALTY |
source | String | Capillary organization ID |
String | Email ID of the customer. | |
mobile | String | Mobile number of the customer. |
card_number | Integer | Card number associated with the customer. |
enteredAt | Integer | Unix timestamp in milliseconds when the event was stored in Capillary. |
enteredBy | String | Source from which customer details are updated. Value: FACEBOOK, WEB_ENGAGE, WECHAT, INSTORE, MARTJACK, TMALL, |
{
"data": {
"eventName": "customerUpdated",
"data": {
"loyaltyType": "IPIMVCSE",
"source": "FVMC",
"accountId": "XHMCBHK",
"firstName": "CROGZH",
"lastName": "XDZUDFIK",
"enteredAt": 8519,
"enteredBy": {
"user": {
"username": "NEBCGT"
},
"id": 3302,
"till": {
"code": "QGPMVJF",
"name": "SSFQL"
},
"store": {
"code": "VNYYC",
"name": "VVOWKI",
"externalId": "KTW",
"externalId1": "RUS",
"externalId2": "XCRLP"
}
},
"updatedFields": [
{
"fieldName": "UCBKNQZ",
"previousValue": "EPOVY",
"currentValue": "JPCM",
"source": "CMXXMFXTEG",
"accountId": "YZVUEBN",
"fieldType": "StandardField"
}
],
"customerStatus": {
"previousStatus": "DGXG",
"previousLabel": "SJRI",
"currentStatus": "UTYFFKYB",
"currentLabel": "AXHPKA",
"reason": "BFZZLI"
},
"triggeringActivity": {
"name": "CMO",
"requestId": "JYKMCXFCX"
},
"customerIdentifiers": {
"customerId": 9235,
"firstName": "PVFQYAP",
"lastName": "ZJNCBRHFI",
"loyaltyType": "NZHNO",
"instore": {
"id": 9823,
"mobile": "MGYFW",
"email": "RTWQP",
"externalId": "NPD",
"cardnumber": "VVANZ",
"cardexternalid": "IWYJO",
"cardNumbers": [
"NLLLWYZ"
]
},
"facebook": {
"accounts": [
{
"accountId": "GRNVKKRKG",
"identifiers": [
{
"identifierType": "CLJJTOKIE",
"identifierValue": "GLYPPQXW"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "XVCDUMKA",
"identifiers": [
{
"identifierType": "QIVENX",
"identifierValue": "PJGZSWPMM"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "TWRH",
"identifiers": [
{
"identifierType": "QUEU",
"identifierValue": "MUJDXKCWCW"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "OVPMWJWUN",
"identifiers": [
{
"identifierType": "WDRPKAQRND",
"identifierValue": "DIKUY"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "XQUO",
"identifiers": [
{
"identifierType": "GIZD",
"identifierValue": "VFDTKVOE"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "MIVKKQ",
"identifiers": [
{
"identifierType": "WIZ",
"identifierValue": "SWWZZCUIL"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "DSKDMXU",
"identifiers": [
{
"identifierType": "IEUDXI",
"identifierValue": "YPUM"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "JVCS",
"identifiers": [
{
"identifierType": "ULAGXLJI",
"identifierValue": "ABLFEUVI"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "EZQ",
"identifiers": [
{
"identifierType": "ANPPKJDFYR",
"identifierValue": "PKWIB"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "QCQNIUW",
"identifiers": [
{
"identifierType": "KDMXDXM",
"identifierValue": "XKMDQIEZEH"
}
]
}
]
}
},
"customFields": [
{
"key": "DRQ",
"value": "HKH"
}
],
"extendedFields": [
{
"key": "CZPZ",
"value": "HPXCM"
}
]
},
"eventId": "KZQAVD",
"orgId": 3399,
"refId": "NJVVFHCX",
"apiRequestId": "STYWAYRW",
"createdAt": 1855,
"loyaltyEventId": "YUTMAGMJ",
"traceAttributes": {
"XJE": "VFD",
"OBW": "CDL",
"JXICJ": "XPQXTC",
"FGQKKGRAR": "TFDIZESZGO",
"POEHQFGLHD": "ETVQOOZFPZ"
}
},
"errors": null,
"warnings": null
}
Customer Subscription Event (customerSubscription)
Notifies when a user's subscription status changes for transactional or promotional messages.
{
"eventName": "customerSubscription",
"data": {
"customerIdentifiers": {
"customerId": 3035,
"firstName": "BTFVIQUN",
"lastName": "SOGQBY",
"loyaltyType": "RBPLQJBFL",
"instore": {
"id": 6642,
"mobile": "ZHTTROEFB",
"email": "DKGOLFALR",
"externalId": "QMLY",
"cardnumber": "GFEDIL",
"cardexternalid": "EUMPR",
"cardNumbers": [
"LMLJ"
]
},
"facebook": {
"accounts": [
{
"accountId": "EHMQPCFWAT",
"identifiers": [
{
"identifierType": "CWHTH",
"identifierValue": "RUVDFD"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "HER",
"identifiers": [
{
"identifierType": "BPRE",
"identifierValue": "TJLOFS"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "XFGDQP",
"identifiers": [
{
"identifierType": "JXLHKMZOT",
"identifierValue": "MACJWFUX"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "IKN",
"identifiers": [
{
"identifierType": "LBGONQFJSJ",
"identifierValue": "LQQZ"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "XPRHVOZJU",
"identifiers": [
{
"identifierType": "OTUTY",
"identifierValue": "ITT"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "TIJCMFLJN",
"identifiers": [
{
"identifierType": "YAXUTNID",
"identifierValue": "SADCL"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "PPJRM",
"identifiers": [
{
"identifierType": "DFIGGVIIQH",
"identifierValue": "HYLWJUOCEW"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "OFWX",
"identifiers": [
{
"identifierType": "KRQGML",
"identifierValue": "JOC"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "FJQGVP",
"identifiers": [
{
"identifierType": "YDUFXFGN",
"identifierValue": "HPC"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "KOP",
"identifiers": [
{
"identifierType": "EQSTIP",
"identifierValue": "DEDR"
}
]
}
]
}
},
"subscriptions": [
{
"sourceAccountId": "TIYFBQ",
"previousStatus": "MDDNR",
"currentStatus": "SQXZFX",
"channel": "XOLEFY",
"sourceName": "BXCUZZ",
"priority": "OOLRA",
"ouId": 5905,
"ouCode": "QFFGPEDKTK"
}
]
},
"eventId": "EDEL",
"orgId": 9907,
"refId": "AKOZZ",
"apiRequestId": "ACILCI",
"createdAt": 4214,
"loyaltyEventId": "FCW",
"traceAttributes": {
"TBJRARWC": "IEWKJRV",
"YYRUWM": "XBSC",
"JWYDT": "CYFW",
"TWNX": "UHJIPUJ",
"SHWKVIMKQ": "EWO",
"JQDQMWSEP": "HSNOC"
}
}
Group
The below event notifications are applicable for family and friends groups. For user group, use the other events.
Group Created Event (groupCreated)
Notifies when a group has been created. Applicable for family & friends group.
{
"eventName": "groupCreated",
"data": {
"groupId": 6454,
"groupName": "TEIVJVUXCD",
"primaryMember": {
"firstName": "IPN",
"lastName": "NSVYZ",
"role": "ARL",
"customerIdentifiers": {
"customerId": 6386,
"firstName": "QECMNT",
"lastName": "AWFW",
"loyaltyType": "IBZ",
"instore": {
"id": 5275,
"mobile": "AZOFWOKVNS",
"email": "FWEIJBQO",
"externalId": "QOIN",
"cardnumber": "XJMBDBLMK",
"cardexternalid": "DTLZYF",
"cardNumbers": [
"KFSUUM"
]
},
"facebook": {
"accounts": [
{
"accountId": "FVYERZD",
"identifiers": [
{}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "YXZS",
"identifiers": [
{}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "RWDDQM",
"identifiers": [
{}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "JJNGQIK",
"identifiers": [
{}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "QCO",
"identifiers": [
{}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "FPPAZ",
"identifiers": [
{}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "FNMWWC",
"identifiers": [
{}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "HMFKARRKJ",
"identifiers": [
{}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "KMEIOBBREK",
"identifiers": [
{}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "CZQSEGODEF",
"identifiers": [
{}
]
}
]
}
}
},
"enteredAt": 8034,
"enteredBy": {
"user": {
"username": "QBICVZ"
},
"id": 1936,
"till": {
"code": "SELKEVQJQ",
"name": "QRMYMIOXD"
},
"store": {
"code": "NHLLVNT",
"name": "YSUP",
"externalId": "WGKIFKEDLQ",
"externalId1": "KMWFAW",
"externalId2": "FGWMFPFFK"
}
}
},
"eventId": "YZHXQUJIBQ",
"orgId": 2975,
"refId": "EUGDEXSXMZ",
"apiRequestId": "KDKA",
"createdAt": 5053,
"loyaltyEventId": "XFCKEGMOT",
"traceAttributes": {
"UODI": "TSYZEWFYIC",
"XAPFDNH": "QPXJNITT",
"QINZJNUJA": "XGIZAXNDQH"
}
}
Group Updated Event (groupUpdated)
Notifies when a group has been updated. Applicable for family & friends group.
{
"eventName": "groupUpdated",
"data": {
"groupId": 6155,
"groupName": "FUEFW",
"primaryMember": {
"firstName": "IFNOWNRA",
"lastName": "WPIZZOD",
"role": "BWPA",
"customerIdentifiers": {
"customerId": 3900,
"firstName": "LJPJXTIMJ",
"lastName": "WNPNFJMC",
"loyaltyType": "VEPTDQ",
"instore": {
"id": 6797,
"mobile": "TCOBX",
"email": "MSLEFNK",
"externalId": "EDJO",
"cardnumber": "TMRGHP",
"cardexternalid": "ROLLUYB",
"cardNumbers": [
"KPHNYWUC"
]
},
"facebook": {
"accounts": [
{
"accountId": "VQRPQ",
"identifiers": [
{}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "ACFDAVSVMU",
"identifiers": [
{}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "LNWKPJL",
"identifiers": [
{}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "DRZ",
"identifiers": [
{}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "GVBLZBUHJ",
"identifiers": [
{}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "RJNHE",
"identifiers": [
{}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "QQHHBNQUL",
"identifiers": [
{}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "JAYKWH",
"identifiers": [
{}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "WKIUPSKAQ",
"identifiers": [
{}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "ANO",
"identifiers": [
{}
]
}
]
}
}
},
"enteredAt": 635,
"enteredBy": {
"user": {
"username": "RYLTNTEQCC"
},
"id": 7017,
"till": {
"code": "TGDLK",
"name": "DVEEEBG"
},
"store": {
"code": "IJSXMEMFYH",
"name": "WSDHTBHBVN",
"externalId": "TBVJRW",
"externalId1": "AMXQAAEDC",
"externalId2": "HZOWPEUGE"
}
}
},
"eventId": "VWPECGJC",
"orgId": 5635,
"refId": "SHLDGAJCRL",
"apiRequestId": "KOKNJM",
"createdAt": 3039,
"loyaltyEventId": "UETYIKX",
"traceAttributes": {
"ATUN": "NKPUVYSD",
"QVMUTCMH": "MSGVXGF",
"DPMSGQ": "RCLEURMTOC",
"JIKG": "CHTOAA",
"EIS": "QFBLKTBB"
}
}
Group Member Removed Event (groupMemberRemoved)
Notifies when a member is removed from the group. Applicable for family & friends group.
{
"eventName": "groupMemberRemoved",
"data": {
"groupId": 6815,
"groupName": "XFU",
"primaryMember": {
"firstName": "JFFYAPX",
"lastName": "EYPQYDAM",
"role": "NECB",
"customerIdentifiers": {
"customerId": 1757,
"firstName": "WCZY",
"lastName": "WZM",
"loyaltyType": "BYCMESBJO",
"instore": {
"id": 4820,
"mobile": "QFLAIVBPOF",
"email": "SGSHI",
"externalId": "OJAUIX",
"cardnumber": "FBVKZMMCWH",
"cardexternalid": "KBMXA",
"cardNumbers": [
"JHPMGKDIF"
]
},
"facebook": {
"accounts": [
{
"accountId": "XOBBTVOP",
"identifiers": [
{}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "HUWGP",
"identifiers": [
{}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "MHXETUZ",
"identifiers": [
{}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "MKW",
"identifiers": [
{}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "OSRJKWR",
"identifiers": [
{}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "YHBBSXR",
"identifiers": [
{}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "MBGGPJQ",
"identifiers": [
{}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "SIL",
"identifiers": [
{}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "YVSMTR",
"identifiers": [
{}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "ESTVMSHGIP",
"identifiers": [
{}
]
}
]
}
}
},
"memberRemoved": {
"firstName": "JUYJ",
"lastName": "YEW",
"role": "ZQBBTQVFS",
"customerIdentifiers": {
"customerId": 564,
"firstName": "COIIUVCDMR",
"lastName": "DXGFR",
"loyaltyType": "QDXULGXJ",
"instore": {
"id": 9506,
"mobile": "AGIV",
"email": "XAHP",
"externalId": "CINEHRP",
"cardnumber": "CFWBFLLDC",
"cardexternalid": "EYYPR",
"cardNumbers": [
"JJYKSZZFQW"
]
},
"facebook": {
"accounts": [
{
"accountId": "JUYMTCYIBO",
"identifiers": [
{}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "BXZDXE",
"identifiers": [
{}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "UCHTLL",
"identifiers": [
{}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "IEGJ",
"identifiers": [
{}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "HXVTRWJUJM",
"identifiers": [
{}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "FLB",
"identifiers": [
{}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "OMGB",
"identifiers": [
{}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "JCWVA",
"identifiers": [
{}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "TKS",
"identifiers": [
{}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "QLM",
"identifiers": [
{}
]
}
]
}
}
},
"enteredAt": 6893,
"enteredBy": {
"user": {
"username": "ETP"
},
"id": 9792,
"till": {
"code": "TBMFUSQH",
"name": "XIN"
},
"store": {
"code": "OEQ",
"name": "RCFBZV",
"externalId": "LZZOZ",
"externalId1": "WINYWG",
"externalId2": "AROPHIPG"
}
}
},
"eventId": "XJJVON",
"orgId": 6700,
"refId": "HKA",
"apiRequestId": "DEPY",
"createdAt": 543,
"loyaltyEventId": "MFVKRCLH",
"traceAttributes": {
"WFP": "THUQOWPZ",
"TIFXANF": "YBOHTO",
"MZGVLUZYW": "OJHW",
"RPSEKXCVM": "ECMTTSEVND"
}
}
Group Member Added Event (groupMemberAdded)
Notifies when a user is added to the group. Applicable for family & friends group.
{
"eventName": "groupMemberAdded",
"data": {
"groupId": 5322,
"groupName": "CDNO",
"primaryMember": {
"firstName": "OWAXN",
"lastName": "QFYKVMFT",
"role": "EXWCSHZCE",
"customerIdentifiers": {
"customerId": 7098,
"firstName": "PYBWGRLSL",
"lastName": "EYMPRNY",
"loyaltyType": "EYGPRF",
"instore": {
"id": 5240,
"mobile": "DTGWKBQ",
"email": "XEWHI",
"externalId": "WQMNTLMZH",
"cardnumber": "GFHGXTR",
"cardexternalid": "PFZXJLOU",
"cardNumbers": [
"HJWLN"
]
},
"facebook": {
"accounts": [
{
"accountId": "IJRPPXDA",
"identifiers": [
{}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "NPNLNJU",
"identifiers": [
{}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "HXZPIXO",
"identifiers": [
{}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "AIXMYREODW",
"identifiers": [
{}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "VGWSDAD",
"identifiers": [
{}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "QQVZVH",
"identifiers": [
{}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "OCMVNLMM",
"identifiers": [
{}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "QAIEXCUPGH",
"identifiers": [
{}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "LUYARPJ",
"identifiers": [
{}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "BNSQ",
"identifiers": [
{}
]
}
]
}
}
},
"memberAdded": {
"firstName": "DUJEI",
"lastName": "LGH",
"role": "PIXKILY",
"customerIdentifiers": {
"customerId": 3970,
"firstName": "BHNN",
"lastName": "RDDGQ",
"loyaltyType": "FFSVYCB",
"instore": {
"id": 7905,
"mobile": "SEWFB",
"email": "LQIMZ",
"externalId": "ZTUJYZMQY",
"cardnumber": "YDJIRDP",
"cardexternalid": "VQRUYH",
"cardNumbers": [
"SUTYQB"
]
},
"facebook": {
"accounts": [
{
"accountId": "MJWLMIU",
"identifiers": [
{}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "BYQ",
"identifiers": [
{}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "MUOPUHVG",
"identifiers": [
{}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "HZE",
"identifiers": [
{}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "RWMN",
"identifiers": [
{}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "QQOIHQI",
"identifiers": [
{}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "XOKFREZV",
"identifiers": [
{}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "TQSSADLNBA",
"identifiers": [
{}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "WFFZSBFWR",
"identifiers": [
{}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "WYV",
"identifiers": [
{}
]
}
]
}
}
},
"enteredAt": 1426,
"enteredBy": {
"user": {
"username": "MPQSJA"
},
"id": 939,
"till": {
"code": "DSYQOXAV",
"name": "AFYDJJKRYC"
},
"store": {
"code": "GKYXKEZF",
"name": "JBKKM",
"externalId": "SRAU",
"externalId1": "XOAKCQX",
"externalId2": "QME"
}
}
},
"eventId": "RHPEYLIWUE",
"orgId": 6485,
"refId": "KFLUYT",
"apiRequestId": "ZHLGTI",
"createdAt": 9743,
"loyaltyEventId": "CWJWPBBF",
"traceAttributes": {
"JWE": "RHC",
"TRRA": "DTQNZ",
"NDKD": "RLXXDMAHL",
"DICJW": "CUSFWKB",
"LDJSKSIDO": "HAOW",
"OQKQ": "BFHHQBEUHC"
}
}
Points Contribution to Group Event (pointsContributionToGroup)
Notifies when points are contributed to the loyalty group. Applicable for family & friends group.
{
"eventName": "pointsContributionToGroup",
"data": {
"groupId": 2146,
"groupName": "RRMB",
"primaryMember": {
"firstName": "AVQ",
"lastName": "VQZZJL",
"role": "QBZZKNJAXV",
"customerIdentifiers": {
"customerId": 2828,
"firstName": "DVSKCOT",
"lastName": "HCBTOXKHQ",
"loyaltyType": "WIXGDVJST",
"instore": {
"id": 5646,
"mobile": "KMLCG",
"email": "OSONXRDAD",
"externalId": "LBJURY",
"cardnumber": "DTEVR",
"cardexternalid": "UZHJ",
"cardNumbers": [
"DPAID"
]
},
"facebook": {
"accounts": [
{
"accountId": "FXRBKNKWC",
"identifiers": [
{}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "XAVGDRVRL",
"identifiers": [
{}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "PGXPKRE",
"identifiers": [
{}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "DRDX",
"identifiers": [
{}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "QSUJ",
"identifiers": [
{}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "HZPT",
"identifiers": [
{}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "EXMG",
"identifiers": [
{}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "TWYD",
"identifiers": [
{}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "TAYEGETJO",
"identifiers": [
{}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "YZOT",
"identifiers": [
{}
]
}
]
}
}
},
"contributingMember": {
"firstName": "QPJ",
"lastName": "SVCC",
"role": "KDSM",
"customerIdentifiers": {
"customerId": 6560,
"firstName": "IATIBBX",
"lastName": "IVRCV",
"loyaltyType": "JLZFVAQR",
"instore": {
"id": 8417,
"mobile": "JNQ",
"email": "BMXXM",
"externalId": "NLCQRNBB",
"cardnumber": "WBEBQR",
"cardexternalid": "PXOVHLLQR",
"cardNumbers": [
"IERNF"
]
},
"facebook": {
"accounts": [
{
"accountId": "AAABR",
"identifiers": [
{}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "MDFUIIKPFO",
"identifiers": [
{}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "APTV",
"identifiers": [
{}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "CEKOFQIK",
"identifiers": [
{}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "PBXDZ",
"identifiers": [
{}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "AUIXZI",
"identifiers": [
{}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "PVTZOPUTY",
"identifiers": [
{}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "BUEGCQEW",
"identifiers": [
{}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "REIRM",
"identifiers": [
{}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "MOEWWZNQM",
"identifiers": [
{}
]
}
]
}
}
},
"triggeringActivity": {
"name": "SKYAQOEDX",
"identifiers": [
{
"key": "EVRAA",
"value": "OZJUDQH"
}
],
"enteredBy": {
"id": 4493,
"till": {
"code": "KJXTSY",
"name": "QLSEATML"
},
"store": {
"code": "KKX",
"name": "DSMKXKSK",
"externalId": "IAUSMDZCFY",
"externalId1": "JOZJBJZ",
"externalId2": "WYHERZQSN"
}
},
"entityInformation": {
"entityType": "NBNCCMY",
"entityId": 4348
},
"additionalAttributes": [
{
"key": "XIQUZ",
"value": "JKFVMCWXUZ"
}
]
},
"loyaltyProgramDetails": {
"id": 6178,
"name": "XXYMNPPPF",
"isDefault": true,
"pointsToCurrencyRatio": 279.6401470769947,
"tiers": [
{
"tierNumber": 8793,
"tierName": "HFT"
}
]
},
"loyaltyProgramId": 3583,
"pointsContributedToGroup": 446.36640823491007
},
"eventId": "VTP",
"orgId": 5150,
"refId": "QRPNKMVSN",
"apiRequestId": "DYUXNRF",
"createdAt": 1845,
"loyaltyEventId": "JBKIS",
"traceAttributes": {
"INZTJTF": "AMTYVL",
"CXBYWD": "ZNQ",
"SPQUS": "QEGKQSFPT",
"ONLFEQEX": "PQDODJ",
"PXYUL": "ZVZXMGQRLT"
}
}
Transaction
Transaction Added Event (transactionAdded)
Notifies when a transaction is added. For example, a transaction is made by a user.
Parameter | Datatype | Description |
---|---|---|
amount | Double | Net transaction amount. |
billClientId | String | Unique id of the bill as per the client (org) end. |
billNumber | String | Unique transaction number. The uniqueness depends on the configuration. |
enteredAt | ||
enteredBy | obj | Details of the store at which the transaction happened. |
transactionId | long | Unique transaction ID generated internally. |
deliveryStatus | Enum | Delivery status of the order. Value: PLACED, PROCESSED, SHIPPED, DELIVERED, RETURNED. |
billType | Enum | Type of transaction. Supported value: regular for loyalty transactions. ‘RETURN’ for return transactions. |
lineItemCount | Integer | Number of line-items in the transaction. |
Discount | Double | Discount availed for the transaction (discount amount). |
grossAmount | Double | Transaction amount before discount. |
currencyCode | String | ISO currency code that you want to update. For example EUR for Euro, SGD for the Singapore Dollar, CNY for China Yuan Renminbi, SAR Saudi Riyal. For more codes, see ISO currency codes. |
{
"eventId": "7a2716a8-9cc7-4beb-999a-a8f02ad9f02d",
"eventType": "transactionAdded",
"consumerGroupId": null,
"actionType": "STA RT",
"timeStamp": 1683874800103,
"attributes": {
"createdAt": 1683874800089,
"data": {
"amount": 89000.0,
"billNumber": "2_134577_12591538_487122",
"enteredAt": 1683880160000,
"transactionId": 65658570,
"billType": "REGULAR",
"lineItemCount": 1,
"discount": 0.0,
"currencyCode": "IDR",
"enteredBy": {
"id": 200280487,
"till": {
"code": "prod.shell.id.12591538.1",
"name ": "prod.shell.id.12591538.1"
},
"store": {
"code": "prod.shell.id.12591538",
"name": "SHELL JABABEKA-1 BKS",
"externalId": "12591538",
"externalId1": "",
"externalId2": ""
}
},
"customerIdentifiers": {
"customerId": 3122204,
"loyaltyType": "loyalty",
"instore": {
"mobile": "6285692704128"
},
"web_engage": {
"accounts": [
{
"accountId": "~1341059d8",
"identifiers ": [
{
"identifierType": "cuid",
"identifierValue": "6285692704128"
},
{
"identifierType": "mobile",
"identifierValue": "6285692704128"
}
]
}
]
}
}
},
"eventName": "transactionAdded",
"refId": "151195_65658570",
"apiRequestId": "e0c09ab511e9f942526944012967b5c4",
"orgId": 151195
}
}
Transaction Updated Event (transactionUpdated)
Notifies when a transaction is updated. For example, a change to a line-item in a transaction.
Parameter | Datatype | Description |
---|---|---|
amount | Double | Net transaction amount. |
billClientId | String | Unique id of the bill as per the client (org) end. |
billNumber | String | Unique transaction number. The uniqueness depends on the configuration. |
enteredAt | Long | Date and time when the transaction was entered in Epoch time format. |
enteredBy | obj | Details of the store at which the transaction happened. |
transactionId | long | Unique transaction ID generated internally. |
deliveryStatus | Enum | Delivery status of the order. Value: PLACED, PROCESSED, SHIPPED, DELIVERED, RETURNED. Delivery status of the order. Value: PLACED, PROCESSED, SHIPPED, DELIVERED, RETURNED. |
billType | Enum | Type of transaction. Supported value: regular for loyalty transactions. ‘RETURN’ for return transactions. |
lineItemCount | Integer | Number of line-items in the transaction. |
Discount | Double | Discount availed for the transaction (discount amount). |
grossAmount | Double | Transaction amount before discount. |
currencyCode | String | ISO currency code that you want to update. For example EUR for Euro, SGD for Singapore Dollar, CNY for China Yuan Renminbi, SAR Saudi Riyal. For more codes, see ISO currency codes. |
{
"eventId": "b9383037-89ce-43a9-9db1-99c5ac96e2b9",
"eventType": "transactionUpdated",
"consumerGroupId": null,
"actionType": "START",
"timeStamp": 1683874807284,
"attributes": {
"createdAt": 1683874807271,
"data": {
"amount": 50.0,
"enteredAt": 1683883802000,
"transactionId": 65658586,
"deliveryStatus": "DELIVERED",
"billType": "REGULAR",
"discount": 0.0,
"grossAmount": 0.0,
"enteredBy": {
"id": 200315709
},
"customerIdentifiers": {
"customerId": 6675787,
"instore": {
"mobile": "609110544825 ",
"externalId": "6018840184080212"
}
}
},
"eventName": "transactionUpdated",
"refId": "151229_65658586",
"apiRequestId": "0cb47446178e9fa4d66b985087a0f6f5",
"orgId": 151229
}
}
Not-Interested Bill Added Event (notInterestedBillAdded)
Notifies when a non-loyalty transaction is made by a user. A non-loyalty or not-interested transaction refers to a purchase made by a user who is not interested in registering for the organisation's loyalty program.
{
"eventName": "notInterestedBillAdded",
"data": {
"amount": 9511.0960402456,
"billClientId": "MZIMAB",
"billNumber": "RGSMQ",
"billDate": 1503,
"enteredAt": 1733,
"transactionId": 7378,
"deliveryStatus": "DDRNZJM",
"billType": "ZNGPNUHI",
"lineItemCount": 6252,
"discount": 5424.653652820183,
"grossAmount": 1025.554923312577,
"currencyCode": "BYULP",
"enteredBy": {
"user": {
"username": "MFTQNKS"
},
"id": 7668,
"till": {
"code": "PNJVSZF",
"name": "LWXKSK"
},
"store": {
"code": "EHO",
"name": "CWZJGRRFBP",
"externalId": "ULALNJPS",
"externalId1": "MYMCSLEBN",
"externalId2": "GZD"
}
},
"customerIdentifiers": {
"customerId": 9191,
"firstName": "AMXUQD",
"lastName": "FIIG",
"loyaltyType": "SZGSV",
"instore": {
"id": 6296,
"mobile": "MPERH",
"email": "NRDTCIPXRF",
"externalId": "AYCRFBIYDP",
"cardnumber": "XKWWFAHKYS",
"cardexternalid": "DIVQ",
"cardNumbers": [
"KDGWBPMNVI"
]
},
"facebook": {
"accounts": [
{
"accountId": "ROL",
"identifiers": [
{
"identifierType": "RDCDIG",
"identifierValue": "RYCSJLLF"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "GNNBOIEH",
"identifiers": [
{
"identifierType": "CNOBXSKXF",
"identifierValue": "FSSJ"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "RATNLSNXZB",
"identifiers": [
{
"identifierType": "HUNGZBIXGC",
"identifierValue": "CYXGXRN"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "WNTBGCPZ",
"identifiers": [
{
"identifierType": "GJPHRFZD",
"identifierValue": "SYPRX"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "PENK",
"identifiers": [
{
"identifierType": "ZFBXIOIP",
"identifierValue": "ZDVGEVGM"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "KFRNVWJ",
"identifiers": [
{
"identifierType": "GWPCHK",
"identifierValue": "LEZVBXPS"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "ZBCPPDNCEE",
"identifiers": [
{
"identifierType": "SXQSLUJKR",
"identifierValue": "SOR"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "VVWU",
"identifiers": [
{
"identifierType": "ZQAQDU",
"identifierValue": "YZKB"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "TRTEMZ",
"identifiers": [
{
"identifierType": "KSAMFDO",
"identifierValue": "GBNYYKLN"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "UOULQ",
"identifiers": [
{
"identifierType": "MYVZHLDPZ",
"identifierValue": "CMJ"
}
]
}
]
}
},
"customFields": [
{
"key": "DRSOD",
"value": "FLBMAO"
}
],
"extendedFields": [
{
"key": "ZLPRWB",
"value": "CCLW"
}
],
"outlierStatus": "ULQMAHABTM"
},
"eventId": "ZLPVW",
"orgId": 6590,
"refId": "FJGZUWELJ",
"apiRequestId": "BSIYSAGPO",
"createdAt": 8426,
"loyaltyEventId": "HAHCUOJ",
"traceAttributes": {
"NNILCE": "AGLNT",
"TNHIFECFF": "ANPQHIP",
"YLKNQYS": "RJDV",
"TVFIRAJBS": "QGKKN"
}
}
Transaction Rejected Event (transactionRejected)
Notifies when a transaction is rejected.
{
"eventName": "transactionRejected",
"data": {
"customerIdentifiers": {
"customerId": 90,
"firstName": "CNNQGEZ",
"lastName": "PQXW",
"loyaltyType": "DOZ",
"instore": {
"id": 6608,
"mobile": "NSLUWGF",
"email": "XDQVVRLT",
"externalId": "EDGPJIAPSF",
"cardnumber": "HAQT",
"cardexternalid": "CLPASCFKA",
"cardNumbers": [
"FKTW"
]
},
"facebook": {
"accounts": [
{
"accountId": "ASG",
"identifiers": [
{
"identifierType": "AGOAZGL",
"identifierValue": "BWVUMDU"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "WRI",
"identifiers": [
{
"identifierType": "NAUUKTJPZ",
"identifierValue": "HCBSJFBDW"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "ZOLP",
"identifiers": [
{
"identifierType": "DANAXFPLF",
"identifierValue": "DJEFIEZOR"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "SYZVLWQGN",
"identifiers": [
{
"identifierType": "BHV",
"identifierValue": "YNYYUJXJPR"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "DJXP",
"identifiers": [
{
"identifierType": "PMZMJ",
"identifierValue": "XVKZRWJ"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "AQJD",
"identifiers": [
{
"identifierType": "UNKMR",
"identifierValue": "MJZG"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "TZGP",
"identifiers": [
{
"identifierType": "YZJHL",
"identifierValue": "ZYHCUKZZ"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "BXTYHDI",
"identifiers": [
{
"identifierType": "BPZG",
"identifierValue": "ATPZ"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "EXZRURCY",
"identifiers": [
{
"identifierType": "BYXFCPAEK",
"identifierValue": "CKDMTRUBB"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "NJD",
"identifiers": [
{
"identifierType": "ARGJJYWN",
"identifierValue": "NDORVKDJAH"
}
]
}
]
}
},
"eventDateTime": "JHSIB",
"billNumber": "BWMIWH",
"rejectionType": "NFJ",
"rejectionDetails": [
{
"rejectionReason": "QITIFBIBDJ",
"reasonDetails": "TDZISVBS"
}
],
"retrialCount": 6284,
"triggeringActivity": {
"name": "UTTUZSBS",
"identifiers": [
{
"key": "QNAWENU",
"value": "FRGOFCKKSK"
}
],
"enteredBy": {
"id": 2471,
"till": {
"code": "XLBTXXATJ",
"name": "KWVYCIVWBO"
},
"store": {
"code": "FYEOUL",
"name": "PAYDQ",
"externalId": "QFDJV",
"externalId1": "VYUZFCOD",
"externalId2": "ZLYY"
}
},
"entityInformation": {
"entityType": "WWUWWPR",
"entityId": 1238
},
"additionalAttributes": [
{
"key": "CIRLEOO",
"value": "ORDUGBVU"
}
]
}
},
"eventId": "OALOT",
"orgId": 8078,
"refId": "NOE",
"apiRequestId": "DZAMIMDS",
"createdAt": 7772,
"loyaltyEventId": "NGCGBPTBI",
"traceAttributes": {
"FANKP": "ANY",
"CQMWGE": "HCGZ",
"IBVHSDVRND": "JAN",
"GSQD": "ONSGR"
}
}
Rejected Transaction Retrigger Event (rejectedTransactionRetrigger)
Notifies when a rejected transaction is attempted again.
{
"eventName": "rejectedTransactionRetrigger",
"data": {
"customerIdentifiers": {
"customerId": 9595,
"firstName": "QEJGUGHY",
"lastName": "THVC",
"loyaltyType": "APQIUHE",
"instore": {
"id": 2835,
"mobile": "FTUIGLWD",
"email": "ANIPX",
"externalId": "DFGJB",
"cardnumber": "EFQPZYZF",
"cardexternalid": "UAYUK",
"cardNumbers": [
"OYWBJEWGIU"
]
},
"facebook": {
"accounts": [
{
"accountId": "OSNN",
"identifiers": [
{
"identifierType": "BAOL",
"identifierValue": "MNOZBSFPAC"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "ZQFRLUM",
"identifiers": [
{
"identifierType": "RKGAZJT",
"identifierValue": "TRPZ"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "UKUDHYD",
"identifiers": [
{
"identifierType": "STWXLN",
"identifierValue": "CGOCCBPS"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "RYHBEYKGQ",
"identifiers": [
{
"identifierType": "DQDNYUIBL",
"identifierValue": "DWQJRYQPR"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "BRAVYC",
"identifiers": [
{
"identifierType": "QWHIIXCVF",
"identifierValue": "PSPDV"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "EECAGMAD",
"identifiers": [
{
"identifierType": "TFC",
"identifierValue": "CFBSQNBQRD"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "VQZONUJIB",
"identifiers": [
{
"identifierType": "CYBUXMOF",
"identifierValue": "XBICTDHNA"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "GJW",
"identifiers": [
{
"identifierType": "OWFXY",
"identifierValue": "GAEEN"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "ALHXBZQSTS",
"identifiers": [
{
"identifierType": "DTVPMET",
"identifierValue": "AXJYVR"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "JPIEAWV",
"identifiers": [
{
"identifierType": "WTPCZHBMJ",
"identifierValue": "JNZ"
}
]
}
]
}
},
"eventDateTime": "TIDHRBDOF",
"billNumber": "JAMKHUFNOP",
"rejectionType": "KNXUYAA",
"rejectionDetailsOnRetrigger": [
{
"rejectionReason": "OBIL",
"reasonDetails": "LMQEYFF"
}
],
"retrialCount": 866,
"triggeringActivity": {
"name": "HQTLAVU",
"identifiers": [
{
"key": "JMHN",
"value": "WNZQEUF"
}
],
"enteredBy": {
"id": 8342,
"till": {
"code": "RJLOI",
"name": "OBZAWOQDN"
},
"store": {
"code": "QIWLI",
"name": "AJMYRS",
"externalId": "VLNLOOWLL",
"externalId1": "PMZDHIY",
"externalId2": "HRI"
}
},
"entityInformation": {
"entityType": "PYSJUYUXDN",
"entityId": 7530
},
"additionalAttributes": [
{
"key": "DCI",
"value": "KDYCNBUFPZ"
}
]
},
"retriggerId": 7372
},
"eventId": "PVBYY",
"orgId": 798,
"refId": "XLA",
"apiRequestId": "JQAN",
"createdAt": 6409,
"loyaltyEventId": "QWKWI",
"traceAttributes": {
"HNEHCDMBFQ": "AXCKBG",
"VSEV": "RCO",
"SDQLIPN": "IGYVFCJIPN"
}
}
Retro Bill Added Event (retroBillAdded)
Notifies when an older transaction is added against the user.
{
"eventName": "retroBillAdded",
"data": {
"amount": 246.66453103260665,
"billClientId": "EFJNGO",
"billNumber": "XADYJHTNZ",
"billDate": 1157,
"enteredAt": 3765,
"transactionId": 5650,
"deliveryStatus": "BLQMATBU",
"billType": "GMV",
"lineItemCount": 8791,
"discount": 8154.318560422623,
"grossAmount": 8109.952753195439,
"currencyCode": "YBND",
"enteredBy": {
"user": {
"username": "PDBLNVJOMJ"
},
"id": 8822,
"till": {
"code": "PYSIVN",
"name": "XLSCOHGLQX"
},
"store": {
"code": "PSHIA",
"name": "GBJIQ",
"externalId": "IPHXYWR",
"externalId1": "YXAV",
"externalId2": "GVYYMAF"
}
},
"customerIdentifiers": {
"customerId": 7264,
"firstName": "PVKZNFPPTL",
"lastName": "TCJHTJY",
"loyaltyType": "ZBLKXAQ",
"instore": {
"id": 2582,
"mobile": "ROFWZ",
"email": "VTPP",
"externalId": "USDYHBYUG",
"cardnumber": "IVWBJFA",
"cardexternalid": "TVQVR",
"cardNumbers": [
"VATLAPHTK"
]
},
"facebook": {
"accounts": [
{
"accountId": "MHHRRNJ",
"identifiers": [
{
"identifierType": "TWFDWZGJ",
"identifierValue": "QCXFAKBG"
}
]
}
]
},
"web_engage": {
"accounts": [
{
"accountId": "KNJBNFL",
"identifiers": [
{
"identifierType": "PUNLANYWWF",
"identifierValue": "JDCP"
}
]
}
]
},
"wechat": {
"accounts": [
{
"accountId": "ZEHSPZISU",
"identifiers": [
{
"identifierType": "GQBXBW",
"identifierValue": "WBWEEGISH"
}
]
}
]
},
"martjack": {
"accounts": [
{
"accountId": "CXTIKNECEZ",
"identifiers": [
{
"identifierType": "SUTZDRYYTL",
"identifierValue": "QMTIN"
}
]
}
]
},
"tmall": {
"accounts": [
{
"accountId": "WHWJ",
"identifiers": [
{
"identifierType": "DOUSHFNSI",
"identifierValue": "XEL"
}
]
}
]
},
"toabao": {
"accounts": [
{
"accountId": "IVHIFFM",
"identifiers": [
{
"identifierType": "VANKJHXR",
"identifierValue": "UIZRV"
}
]
}
]
},
"jd": {
"accounts": [
{
"accountId": "BSFKRKK",
"identifiers": [
{
"identifierType": "WMZPVYCLNS",
"identifierValue": "VOJ"
}
]
}
]
},
"ecommerce": {
"accounts": [
{
"accountId": "JUXCZQI",
"identifiers": [
{
"identifierType": "WJGCEWGRD",
"identifierValue": "UCMPSQ"
}
]
}
]
},
"website": {
"accounts": [
{
"accountId": "TMUQQK",
"identifiers": [
{
"identifierType": "ITMASKHY",
"identifierValue": "YGTPVBCNCW"
}
]
}
]
},
"line": {
"accounts": [
{
"accountId": "CYQNJXF",
"identifiers": [
{
"identifierType": "RKMW",
"identifierValue": "AFXL"
}
]
}
]
}
},
"customFields": [
{
"key": "CURI",
"value": "BSSCEBNI"
}
],
"extendedFields": [
{
"key": "ZEEJJXW",
"value": "XSP"
}
],
"outlierStatus": "WJLRMBFI"
},
"eventId": "SZGDD",
"orgId": 708,
"refId": "GABCYPOGH",
"apiRequestId": "JSNJHDS",
"createdAt": 2888,
"loyaltyEventId": "PZNF",
"traceAttributes": {
"DEH": "HEPGWRPKG",
"SUUMEX": "YBNSTCBE",
"AXSIBTZFR": "DLYRHXGN"
}
}
Points
Points Issued Event (pointsIssued)
Notifies when points are issued to a user.
Parameter | 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., "50660_pointsIssued". |
consumerGroupId | Identifier for a consumer group (empty in this case). | |
actionType | String | Type of action, e.g., "START". |
timeStamp | Number | Timestamp of the event. |
attributes | Object | Additional attributes related to the event. |
- createdAt | Number | Timestamp when the event was created. |
- data | Object | Data related to the event. |
-- customerIdentifiers | Object | Identifiers related to the customer. |
--- customerId | Number | Unique identifier for the customer. |
-- entityInformation | Object | Information about the entity involved in the event. |
--- entityType | String | Type of entity, e.g., "USER". |
--- entityId | Number | Unique identifier for the entity. |
-- triggeringActivity | Object | Details about the activity that triggered the event. |
--- name | String | Name of the triggering activity. |
--- identifiers | Array | Identifiers related to the activity. |
---- key | String | Key identifier, e.g., "CustomerId". |
---- value | String | Value of the key identifier. |
--- enteredBy | Object | User who entered the activity. |
---- id | Number | Unique identifier for the user. |
--- additionalAttributes | Array | Additional attributes related to the activity. |
---- key | String | Key attribute, e.g., "customerId". |
---- value | String | Value of the key attribute. |
-- loyaltyProgramDetails | Object | Details about the loyalty program. |
--- id | Number | Unique identifier for the program. |
--- name | String | Name of the program. |
--- isDefault | Boolean | Indicates if it's the default program. |
--- pointsToCurrencyRatio | Number | Points-to-currency conversion ratio. |
--- tiers | Array | List of program tiers. |
---- tierNumber | Number | Tier number, e.g., 1. |
---- tierName | String | Tier name, e.g., "Silver". |
-- loyaltyProgramId | Number | Unique identifier for the loyalty program. |
-- programCurrentPoints | Number | Current points in the loyalty program. |
-- programLifetimePoints | Number | Lifetime points in the loyalty program. |
-- totalPointsIssued | Number | Total points issued in the event. |
-- regularPointsIssued | Number | Regular points issued in the event. |
-- regularPointsBreakup | Array | Breakdown of regular points issued (empty in this case). |
-- promotionalPointsIssued | Array | Promotional points issued in the event. |
--- promotionIdentifier | String | Identifier for the promotion. |
--- promotionType | String | Type of promotion, e.g., "CUSTOMER_PROMOTION". |
--- promotionPoints | Number | Points awarded for the promotion. |
--- promotionPointsExpiryDate | String | Expiry date of the promotion points. |
-- promisedPointsIssued | Array | Promised points issued in the event (empty in this case). |
-- behavioralEventAttributes* | Object | Attributes related to behavioral events. |
--- webhookId | String | Identifier for the webhook. |
--- event_flag | Number | Event flag. |
--- identifier_value | String | Identifier value, e.g., "unionId918821563441". |
--- requestId | String | Unique identifier for the request. |
--- event_name | String | Name of the event. |
--- startTime | Number | Start time of the event. |
loyaltyEventId | String | Identifier for the loyalty event. |
eventName | String | Name of the event, e.g., "pointsIssued". |
refId | String | This is a combination of org id and loyalty event ID and is used for internal debugging purposes. |
apiRequestId | String | Identifier for the API request. |
orgId | Number | Unique identifier for the organization. |
*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
{
"eventId": "a5557ce1-e364-4688-b7ed-f6e3324580b3",
"eventLogId": 34804692,
"eventType": "pointsIssued",
"consumerGroupId": null,
"actionType": "START",
" timeStamp": 1683874800263,
"attributes": {
"createdAt": 1683874800251,
"data": {
"customerIdentifiers": {
"customerId": 87884897,
"instore": {
"mobile": "84934720774"
}
},
"entityInformation": {
"entityType": "USER",
"entityId": 87884897
},
"triggeringActivity": {
"name": "TransactionAdd",
"identifiers": [
{
"key": "BillId",
"value": "330676226"
},
{
"key": "BillLineItemId",
"value": "983202640"
},
{
"key": "billNumber",
"value": "150956_1683874799412"
}
],
"enteredBy": {
"id": 200300301
},
"entityInformation": {
"entityType": "USER",
"entityId": 87884897
},
"additionalAttributes": [
]
},
"loyaltyProgramDetails": {
"id": 838,
"name": "Jotun VNDefaultProgram",
"isDefault": true,
"pointsToCurrencyRatio": 1.0,
"tiers": [
{
"tierNumber": 1,
"tierName": "New"
},
{
"tierNumber": 2,
"tierName": "Master Painter"
},
{
"tierNumber": 3,
"tierName": "VIP"
},
{
"tierNumber": 4,
"tierName": "Super VIP"
},
{
"tierNumber": 5,
"tierName": " Platinum"
}
]
},
"loyaltyProgramId": 838,
"programCurrentPoints": 165.0,
"programLifetimePoints": 665.0,
"totalPointsIssued": 60.0,
"regularPointsIssued": 60.0,
"regularPointsBreakup": [
{
"po ints": 60.0,
"expiryAt": "2024-05-31"
}
],
"promotionalPointsIssued": [
],
"promisedPointsIssued": [
]
},
"loyaltyEventId": "tJVGuVbhdB",
"eventName": "pointsIssued",
"refId": "150956_tJV GuVbhdB",
"apiRequestId": "2ba4294402c186d4eae95cb5b3c44dc7",
"orgId": 150956
}
}
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. |
- 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. |
--- 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 ": "amrinshekh157@gmail.com"
}
},
"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":"tom@email.com",
"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. |
- 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. |
--- 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": &q