Event schema (Payload)

This page provides the schema of transaction and customer events with sample data.

Customer

Customer Added Event

Request Parameters

ParameterDatatypeDescription
eventNameStringName of the event.
eventIdStringUsed 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.
orgIdIntegerCapillary organization ID
refIdStringReference ID for the internal debugging purpose.
customerIdIntegerUnique identifier for the customer.
mobileIntegerMobile number of the customer.
emailStringEmail ID of the customer.
externalIdStringExternal ID associated with the customer.
card_numberIntegerCard number associated with the customer.
apiRequestIdStringInternal request ID generated for the API request.
createdAtIntegerUnix 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": "[email protected]",
          "externalId": "226682932023"
        }
      }
    },
    "eventName": "customerAdded",
    "refId": "150698_164875382",
    "apiRequestId ": "0c52fc98594959bf0d577218bf565798",
    "orgId": 150698
  }
}

Customer Updated Event

The customer update event triggers notifications for updates to customer details like name, extended fields, custom fields, and customer status but not for subscription updates.

Request Parameters

ParameterDatatypeDescription
loyaltyTypeEnumType of customer loyalty - LOYALTY, NON_LOYALTY
sourceStringCapillary organization ID
emailStringEmail ID of the customer.
mobileStringMobile number of the customer.
card_numberIntegerCard number associated with the customer.
enteredAtIntegerUnix timestamp in milliseconds when the event was stored in Capillary.
enteredByStringSource from which customer details are updated.
Value: FACEBOOK, WEB_ENGAGE, WECHAT, INSTORE, MARTJACK, TMALL,
{
  "eventId": "ff8b1ea4-bc7d-477d-8296-da626e965bc8",
  "eventType": "customerUpdated",
  "consumerGroupId": null,
  "actionType": "STAR T",
  "timeStamp": 1683874800075,
  "attributes": {
    "createdAt": 1683874800056,
    "data": {
      "loyaltyType": "LOYALTY",
      "source": "instore",
      "firstName": "VEERAISH",
      "lastName": "PATAL",
      " enteredAt": 1683829800000,
      "enteredBy": {
        "id": 200325652,
        "till": {
          "code": "vh.up.budaun.104458.1",
          "name": "vh.up.budaun.104458.1"
        },
        "store": {
          "code": "vh.up.budaun.104458",
          "name ": "VH BUDAUN 104458",
          "externalId": "104458",
          "externalId1": "27948",
          "externalId2": ""
        }
      },
      "updatedFields": [
        
      ],
      "customerIdentifiers": {
        "customerId": 163880003,
        "instore": {
          "mobi le": "918395082082",
          "externalId": "AE-22009739375"
        }
      }
    },
    "eventName": "customerUpdated",
    "refId": "150117_163880003",
    "apiRequestId": "34ca0f377081611781cefd65a67bea86",
    "orgId": 150117
  }
}

Transaction

Transaction Added Event (transactionAdded)

Request Parameters

ParameterDatatypeDescription
amountDoubleNet transaction amount.
billClientIdStringUnique id of the bill as per the client (org) end.
billNumberStringUnique transaction number. The uniqueness depends on the configuration.
enteredAt
enteredByobjDetails of the store at which the transaction happened.
transactionIdlongUnique transaction ID generated internally.
deliveryStatusEnumDelivery status of the order. Value: PLACED, PROCESSED, SHIPPED, DELIVERED, RETURNED.
billTypeEnumType of transaction. Supported value: regular for loyalty transactions. ‘RETURN’ for return transactions.
lineItemCountIntegerNumber of line-items in the transaction.
DiscountDoubleDiscount availed for the transaction (discount amount).
grossAmountDoubleTransaction amount before discount.
currencyCodeStringISO 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)

Request Parameters

ParameterDatatypeDescription
amountDoubleNet transaction amount.
billClientIdStringUnique id of the bill as per the client (org) end.
billNumberStringUnique transaction number. The uniqueness depends on the configuration.
enteredAt
enteredByobjDetails of the store at which the transaction happened.
transactionIdlongUnique transaction ID generated internally.
deliveryStatusEnumDelivery status of the order. Value: PLACED, PROCESSED, SHIPPED, DELIVERED, RETURNED.
Delivery status of the order. Value: PLACED, PROCESSED, SHIPPED, DELIVERED, RETURNED.
billTypeEnumType of transaction. Supported value: regular for loyalty transactions. ‘RETURN’ for return transactions.
lineItemCountIntegerNumber of line-items in the transaction.
DiscountDoubleDiscount availed for the transaction (discount amount).
grossAmountDoubleTransaction amount before discount.
currencyCodeStringISO 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": "DELIV ERED",
      "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
  }
}

Points

Points Issued Event (pointsIssued)

Request Parameters

ParameterTypeDescription
eventIdStringUnique identifier for the event.
eventTypeStringType of event, e.g., "50660_pointsIssued".
consumerGroupIdIdentifier for a consumer group (empty in this case).
actionTypeStringType of action, e.g., "START".
timeStampNumberTimestamp of the event.
attributesObjectAdditional attributes related to the event.
- createdAtNumberTimestamp when the event was created.
- dataObjectData related to the event.
-- customerIdentifiersObjectIdentifiers related to the customer.
--- customerIdNumberUnique identifier for the customer.
-- entityInformationObjectInformation about the entity involved in the event.
--- entityTypeStringType of entity, e.g., "USER".
--- entityIdNumberUnique identifier for the entity.
-- triggeringActivityObjectDetails about the activity that triggered the event.
--- nameStringName of the triggering activity.
--- identifiersArrayIdentifiers related to the activity.
---- keyStringKey identifier, e.g., "CustomerId".
---- valueStringValue of the key identifier.
--- enteredByObjectUser who entered the activity.
---- idNumberUnique identifier for the user.
--- additionalAttributesArrayAdditional attributes related to the activity.
---- keyStringKey attribute, e.g., "customerId".
---- valueStringValue of the key attribute.
-- loyaltyProgramDetailsObjectDetails about the loyalty program.
--- idNumberUnique identifier for the program.
--- nameStringName of the program.
--- isDefaultBooleanIndicates if it's the default program.
--- pointsToCurrencyRatioNumberPoints-to-currency conversion ratio.
--- tiersArrayList of program tiers.
---- tierNumberNumberTier number, e.g., 1.
---- tierNameStringTier name, e.g., "Silver".
-- loyaltyProgramIdNumberUnique identifier for the loyalty program.
-- programCurrentPointsNumberCurrent points in the loyalty program.
-- programLifetimePointsNumberLifetime points in the loyalty program.
-- totalPointsIssuedNumberTotal points issued in the event.
-- regularPointsIssuedNumberRegular points issued in the event.
-- regularPointsBreakupArrayBreakdown of regular points issued (empty in this case).
-- promotionalPointsIssuedArrayPromotional points issued in the event.
--- promotionIdentifierStringIdentifier for the promotion.
--- promotionTypeStringType of promotion, e.g., "CUSTOMER_PROMOTION".
--- promotionPointsNumberPoints awarded for the promotion.
--- promotionPointsExpiryDateStringExpiry date of the promotion points.
-- promisedPointsIssuedArrayPromised points issued in the event (empty in this case).
-- behavioralEventAttributes*ObjectAttributes related to behavioral events.
--- webhookIdStringIdentifier for the webhook.
--- event_flagNumberEvent flag.
--- identifier_valueStringIdentifier value, e.g., "unionId918821563441".
--- requestIdStringUnique identifier for the request.
--- event_nameStringName of the event.
--- startTimeNumberStart time of the event.
loyaltyEventIdStringIdentifier for the loyalty event.
eventNameStringName of the event, e.g., "pointsIssued".
refIdStringReference identifier for the event.
apiRequestIdStringIdentifier for the API request.
orgIdNumberUnique 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",
  "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)

Sample schema of group program redemption.

{
  "eventId": "3b231837-db52-48cb-a405-cc162f2e1bd6",
  "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&$",
   "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)

{
  "eventId": "f993741a-89f3-46c8-b70f-6f45cfce7dba",
  "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)

{
   "eventName":"pointsExpired",
   "eventId":"abacd-12345-ABCD",
   "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 (pointsExpired)

{
    "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": "PellDungaAgarUseKiyaTohDefaultProgram",
            "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 (pointsTransferInitiated)

{
  "eventId": "3c9d293a-f9bd-4a49-a54a-63d4af500b46",
  "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 (pointsTransferReceived)

{
  "eventId": "bb12e156-edfe-4a2d-9831-b1224ebb3d77",
  "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)

{
  "eventId": "a5058d77-370f-4544-a420-8337f9d5fbf1",
  "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)

{
  "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)

{
  "eventName": "issuedPointsReversed",
  "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"
}

Coupon

Coupon Issue Event (CouponIssue)

This event allows you to issue a series of coupons to a customer, enabling them to redeem the coupons.

{
   "eventName":"CouponIssue",
   "eventId":"78871533-bec4-457b-8dce-17bc38a5a2d1",
   "orgId":1231,
   "refId":"1231_353122_397759647:397759647",
   "apiRequestId":"08ccc811706f99919580fdf035c52a72",
   "createdAt":1630927651741,
   "data":{
      "addedAt":1630927651741,
      "addedBy":{
         "id":15071481
      },
      "coupons":[
         {
            "id":397759647,
            "code":"2YPHHFQR",
            "valid_till":2556124199000,
            "issued_on":1630927651000,
            "customerIdentifiers":{
               "customerId":414935964
            }
         }
      ],
      "series_info":{
         "id":353122,
         "description":"traffic_simulator",
         "seriesType":"LOYALTY",
         "clientHandlingType":"DISC_CODE",
         "valid_till":2556037800000,
         "discount_code":"NO_VALUE",
         "discount_type":"ABS",
         "discount_value":500
      },
      "issualType":"SINGLE"
   },
   "loyaltyEventId":null
}

Coupon Redeem Event (CouponRedeem)

This event allows you to redeem active coupons of a loyalty customer. You can pass multiple coupons at once.

{
  "eventName": "CouponRedeem",
  "eventId": "edc7931a-c1f1-49a6-85f8-41878bbe20ee",
  "orgId": 998,
  "refId": "998_105710_13278432",
  "apiRequestId": "e422a015080377989a23b583e72d849a",
  "createdAt": 1724904056455,
  "data": {
    "addedAt": 1724904056455,
    "addedBy": {
      "id": 12808452
    },
    "coupon": {
      "id": 792947747,
      "code": "STATUSPAGE1",
      "redemptionId": 13278432,
      "redemptionDate": 1724904056000,
      "series_info": {
        "id": 105710,
        "description": "Status_Page_Redeem",
        "seriesType": "LOYALTY",
        "clientHandlingType": "DISC_CODE_PIN",
        "valid_till": 4772066295000,
        "discount_code": "NO_VALUE",
        "discount_type": "ABS",
        "discount_value": 10
      }
    },
    "customerIdentifiers": {
      "customerId": 362028955
    },
    "transaction": {
      "bill_id": 0,
      "number": ""
    }
  },
  "loyaltyEventId": null
}

Issue Bulk Coupon with Count (CouponIssue)

Using this event, you can issue multiple coupons from a coupon series to the same customer by defining the quantity of coupons.

{
  "eventName": "CouponIssue",
  "eventId": "de068e40-06e0-4176-b876-ccd4b602347a",
  "orgId": 998,
  "refId": "998_516557_1241056561:1241056570",
  "apiRequestId": "rohan_test",
  "createdAt": 1724907145664,
  "data": {
    "addedAt": 1724907145664,
    "addedBy": {
      "id": 50026273
    },
    "coupons": [
      {
        "id": 1241056561,
        "code": "VQ3U9146",
        "valid_till": 1726252199000,
        "issued_on": 1724907145000,
        "customerIdentifiers": {
          "customerId": 423813652
        }
      },
      {
        "id": 1241056562,
        "code": "0TM4WNMA",
        "valid_till": 1726252199000,
        "issued_on": 1724907145000,
        "customerIdentifiers": {
          "customerId": 423813652
        }
      },
      {
        "id": 1241056563,
        "code": "T4ZB61TH",
        "valid_till": 1726252199000,
        "issued_on": 1724907145000,
        "customerIdentifiers": {
          "customerId": 423813652
        }
      },
      {
        "id": 1241056564,
        "code": "AM70QPZP",
        "valid_till": 1726252199000,
        "issued_on": 1724907145000,
        "customerIdentifiers": {
          "customerId": 423813652
        }
      },
      {
        "id": 1241056565,
        "code": "6NR39R38",
        "valid_till": 1726252199000,
        "issued_on": 1724907145000,
        "customerIdentifiers": {
          "customerId": 423813652
        }
      },
      {
        "id": 1241056566,
        "code": "BODWSTE5",
        "valid_till": 1726252199000,
        "issued_on": 1724907145000,
        "customerIdentifiers": {
          "customerId": 423813652
        }
      },
      {
        "id": 1241056567,
        "code": "TOG3B75Z",
        "valid_till": 1726252199000,
        "issued_on": 1724907145000,
        "customerIdentifiers": {
          "customerId": 423813652
        }
      },
      {
        "id": 1241056568,
        "code": "SC5M5CBR",
        "valid_till": 1726252199000,
        "issued_on": 1724907145000,
        "customerIdentifiers": {
          "customerId": 423813652
        }
      },
      {
        "id": 1241056569,
        "code": "MXAYVOCB",
        "valid_till": 1726252199000,
        "issued_on": 1724907145000,
        "customerIdentifiers": {
          "customerId": 423813652
        }
      },
      {
        "id": 1241056570,
        "code": "C6NPTDX9",
        "valid_till": 1726252199000,
        "issued_on": 1724907145000,
        "customerIdentifiers": {
          "customerId": 423813652
        }
      }
    ],
    "series_info": {
      "id": 516557,
      "description": "Rohan test",
      "seriesType": "UNDEFINED",
      "clientHandlingType": "DISC_CODE",
      "valid_till": 1726165800000,
      "discount_code": "NO_VALUE",
      "discount_type": "ABS",
      "discount_value": 10
    },
    "issualType": "SINGLE"
  },
  "loyaltyEventId": null
}

Tier

Tier Upgraded (tierUpgraded)

{
    "apiRequestId": "1344ffd5-7b6f-4af0-a23d-ce354da13c76",
    "createdAt": 1720440349027.0,
    "data": {
        "customerIdentifiers": {
            "customerId": 379499720.0
        },
        "entityInformation": {
            "entityId": 1676.0,
            "entityType": "entityType"
        },
        "loyaltyProgramDetails": {
            "id": 1676.0,
            "isDefault": null,
            "name": "name",
            "pointsToCurrencyRatio": 1677.0,
            "tiers": null
        },
        "loyaltyProgramId": 1676.0,
        "notes": "notes",
        "previousTierNumber": 1676.0,
        "tierExpiryDate": "tierExpiryDate",
        "triggeringActivity": {
            "additionalAttributes": null,
            "enteredBy": null,
            "entityInformation": null,
            "identifiers": null,
            "name": "name"
        },
        "upgradeType": "upgradeType",
        "upgradedTierNumber": 1676.0
    },
    "eventId": "ccf65d56-1e34-4282-b9ad-8fe3fe558b74",
    "eventName": "tierUpgraded",
    "loyaltyEventId": null,
    "orgId": 50952.0,
    "refId": "50952_7250807"
}

Tier Renewed Event (tierRenewed)

{
    "apiRequestId": "1344ffd5-7b6f-4af0-a23d-ce354da13c76",
    "createdAt": 1720435141002.0,
    "data": {
        "currentTierNumber": 1676.0,
        "customerIdentifiers": {
            "customerId": 379499720.0
        },
        "entityInformation": {
            "entityId": 1676.0,
            "entityType": "entityType"
        },
        "loyaltyProgramDetails": {
            "id": 1676.0,
            "isDefault": null,
            "name": "name",
            "pointsToCurrencyRatio": 1677.0,
            "tiers": null
        },
        "loyaltyProgramId": 1676.0,
        "notes": "notes",
        "renewType": "renewType",
        "tierExpiryDate": "tierExpiryDate",
        "triggeringActivity": {
            "additionalAttributes": null,
            "enteredBy": null,
            "entityInformation": null,
            "identifiers": null,
            "name": "name"
        }
    },
    "eventId": "ccf65d56-1e34-4282-b9ad-8fe3fe558b74",
    "eventName": "tierRenewed",
    "loyaltyEventId": null,
    "orgId": 50952.0,
    "refId": "50952_7250807" }

Tier Downgraded Event (tierDowngraded)

{
    "apiRequestId": "1344ffd5-7b6f-4af0-a23d-ce354da13c76",
    "createdAt": 1720435042600.0,
    "data": {
        "customerIdentifiers": {
            "customerId": 379499720.0
        },
        "downgradedTierNumber": 1676.0,
        "entityInformation": {
            "entityId": 1676.0,
            "entityType": "entityType"
        },
        "loyaltyProgramDetails": {
            "id": 1676.0,
            "isDefault": null,
            "name": "name",
            "pointsToCurrencyRatio": 1677.0,
            "tiers": null
        },
        "loyaltyProgramId": 1676.0,
        "previousTierNumber": 1676.0,
        "tierExpiryDate": "tierExpiryDate",
        "triggeringActivity": {
            "additionalAttributes": null,
            "enteredBy": null,
            "entityInformation": null,
            "identifiers": null,
            "name": "name"
        }
    },
    "eventId": "ccf65d56-1e34-4282-b9ad-8fe3fe558b74",
    "eventName": "tierDowngraded",
    "loyaltyEventId": null,
    "orgId": 50952.0,
    "refId": "50952_7250807"
}

Tier Downgrade Reminder Event (tierDowngradeReminder)

{
    "apiRequestId": "1344ffd5-7b6f-4af0-a23d-ce354da13c76",
    "createdAt": 1720440490349.0,
    "data": {
        "currentTierNumber": 1676.0,
        "customerIdentifiers": {
            "customerId": 379499720.0
        },
        "entityInformation": {
            "entityId": 1676.0,
            "entityType": "entityType"
        },
        "loyaltyProgramDetails": {
            "id": 1676.0,
            "isDefault": null,
            "name": "name",
            "pointsToCurrencyRatio": 1677.0,
            "tiers": null
        },
        "loyaltyProgramId": 1676.0,
        "scheduledDowngradeDate": "scheduledDowngradeDate",
        "triggeringActivity": {
            "additionalAttributes": null,
            "enteredBy": null,
            "entityInformation": null,
            "identifiers": null,
            "name": "name"
        }
    },
    "eventId": "ccf65d56-1e34-4282-b9ad-8fe3fe558b74",
    "eventName": "tierDowngradeReminder",
    "loyaltyEventId": null,
    "orgId": 50952.0,
    "refId": "50952_7250807"
}

Partner Program

Partner Program Linked (partnerProgramLinked)

{
  "eventId": "1b049b7f-9363-464c-beaf-0c7c2f1f8a12",
  "eventType": "partnerProgramLinked",
  "consumerGroupId": null,
  "actionType": "START",
  "timeStamp": 1683871605623,
  "attributes": {
    "createdAt": 1683871605603,
    "data": {
      "customerIdentifiers": {
        "customerId": 6809254,
        "instore": {
          "mobile": "6590688093",
          "email": "[email protected]"
        }
      },
      "entityInformation": {
        "entityType": "USER",
        "entityId": 6809254
      },
      "loyaltyProgramId": 1115,
      "partnerProgramId": 45,
      "partnerProgramName": "Drivers ",
      "partnerProgramType": "SUPPLEMENTARY",
      "customerPartnerProgramDetails": {
        "membershipExpiryDate": "2123-05-12"
      }
    },
    "eventName": "partnerProgramLinked",
    "refId": "151197_C3zPfmvsZL ",
    "apiRequestId": "5ba71b8f-5557-4a68-86b9-8e597722ce16",
    "orgId": 151197
  }
}

Partner Program Updated (partnerProgramUpdated)

{
   "eventName":"partnerProgramUpdated",
   "eventId":"caff89da-4c1c-4a5c-a27d-8f4f6f74f541",
   "orgId":50191,
   "refId":"50191_esJyjQ23RQ",
   "apiRequestId":"95d1d0d76dda1565a3c2905f230c3975",
   "createdAt":1622457292026,
   "data":{
      "customerIdentifiers":{
         "customerId":354971193,
         "instore":{
            "mobile":"919666308709",
            "email":"[email protected]",
            "externalId":"919666308709"
         }
      },
      "loyaltyProgramId":855,
      "partnerProgramId":25,
      "partnerProgramName":"Demo-p1",
      "partnerProgramType":"EXTERNAL",
      "updateType":"UPGRADE",
      "customerPartnerProgramDetails":{
         "partnerTierExpiryDate":"2021-06-29",
         "partnerTierNumber":2,
         "membershipNumber":"123-asa3"
      }
   },
   "loyaltyEventId":null
}

Partner Program Delinked (partnerProgramDelinked)

{
  "eventId": "1ef12ace-12f2-41c6-9655-7c016f5adb65",
  "eventType": "partnerProgramDelinked",
  "consumerGroupId": null,
  "actionType": "START",
  "timeStamp": 1683872179078,
  "attributes": {
    "createdAt": 1683872179035,
    "data": {
      "customerIdentifiers": {
        "customerId": 6529619,
        "instore": {
          "mobile": "658750602 4",
          "email": "[email protected]"
        }
      },
      "entityInformation": {
        "entityType": "USER",
        "entityId": 6529619
      },
      "loyaltyProgramId": 1115,
      "partnerProgramId": 46,
      "partnerProgramName": " Riders",
      "partnerProgramType": "SUPPLEMENTARY"
    },
    "eventName": "partnerProgramDelinked",
    "refId": "151197_j6THoPLbHd",
    "apiRequestId": "cd49688e-2bb6-4ca5-bfd4-5ec8acb10678",
    "orgId ": 151197
  }
}

Supplementary Partner Program Expiry Reminder (supplementaryMembershipExpiryReminder)

{
   "eventName":"supplementaryMembershipExpiryReminder",
   "eventId":"e084e887-e1d5-45cf-b2bf-55024efeb8fe",
   "orgId":50191,
   "refId":"50191_90ab89ff-ca0d-4ccd-8b40-2b36614d4c20_b1",
   "apiRequestId":"dee1c05f-bbd1-407e-8244-ec4f36a8dcf3",
   "createdAt":1622518207403,
   "data":{
      "customerIdentifiers":{
         "customerId":354971186,
         "instore":{
            "mobile":"919100166820",
            "email":"[email protected]",
            "externalId":"919100166820"
         }
      },
      "loyaltyProgramId":855,
      "partnerProgramId":22,
      "partnerProgramName":"SPprogram1",
      "scheduledExpiryDate":"2021-06-01"
   },
   "loyaltyEventId":null
}

Rewards

Reward Created Event (rewardCreated)

{
  "eventId": "abe25436-766a-422d-a5bf-b76b09b15086",
  "eventType": "rewardCreated",
  "consumerGroupId": null,
  "actionType": "ST ART",
  "timeStamp": 1683871865490,
  "attributes": {
    "createdAt": 1683871865413,
    "data": {
      "rewardId": 55881,
      "type": "POINTS",
      "enabled": true,
      "redemptionType": "VENDOR_INTOUCH_REWARD",
      "startDate": 1683871875000,
      "endDate": 1683958265000,
      "intouchPoints": 1,
      "intouchSeriesId": "315206",
      "priority": 1,
      "tier": "SILVER",
      "categories": [
        null,
        null,
        null
      ],
      "geographies": [
        {
          
        }
      ],
      "rewardDetails": [
        {
          "languageCode": "en",
          "name": " INTOUCH Enabled",
          "description": "Description",
          "termAndConditionsId": "EXDR12987R",
          "termAndConditionsUrl": "https://s3.eu -west-1.amazonaws.com/eucrm-solutions/CAMPAIGNSAUTO/EXDR12987R?X-Amz-Security-Token=FwoGZXIvYXdzEK%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDJlvTJM4r%2FE81XZ%2BDCLTAfl8WDoMuSD%2BSr0kEViFOqU0rCx%2 Fecb038TLJZB0J5LFPaf9B13FtPuD%2B8IqNQSE4l3LK1ZWGf38kVmqrwkCqCQpaGxpl8sAFuwpMl2cPJ30ikkUvYlGS3KIH9TkJ%2BTAbASQR1WA6Gwn7qRjSNL87a8DH%2FXsk31F9UdS3BwR%2B6ZpVQXlFRxy6dcKFbEa0KXF5RDIoANDEcjh8tsi lFxQPcbNXo4am5gTJTFPUiE3B%2BjSLMbA0BNdSh156cjw%2BuSAys%2FZca%2BJ%2B1RIGZNAd6JW%2FyVw5t8ol6z3ogYyLZL4V8TpTm1xk%2FtDkROBgLsNYXSYwZDLsXjOqTFbVqDnF1%2B6akkDLiaZ76hSSg%3D%3D&X-Amz-Algorithm=AWS4 -HMAC-SHA256&X-Amz-Date=20230512T061105Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXKEP2EMBXJRDRL7E%2F20230512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=37d3cbc b886a14a3749bcdc1dca289bcda047b237f7b4b52f50bb64a351c530e",
          "imageId": "EXDR12987U",
          "imageUrl": "https://s3.eu-west-1.amazonaws.com/eucrm-solutions/CAMPAIGNSAUTO/EXDR12987U?X-Amz-Secur ity-Token=FwoGZXIvYXdzEK%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDJlvTJM4r%2FE81XZ%2BDCLTAfl8WDoMuSD%2BSr0kEViFOqU0rCx%2Fecb038TLJZB0J5LFPaf9B13FtPuD%2B8IqNQSE4l3LK1ZWGf38kVmqrwkCqCQpaGxpl8sAFuw pMl2cPJ30ikkUvYlGS3KIH9TkJ%2BTAbASQR1WA6Gwn7qRjSNL87a8DH%2FXsk31F9UdS3BwR%2B6ZpVQXlFRxy6dcKFbEa0KXF5RDIoANDEcjh8tsilFxQPcbNXo4am5gTJTFPUiE3B%2BjSLMbA0BNdSh156cjw%2BuSAys%2FZca%2BJ%2B1RIGZNA d6JW%2FyVw5t8ol6z3ogYyLZL4V8TpTm1xk%2FtDkROBgLsNYXSYwZDLsXjOqTFbVqDnF1%2B6akkDLiaZ76hSSg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230512T061105Z&X-Amz-SignedHeaders=host&X-Amz-Ex pires=3600&X-Amz-Credential=ASIAXKEP2EMBXJRDRL7E%2F20230512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=9188fa42f178c9bc57e26ead20d0661d1f27c8455dbb3802a0b84e4cf2b2b678",
          "thumbnailId ": "EXDR12987T",
          "thumbnailUrl": "https://s3.eu-west-1.amazonaws.com/eucrm-solutions/CAMPAIGNSAUTO/EXDR12987T?X-Amz-Security-Token=FwoGZXIvYXdzEK%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDJlvTJ M4r%2FE81XZ%2BDCLTAfl8WDoMuSD%2BSr0kEViFOqU0rCx%2Fecb038TLJZB0J5LFPaf9B13FtPuD%2B8IqNQSE4l3LK1ZWGf38kVmqrwkCqCQpaGxpl8sAFuwpMl2cPJ30ikkUvYlGS3KIH9TkJ%2BTAbASQR1WA6Gwn7qRjSNL87a8DH%2FXsk31F9 UdS3BwR%2B6ZpVQXlFRxy6dcKFbEa0KXF5RDIoANDEcjh8tsilFxQPcbNXo4am5gTJTFPUiE3B%2BjSLMbA0BNdSh156cjw%2BuSAys%2FZca%2BJ%2B1RIGZNAd6JW%2FyVw5t8ol6z3ogYyLZL4V8TpTm1xk%2FtDkROBgLsNYXSYwZDLsXjOqTFbVq DnF1%2B6akkDLiaZ76hSSg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230512T061105Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXKEP2EMBXJRDRL7E%2F20230512%2Feu-w est-1%2Fs3%2Faws4_request&X-Amz-Signature=d2df9b2b480d4280f02dfa6ff9b244b12756f7e92a26d1842a21e5fa038ca64f"
        }
      ],
      "vendorDetails": {
        "id": 1,
        "name": "Capillary"
      },
      "vendorRedemptionDetails ": {
        "id": 4848,
        "name": "VENDOR REDEMPTION-Postman_Test"
      }
    },
    "eventName": "rewardCreated",
    "refId": "100027_55881",
    "apiRequestId": "2622ee54-9406-4021-a1ef-44afa167ce1a",
    "orgId": 100027
  }
}


Reward Issued Event (rewardIssued)

  • "type": VOUCHER, POINTS, physical voucher, free voucher,

  • "redemptionType": INTOUCH_REWARD, VENDOR_INTOUCH_REWARD, VENDOR_ONLY_REWARD

{
  "eventId": "8bcf9e04-3e75-4090-a2bc-c4b8164717f0",
  "eventType": "rewardIssued",
  "consumerGroupId": null,
  "actionType": "START",
  "timeStamp": 1683871896901,
  "attributes": {
    "createdAt": 1683871896747,
    "data": {
      "customerIdentifiers": {
        "customerId": 174429194,
        "instore": {
          "mobile": "919876543205",
          "email": " [email protected]",
          "externalId": "899907"
        }
      },
      "rewardId": 55881,
      "type": "POINTS",
      "redemptionType": "VENDOR_INTOUCH_REWARD",
      "startDate": 1683871875000,
      "endDate": 1683958265000,
      "intouchPoints": 1,
      "intouchSeriesId": "315206",
      "priority": 1,
      "tier": "SILVER",
      "intouchRewardDetails": {
        "intouchCouponCode": "C929Z3OI",
        "codeExpiry": 1684022400000
      },
      " vendorRewardDetails": {
        "vendorVoucher": "C929Z3OI"
      }
    },
    "eventName": "rewardIssued",
    "refId": "100027_55881",
    "apiRequestId": "9d81d52c-25b8-4138-b9b9-206f4a535b95",
    "orgId": 100027
  }
}

Reward Updated Event (rewardUpdated)

{
  "eventId": "a1660044-1d23-4eb8-a388-8a1dcd67a8a4",
  "eventType": "rewardUpdated",
  "consumerGroupId": null,
  "actionType": "START",
  "timeStamp": 1683871780912,
  "attributes": {
    "createdAt": 1683871780887,
    "data": {
      "rewardId": 55880,
      "type": "POINTS",
      "enabled": false,
      "redemptionType": "CART_PROMOTION",
      "star tDate": 1683871760000,
      "endDate": 1683958150000,
      "intouchPoints": 1,
      "intouchSeriesId": "645dd8051baa292a997a83be",
      "priority": 1,
      "tier": "SILVER",
      "categories": [
        23,
        24,
        25
      ],
      "geographies": [
        {
          "countryId": 10,
          "cityId": 0,
          "areaId": 0
        }
      ],
      "rewardDetails": [
        {
          "languageCode": "en",
          "name": " INTOUCH Enabled",
          "description": "Description",
          "termAndConditionsId": "EXDR1 2987R",
          "termAndConditionsUrl": "https://s3.eu-west-1.amazonaws.com/eucrm-solutions/CAMPAIGNSAUTO/EXDR12987R?X-Amz-Security-Token=FwoGZXIvYXdzEK%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDDUAZmi hbHCbYFO2eyLUASgLYJ31faSW%2F6s5mrqDMHXGBNMBWdFXxqearp3myX%2FwN%2BfnCh1LusCE%2B3WLvDUywa%2F2R5%2FL7nvI6fSy2QOLNa8cooU3G3uD2%2BxaQY1G5idkwG7GFc6kNEt6lZdzFdjqjZUm6XfpwxOwjD6Jo9GgqfMmiH%2BPYvyi 8pX5tNTHYdJEZvMKNJW2jwrOLmdItXmAZBrVV9fZK42dMZzsG8Ik7t2Y4cLm4eOp5LB5nqP0fzataFsq0a5M%2BwDJ6VxzmD7itNLAAq2KnxunqQurnwaUequozhqJKPOr96IGMi052h2NbaSQW4LElOEgiLzV54O9fAuJiAp5ajESrMKGXniQ44mvAXz LvlAuFHo%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230512T060940Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXKEP2EMBZGHSA6BI%2F20230512%2Feu-west-1%2Fs3%2Faws4 _request&X-Amz-Signature=d53341d61abbb5c866f646c566cbe5bc33df4992c0759dd01d25a94a11dfb659",
          "imageId": "EXDR12987U",
          "imageUrl": "https://s3.eu-west-1.amazonaws.com/eucrm-solutions/CAMP AIGNSAUTO/EXDR12987U?X-Amz-Security-Token=FwoGZXIvYXdzEK%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDDUAZmihbHCbYFO2eyLUASgLYJ31faSW%2F6s5mrqDMHXGBNMBWdFXxqearp3myX%2FwN%2BfnCh1LusCE%2B3WLvDUywa%2F 2R5%2FL7nvI6fSy2QOLNa8cooU3G3uD2%2BxaQY1G5idkwG7GFc6kNEt6lZdzFdjqjZUm6XfpwxOwjD6Jo9GgqfMmiH%2BPYvyi8pX5tNTHYdJEZvMKNJW2jwrOLmdItXmAZBrVV9fZK42dMZzsG8Ik7t2Y4cLm4eOp5LB5nqP0fzataFsq0a5M%2BwDJ 6VxzmD7itNLAAq2KnxunqQurnwaUequozhqJKPOr96IGMi052h2NbaSQW4LElOEgiLzV54O9fAuJiAp5ajESrMKGXniQ44mvAXzLvlAuFHo%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230512T060940Z&X-Amz-SignedHeade rs=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXKEP2EMBZGHSA6BI%2F20230512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=62c6f34560eb8031ff4da83abaabd251a92ac47ef732ee6cff4514b8830b7b3e ",
          "thumbnailId": "EXDR12987T",
          "thumbnailUrl": "https://s3.eu-west-1.amazonaws.com/eucrm-solutions/CAMPAIGNSAUTO/EXDR12987T?X-Amz-Security-Token=FwoGZXIvYXdzEK%2F%2F%2F%2F%2F%2F%2F%2F%2 F%2F%2FwEaDDUAZmihbHCbYFO2eyLUASgLYJ31faSW%2F6s5mrqDMHXGBNMBWdFXxqearp3myX%2FwN%2BfnCh1LusCE%2B3WLvDUywa%2F2R5%2FL7nvI6fSy2QOLNa8cooU3G3uD2%2BxaQY1G5idkwG7GFc6kNEt6lZdzFdjqjZUm6XfpwxOwjD6Jo 9GgqfMmiH%2BPYvyi8pX5tNTHYdJEZvMKNJW2jwrOLmdItXmAZBrVV9fZK42dMZzsG8Ik7t2Y4cLm4eOp5LB5nqP0fzataFsq0a5M%2BwDJ6VxzmD7itNLAAq2KnxunqQurnwaUequozhqJKPOr96IGMi052h2NbaSQW4LElOEgiLzV54O9fAuJiAp5aj ESrMKGXniQ44mvAXzLvlAuFHo%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230512T060940Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXKEP2EMBZGHSA6BI%2F20230512%2Feu-w est-1%2Fs3%2Faws4_request&X-Amz-Signature=ca72c2b31cdb6280d8e1030f69de02c0aee41c534f50e2d282b5fb5bb6647c70"
        }
      ]
    },
    "eventName": "rewardUpdated",
    "refId": "100027_55880",
    "apiRequestId": "e17225aa-0805-4763-b46d-38a90d35bf1e",
    "orgId": 100027
  }
}

Issue Reward Failure Event (issueRewardFailure)

{
  "eventId": "a85bbecd-ac92-4893-8dda-a67c0433100c",
  "eventType": "issueRewardFailure",
  "consumerGroupId": null,
  "actionT ype": "START",
  "timeStamp": 1683874809673,
  "attributes": {
    "createdAt": 1683874809656,
    "data": {
      "customerIdentifiers": {
        "customerId": 4299480,
        "instore": {
          "mobile": "6590116229",
          "em ail": "[email protected]",
          "externalId": "8099792344"
        }
      },
      "requestId": "0a3731f3-e8ce-4ad4-a331-4b44d44193fe",
      "totalPoints": 10,
      "erroredSteps": [
        {
          "name": "ISSUE_REWARD",
          "erro rMessage": "Unknown error : MAX_COUPON_ISSUAL_PER_USER_EXCEEDED",
          "errorCode": 730,
          "rewards": [
            {
              "id": 57141,
              "qty": 1,
              "points": 10,
              "type": "VOUCHER",
              "rewardReference": "736"
            }
          ]
        }
      ]
    },
    "eventName": "issueRewardFailure",
    "refId": "151197_0a3731f3-e8ce-4ad4-a331-4b44d44193fe",
    "apiRequestId": "0a3731f3-e8ce-4ad4-a331-4b44d44193fe",
    "orgId": 151197
  }
}

Reward Expiry Reminder (rewardExpiryReminder)

This event is used to create Reward Expiry Reminder.

{
  "eventName": "rewardExpiryReminder",
  "eventId": "6b2584aa-8ebe-49de-9c1c-fcba7daed9e4",
  "orgId": 51544,
  "refId": "51544_113659",
  "apiRequestId": "eaeda000-b5a9-4c54-a5f4-2c68e7fbdee4",
  "createdAt": 1726765207054,
  "data": {
    "rewardId": 113659,
    "type": "VOUCHER",
    "enabled": true,
    "redemptionType": "MILES",
    "startDate": 1726768253000,
    "endDate": 1726769453000,
    "intouchPoints": 0,
    "intouchSeriesId": "123",
    "priority": 5,
    "rewardDetails": [
      {
        "languageCode": "en",
        "name": "testReward0001",
        "description": "GIFT_CARD partner reward for test_Rewards_content_type_GIFT_CARD",
        "termAndConditionsId": "t&c",
        "termAndConditionsUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/testOrg_marvel_20230822_147/t%26c?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDPfZLQAQuIIVJHT0WSLWAVxY%2FHfCb2avDbhz9MdqTieRMchpSyozExCeSW2ulzUnDfxlHco5bBoxK%2BSo7wFaiacimfoHWFqPGS7QowkCPr8HhB%2FWvFPOi88Qaah8omwtzpwSvoASTZ4EEo59HrnrKe7bBNVJ%2BDZ2OCOLAbIx3YwxWUGwd5UkxKXNvM8jocw3ypcpFMQHkobvfGwkZJ%2FautvasTMs%2FdsiswH8rxoCuuQHPGoBTb02exM1chQsWRGhIYQ64SNfxhsf4rDv9jUL0m5BzA9X8yB71QwqposiwYczslkvpnEol7GxtwYyLV%2BaXRp52GXVUVSpfADu%2Bxot4rmrMT19XTE9NFKDkocP%2BJ81VyMa5DjtdiXgew%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T170007Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNLRICZZP6%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b1c963b93ceae555e1ea4ab7248a3ae6cfa3f1eed5cb20a32a7974354a252293",
        "imageId": "EXDR12987U",
        "imageUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/testOrg_marvel_20230822_147/EXDR12987U?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDPfZLQAQuIIVJHT0WSLWAVxY%2FHfCb2avDbhz9MdqTieRMchpSyozExCeSW2ulzUnDfxlHco5bBoxK%2BSo7wFaiacimfoHWFqPGS7QowkCPr8HhB%2FWvFPOi88Qaah8omwtzpwSvoASTZ4EEo59HrnrKe7bBNVJ%2BDZ2OCOLAbIx3YwxWUGwd5UkxKXNvM8jocw3ypcpFMQHkobvfGwkZJ%2FautvasTMs%2FdsiswH8rxoCuuQHPGoBTb02exM1chQsWRGhIYQ64SNfxhsf4rDv9jUL0m5BzA9X8yB71QwqposiwYczslkvpnEol7GxtwYyLV%2BaXRp52GXVUVSpfADu%2Bxot4rmrMT19XTE9NFKDkocP%2BJ81VyMa5DjtdiXgew%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T170007Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNLRICZZP6%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=d290f86c87998761af877e8f1cf4b65e1031eedaf3dd0c40f992d835bf7061f6",
        "thumbnailId": "EXDR02987T",
        "thumbnailUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/testOrg_marvel_20230822_147/EXDR02987T?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDPfZLQAQuIIVJHT0WSLWAVxY%2FHfCb2avDbhz9MdqTieRMchpSyozExCeSW2ulzUnDfxlHco5bBoxK%2BSo7wFaiacimfoHWFqPGS7QowkCPr8HhB%2FWvFPOi88Qaah8omwtzpwSvoASTZ4EEo59HrnrKe7bBNVJ%2BDZ2OCOLAbIx3YwxWUGwd5UkxKXNvM8jocw3ypcpFMQHkobvfGwkZJ%2FautvasTMs%2FdsiswH8rxoCuuQHPGoBTb02exM1chQsWRGhIYQ64SNfxhsf4rDv9jUL0m5BzA9X8yB71QwqposiwYczslkvpnEol7GxtwYyLV%2BaXRp52GXVUVSpfADu%2Bxot4rmrMT19XTE9NFKDkocP%2BJ81VyMa5DjtdiXgew%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T170007Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNLRICZZP6%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=92de59fdb2b5b1086381090099675ab4c784eacb8d8f7381ce4f77603d6c44a4",
        "images": [
          {
            "name": "createRewardImage17265662870001",
            "id": "8837347b-20f1-401e-9a77-bdafb5e3086e",
            "url": "https://crm-nightly-new-fileservice.s3.amazonaws.com/solutions/50672/59d9976a-c4d2-42b0-8193-63a42866.png?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDAbTUObgoVqaJRu7EiLSAXKgjReG65ZtsQrlTbr91u%2Frd1fdxnWdz212KMGOEcxs2nExLcoPD426bpSz%2FOAYf0YBDLERxaCSj%2BiBhMHbPUnpm8k6iGUo17quKssUpQyw19spw5K%2BK0j6l5GUwGoKQS8Vh1w1UA3oy3eT4tEecylpLPh7YwmLCggL6eUan3xWFLN8mAwQDej7KXu0D71Ygay2gnh8fDG4Hn7To%2F%2BEyl9Cd9R7gvlEw%2BrNQuPjSRAcd4ZhKHp7BqzTmO%2Fyk4zXhG92LrOr7r9SGg3iahCm4FgbGiiiqbG3BjItRaS1oWd%2FnWD5cj37kPK2vXf%2Bvq3dAjYcPnwaUapcnWni5OmYBUpGMaeYi%2BF0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T164348Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNCPGTBCUM%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6ad9ce8a9e48c59cd97f20db89076ee9a598a0ec1033d20a77f62fcc73c3dda9"
          },
          {
            "name": "createRewardImage17265662870002",
            "id": "8837347b-20f1-401e-9a77-bdafb5e3086e",
            "url": "https://crm-nightly-new-fileservice.s3.amazonaws.com/solutions/50672/59d9976a-c4d2-42b0-8193-63a42866.png?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDAbTUObgoVqaJRu7EiLSAXKgjReG65ZtsQrlTbr91u%2Frd1fdxnWdz212KMGOEcxs2nExLcoPD426bpSz%2FOAYf0YBDLERxaCSj%2BiBhMHbPUnpm8k6iGUo17quKssUpQyw19spw5K%2BK0j6l5GUwGoKQS8Vh1w1UA3oy3eT4tEecylpLPh7YwmLCggL6eUan3xWFLN8mAwQDej7KXu0D71Ygay2gnh8fDG4Hn7To%2F%2BEyl9Cd9R7gvlEw%2BrNQuPjSRAcd4ZhKHp7BqzTmO%2Fyk4zXhG92LrOr7r9SGg3iahCm4FgbGiiiqbG3BjItRaS1oWd%2FnWD5cj37kPK2vXf%2Bvq3dAjYcPnwaUapcnWni5OmYBUpGMaeYi%2BF0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T164348Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNCPGTBCUM%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6ad9ce8a9e48c59cd97f20db89076ee9a598a0ec1033d20a77f62fcc73c3dda9"
          }
        ],
        "videos": [
          {
            "name": "createRewardImage17265662870001Video",
            "id": "8837347b-20f1-401e-9a77-bdafb5e3086e",
            "url": "https://crm-nightly-new-fileservice.s3.amazonaws.com/solutions/50672/59d9976a-c4d2-42b0-8193-63a42866.png?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDAbTUObgoVqaJRu7EiLSAXKgjReG65ZtsQrlTbr91u%2Frd1fdxnWdz212KMGOEcxs2nExLcoPD426bpSz%2FOAYf0YBDLERxaCSj%2BiBhMHbPUnpm8k6iGUo17quKssUpQyw19spw5K%2BK0j6l5GUwGoKQS8Vh1w1UA3oy3eT4tEecylpLPh7YwmLCggL6eUan3xWFLN8mAwQDej7KXu0D71Ygay2gnh8fDG4Hn7To%2F%2BEyl9Cd9R7gvlEw%2BrNQuPjSRAcd4ZhKHp7BqzTmO%2Fyk4zXhG92LrOr7r9SGg3iahCm4FgbGiiiqbG3BjItRaS1oWd%2FnWD5cj37kPK2vXf%2Bvq3dAjYcPnwaUapcnWni5OmYBUpGMaeYi%2BF0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T164348Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNCPGTBCUM%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6ad9ce8a9e48c59cd97f20db89076ee9a598a0ec1033d20a77f62fcc73c3dda9",
            "isExternal": false
          },
          {
            "name": "createRewardImage17265662870002Video",
            "url": "https://youtu.be/a_aSgmOqgrA",
            "isExternal": true
          }
        ]
      },
      {
        "languageCode": "fr",
        "name": "testReward-SECOND DETAILS",
        "description": "GIFT_CARD partner reward for test_Rewards_content_type_GIFT_CARD",
        "termAndConditionsId": "t&c",
        "termAndConditionsUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/testOrg_marvel_20230822_147/t%26c?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDPfZLQAQuIIVJHT0WSLWAVxY%2FHfCb2avDbhz9MdqTieRMchpSyozExCeSW2ulzUnDfxlHco5bBoxK%2BSo7wFaiacimfoHWFqPGS7QowkCPr8HhB%2FWvFPOi88Qaah8omwtzpwSvoASTZ4EEo59HrnrKe7bBNVJ%2BDZ2OCOLAbIx3YwxWUGwd5UkxKXNvM8jocw3ypcpFMQHkobvfGwkZJ%2FautvasTMs%2FdsiswH8rxoCuuQHPGoBTb02exM1chQsWRGhIYQ64SNfxhsf4rDv9jUL0m5BzA9X8yB71QwqposiwYczslkvpnEol7GxtwYyLV%2BaXRp52GXVUVSpfADu%2Bxot4rmrMT19XTE9NFKDkocP%2BJ81VyMa5DjtdiXgew%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T170007Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNLRICZZP6%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b1c963b93ceae555e1ea4ab7248a3ae6cfa3f1eed5cb20a32a7974354a252293",
        "imageId": "EXDR12987U",
        "imageUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/testOrg_marvel_20230822_147/EXDR12987U?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDPfZLQAQuIIVJHT0WSLWAVxY%2FHfCb2avDbhz9MdqTieRMchpSyozExCeSW2ulzUnDfxlHco5bBoxK%2BSo7wFaiacimfoHWFqPGS7QowkCPr8HhB%2FWvFPOi88Qaah8omwtzpwSvoASTZ4EEo59HrnrKe7bBNVJ%2BDZ2OCOLAbIx3YwxWUGwd5UkxKXNvM8jocw3ypcpFMQHkobvfGwkZJ%2FautvasTMs%2FdsiswH8rxoCuuQHPGoBTb02exM1chQsWRGhIYQ64SNfxhsf4rDv9jUL0m5BzA9X8yB71QwqposiwYczslkvpnEol7GxtwYyLV%2BaXRp52GXVUVSpfADu%2Bxot4rmrMT19XTE9NFKDkocP%2BJ81VyMa5DjtdiXgew%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T170007Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNLRICZZP6%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=d290f86c87998761af877e8f1cf4b65e1031eedaf3dd0c40f992d835bf7061f6",
        "thumbnailId": "EXDR02987T",
        "thumbnailUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/testOrg_marvel_20230822_147/EXDR02987T?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDPfZLQAQuIIVJHT0WSLWAVxY%2FHfCb2avDbhz9MdqTieRMchpSyozExCeSW2ulzUnDfxlHco5bBoxK%2BSo7wFaiacimfoHWFqPGS7QowkCPr8HhB%2FWvFPOi88Qaah8omwtzpwSvoASTZ4EEo59HrnrKe7bBNVJ%2BDZ2OCOLAbIx3YwxWUGwd5UkxKXNvM8jocw3ypcpFMQHkobvfGwkZJ%2FautvasTMs%2FdsiswH8rxoCuuQHPGoBTb02exM1chQsWRGhIYQ64SNfxhsf4rDv9jUL0m5BzA9X8yB71QwqposiwYczslkvpnEol7GxtwYyLV%2BaXRp52GXVUVSpfADu%2Bxot4rmrMT19XTE9NFKDkocP%2BJ81VyMa5DjtdiXgew%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T170007Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNLRICZZP6%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=92de59fdb2b5b1086381090099675ab4c784eacb8d8f7381ce4f77603d6c44a4",
        "images": [
          {
            "name": "createRewardImage17265662870001",
            "id": "8837347b-20f1-401e-9a77-bdafb5e3086e",
            "url": "https://crm-nightly-new-fileservice.s3.amazonaws.com/solutions/50672/59d9976a-c4d2-42b0-8193-63a42866.png?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDAbTUObgoVqaJRu7EiLSAXKgjReG65ZtsQrlTbr91u%2Frd1fdxnWdz212KMGOEcxs2nExLcoPD426bpSz%2FOAYf0YBDLERxaCSj%2BiBhMHbPUnpm8k6iGUo17quKssUpQyw19spw5K%2BK0j6l5GUwGoKQS8Vh1w1UA3oy3eT4tEecylpLPh7YwmLCggL6eUan3xWFLN8mAwQDej7KXu0D71Ygay2gnh8fDG4Hn7To%2F%2BEyl9Cd9R7gvlEw%2BrNQuPjSRAcd4ZhKHp7BqzTmO%2Fyk4zXhG92LrOr7r9SGg3iahCm4FgbGiiiqbG3BjItRaS1oWd%2FnWD5cj37kPK2vXf%2Bvq3dAjYcPnwaUapcnWni5OmYBUpGMaeYi%2BF0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T164348Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNCPGTBCUM%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6ad9ce8a9e48c59cd97f20db89076ee9a598a0ec1033d20a77f62fcc73c3dda9"
          },
          {
            "name": "createRewardImage17265662870002",
            "id": "8837347b-20f1-401e-9a77-bdafb5e3086e",
            "url": "https://crm-nightly-new-fileservice.s3.amazonaws.com/solutions/50672/59d9976a-c4d2-42b0-8193-63a42866.png?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDAbTUObgoVqaJRu7EiLSAXKgjReG65ZtsQrlTbr91u%2Frd1fdxnWdz212KMGOEcxs2nExLcoPD426bpSz%2FOAYf0YBDLERxaCSj%2BiBhMHbPUnpm8k6iGUo17quKssUpQyw19spw5K%2BK0j6l5GUwGoKQS8Vh1w1UA3oy3eT4tEecylpLPh7YwmLCggL6eUan3xWFLN8mAwQDej7KXu0D71Ygay2gnh8fDG4Hn7To%2F%2BEyl9Cd9R7gvlEw%2BrNQuPjSRAcd4ZhKHp7BqzTmO%2Fyk4zXhG92LrOr7r9SGg3iahCm4FgbGiiiqbG3BjItRaS1oWd%2FnWD5cj37kPK2vXf%2Bvq3dAjYcPnwaUapcnWni5OmYBUpGMaeYi%2BF0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T164348Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNCPGTBCUM%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6ad9ce8a9e48c59cd97f20db89076ee9a598a0ec1033d20a77f62fcc73c3dda9"
          }
        ],
        "videos": [
          {
            "name": "createRewardImage17265662870001Video",
            "id": "8837347b-20f1-401e-9a77-bdafb5e3086e",
            "url": "https://crm-nightly-new-fileservice.s3.amazonaws.com/solutions/50672/59d9976a-c4d2-42b0-8193-63a42866.png?X-Amz-Security-Token=FwoGZXIvYXdzEDoaDAbTUObgoVqaJRu7EiLSAXKgjReG65ZtsQrlTbr91u%2Frd1fdxnWdz212KMGOEcxs2nExLcoPD426bpSz%2FOAYf0YBDLERxaCSj%2BiBhMHbPUnpm8k6iGUo17quKssUpQyw19spw5K%2BK0j6l5GUwGoKQS8Vh1w1UA3oy3eT4tEecylpLPh7YwmLCggL6eUan3xWFLN8mAwQDej7KXu0D71Ygay2gnh8fDG4Hn7To%2F%2BEyl9Cd9R7gvlEw%2BrNQuPjSRAcd4ZhKHp7BqzTmO%2Fyk4zXhG92LrOr7r9SGg3iahCm4FgbGiiiqbG3BjItRaS1oWd%2FnWD5cj37kPK2vXf%2Bvq3dAjYcPnwaUapcnWni5OmYBUpGMaeYi%2BF0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240919T164348Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNCPGTBCUM%2F20240919%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6ad9ce8a9e48c59cd97f20db89076ee9a598a0ec1033d20a77f62fcc73c3dda9",
            "isExternal": false
          },
          {
            "name": "createRewardImage17265662870002Video",
            "url": "https://www.youtube.com/watch?v=a_aSgmOqgrA&feature=youtu.be",
            "isExternal": true
          }
        ]
      }
    ],
    "vendorDetails": {
      "id": 138,
      "name": "Capillary_1"
    },
    "vendorRedemptionDetails": {
      "id": 7930,
      "name": "VENDOR REDEMPTION-Postman_Test-2"
    },
    "paymentModes": [
      {
        "id": 845,
        "paymentMode": "CONV_RATIO",
        "conv_ratio": 0.35
      }
    ]
  },
  "loyaltyEventId": null
}

Card

Card updated event (cardUpdated)

{
  "eventId": "20384d37-3c03-4269-83c3-8f8585d8dd06",
  "eventType": "cardUpdated",
  "consumerGroupId": null,
  "actionType": "START ",
  "timeStamp": 1683874852870,
  "attributes": {
    "createdAt": 1683874852857,
    "data": {
      "cardNumber": "event0000000000010210card",
      "previousStatusLabel": "ACTIVE",
      "currentStatusLabel": " SUSPENDED",
      "currentExtendedFields": [
        {
          "name": "limit_set_by",
          "value": "name_event0000000000010210card"
        },
        {
          "name": "card_requested_by",
          "value": "ADMIN"
        },
        {
          "name": "card_balance ",
          "value": "10.9"
        }
      ],
      "previousExtendedFields": [
        
      ],
      "currentCustomFields": [
        {
          "name": "card_custom_fields_3",
          "value": "test3"
        },
        {
          "name": "card_custom_fields_1",
          "value": "test1"
        },
        {
          "name": "card_custom_fields_2",
          "value": "test2"
        }
      ],
      "previousCustomFields": [
        
      ]
    },
    "eventName": "cardUpdated",
    "refId": "150060_1482979",
    "apiRequestId": "db7191805a6375e51cb0443 19f378178",
    "orgId": 150060
  }
}

Request updated

Transaction request update

{
  "eventId": "0f5d96e4-f6ff-4a8a-8522-083dc0d2d0e5",
  "eventType": "requestUpdated",
  "consumerGroupId": null,
  "actionType": "START",
  "timeStamp": 1683879070938,
  "attributes": {
    "createdAt": 1683879070934,
    "data": {
      "requestType": "TRANSACTION",
      "requestBaseType": "REGULAR_TXN_ADD",
      "requestTrackingId": 10585,
      "status": "REJECTED",
      "comments": "Receipt is missing information",
      "updatedAt": 1683879070915,
      "updatedBy": {
        "user": {
          "username": "1675438912_"
        },
        "id": 441
      },
      "customerIdentifiers": {
        "customerId": 16971,
        "instore": {
          "email": "[email protected]",
          "externalId": "602f0c3c-e8e3-4b7f-9b18-0b7f3448a418"
        }
      },
      "updatedFields": [
        {
          "fieldName": "status",
          "previousVal ue": "PENDING",
          "currentValue": "REJECTED"
        }
      ],
      "associatedEntityFields": [
        
      ]
    },
    "eventName": "requestUpdated",
    "refId": "2000003_10585",
    "apiRequestId": "eb93e66d-5efa-44f7-9f47-ffcd1 a91dd78",
    "orgId": 2000003
  }
}

PII deletion request update

"eventName": "requestUpdated",
	"eventId": "48b6ad35-6232-45bf-bf41-deb77065b9e3",
	"orgId": 781,
	"createdAt": 1663690031667,
	"requestTrackingId": "7676878",
	"requestType": "CUSTOMER",
	"requestBaseType": "DELETE",
	"comments": "any request related comments",
	"status": "APPROVED",
	"customerId": 4545332,
	"data": {
		"requestId": "id",
		"createdBy": {
			"id": 15000375,
			"till": {
				"code": "kn.003",
				"name": "kn.003"
			},
			"store": {
				"code": "sskn1111",
				"name": "KNIGHT_STORE_QA",
				"externalId": "er4543",
				"externalId1": "fef343",
				"externalId2": "fef3434"
			}
		},
		"updatedFields": [{
			"fieldName": "status",
			"previousValue": "PENDING",
			"currentValue": "APPROVED"
		}]
	}
}

Loyalty

Loyalty Customer Merge Event (LoyaltyCustomerMerge)

{
  "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
}


Milestone (Targets) & Streaks

This section contains the schemas of various milestones (aka 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:

  1. Target Achieved Value Updated event
  2. Target Value Updated event
  3. Target Value Achieved event
  4. Target period start
  5. Target period end
  6. Unified target achieved
  7. Unified target un-achieved
  8. Target enrollment
  9. Streak level achievement
  10. Streak level unachievement
  11. Streak enrolment
  12. Streak unenrolment
  13. Streak start
  14. Streak end

Target Achieved Value Updated event

{
  "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

{
  "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

Target Value Update Event

Unified Target Achieved Event

{
  "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

{
  "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/"
  }
}

Streak level achievement


{
    "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

adding eventType streakLevelUnAchieved orgId 50282 event 

{
    "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

{
  "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

{
  "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

{
    "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

{
    "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.
Following example shows the value in the notification:

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.

Badges

Event notifications on earning a badge (when a badge is issued to the customer)

{
    "eventName": "badgeEarned",
    "eventId": "72fe1900-a413-42d6-9582-f955474739aa",
    "orgId": 50933,
    "refId": "50933_651bb7bac983d041efbc78fc",
    "apiRequestId": "e4397e00-de8d-4a54-b86b-affe305406cb",
    "createdAt": 1696315322593,
    "data": {
        "customerIdentifiers": {
            "customerId": 381921157,
            "loyaltyType": "loyalty",
            "instore": {
                "mobile": "918811992995",
                "email": "[email protected]",
                "externalId": "5a1111cfc5e3239dc0b92cc410cb28"
            }
        },
        "badgeId": "650c0896aefcde237f3dba43",
        "earnId": "651bb7bac983d041efbc78fc",
        "earnedOn": 1696315322450,
        "earnConstraints": [
            {
                "constraintLevel": "BADGE",
                "constraintType": "OVERALL",
                "maxEarnLimit": 1000,
                "currentEarnCount": 5
            },
            {
                "constraintLevel": "BADGE",
                "constraintType": "ROLLING_WINDOW",
                "rollType": "DAYS",
                "rollValue": 7,
                "maxEarnLimit": 300,
                "currentEarnCount": 2
            },
            {
                "constraintLevel": "CUSTOMER",
                "constraintType": "ROLLING_WINDOW",
                "rollType": "DAYS",
                "rollValue": 5,
                "maxEarnLimit": 50,
                "currentEarnCount": 2
            },
            {
                "constraintLevel": "CUSTOMER",
                "constraintType": "ROLLING_WINDOW",
                "rollType": "WEEKS",
                "rollValue": 1,
                "maxEarnLimit": 100,
                "currentEarnCount": 2
            },
            {
                "constraintLevel": "CUSTOMER",
                "constraintType": "ROLLING_WINDOW",
                "rollType": "MONTHS",
                "rollValue": 1,
                "maxEarnLimit": 200,
                "currentEarnCount": 5
            },
            {
                "constraintLevel": "CUSTOMER",
                "constraintType": "NONE"
            }
        ],
        "triggeringActivity": {
            "identifiers": [],
            "enteredBy": {
                "id": 50660494,
                "till": {
                    "code": "shubham.test123",
                    "name": "shubham.test123"
                }
            },
            "additionalAttributes": []
        }
    },
    "loyaltyEventId": null
}

Advanced request workflow

Points redemption

{
  "eventName": "requestWorkflowEvent",
  "eventId": "c5315714-90b0-4aaf-9a5c-19be8190edf3",
  "orgId": 0,
  "refId": "0_2083b025-c1d5-11ee-9641-7277dba3c6a7",
  "apiRequestId": "953d1022f6a80fef82d7c6d9f9133d63",
  "createdAt": 1706883171069,
  "data": {
    "requestId": "2083b025-c1d5-11ee-9641-7277dba3c6a7",
    "requestType": "POINTS_REDEMPTION",
    "requesterId": 232134,
    "currentRequestState": "AdminTask",
    "updateTime": 1706883171068,
    "requestAttributes": {
      "queryParams": {
        "skip_validation": "true",
        "format": "json"
      },
      "body": {
        "root": {
          "redeem": {
            "points_redeemed": "100",
            "customer": {
              "mobile": "9877792149"
            },
            "redemption_time": "2020-04-15 23:01:46",
            "transaction_number": "numbr893421972122280",
            "notes": "Redemption by SMS",
            "external_reference_number": "ACR-58392150333121"
          }
        }
      }
    }
  },
  "loyaltyEventId": null
}


{
  "eventName": "requestWorkflowEvent",
  "eventId": "76a767ab-ba43-4ff8-b2bd-ce7c042430ed",
  "orgId": 0,
  "refId": "0_2c8e9324-c1d5-11ee-9641-7277dba3c6a7",
  "apiRequestId": "775cefae5c4efa9b4fa9561f24a8f3a1",
  "createdAt": 1706883639869,
  "data": {
    "requestId": "2c8e9324-c1d5-11ee-9641-7277dba3c6a7",
    "requestType": "POINTS_REDEMPTION",
    "requesterId": 232134,
    "checkerId": 233253,
    "currentRequestState": "failed",
    "previousRequestState": "AdminTask",
    "updateTime": 1706883639868,
    "comment": "approving the points redemption request",
    "requestAttributes": {
      "queryParams": {
        "skip_validation": "true",
        "format": "json"
      },
      "body": {
        "root": {
          "redeem": {
            "points_redeemed": "100",
            "customer": {
              "mobile": "9877792149"
            },
            "redemption_time": "2020-04-15 23:01:46",
            "transaction_number": "numbr893421972122280",
            "notes": "Redemption by SMS",
            "external_reference_number": "ACR-58392150333121"
          }
        }
      }
    }
  },
  "loyaltyEventId": null
}

{
  "eventName": "requestWorkflowEvent",
  "eventId": "d6a4ef60-ce52-43d7-b6dd-4b883874123f",
  "orgId": 0,
  "refId": "0_96b672f3-c1d8-11ee-9641-7277dba3c6a7",
  "apiRequestId": "1f0757ac485fc453f031e40a2f46f7a6",
  "createdAt": 1706884672170,
  "data": {
    "requestId": "96b672f3-c1d8-11ee-9641-7277dba3c6a7",
    "requestType": "POINTS_REDEMPTION",
    "requesterId": 232134,
    "checkerId": 233253,
    "currentRequestState": "approved",
    "previousRequestState": "AdminTask",
    "updateTime": 1706884672170,
    "comment": "approving the points redemption request",
    "requestAttributes": {
      "queryParams": {
        "skip_validation": "true",
        "format": "json"
      },
      "body": {
        "root": {
          "redeem": {
            "points_redeemed": "100",
            "customer": {
              "mobile": "9877792149"
            },
            "redemption_time": "2020-04-15 23:01:46",
            "transaction_number": "numbr893421972122280",
            "notes": "Redemption by SMS",
            "external_reference_number": "ACR-58392150333121wdewdwe"
          }
        }
      }
    }
  },
  "loyaltyEventId": null
}

{
  "eventName": "requestWorkflowEvent",
  "eventId": "acb5d13c-d422-443d-982e-731b3e709f98",
  "orgId": 0,
  "refId": "0_d1f9ff8c-c1d9-11ee-9641-7277dba3c6a7",
  "apiRequestId": "78ddcc06934107da509e3d3ab1c05f3e",
  "createdAt": 1706885234777,
  "data": {
    "requestId": "d1f9ff8c-c1d9-11ee-9641-7277dba3c6a7",
    "requestType": "POINTS_REDEMPTION",
    "requesterId": 232134,
    "checkerId": 233253,
    "currentRequestState": "rejected",
    "previousRequestState": "AdminTask",
    "updateTime": 1706885234777,
    "comment": "rejecting the points redemption request",
    "requestAttributes": {
      "queryParams": {
        "skip_validation": "true",
        "format": "json"
      },
      "body": {
        "root": {
          "redeem": {
            "points_redeemed": "100",
            "customer": {
              "mobile": "9877792149"
            },
            "redemption_time": "2020-04-15 23:01:46",
            "transaction_number": "numbr893421972122280",
            "notes": "Redemption by SMS",
            "external_reference_number": "ACR-58392150333121"
          }
        }
      }
    }
  },
  "loyaltyEventId": null
}

Customer Status change

{
  "eventName": "requestWorkflowEvent",
  "eventId": "0df1a81f-b716-4ec0-b456-7ab5242c5ec8",
  "orgId": 0,
  "refId": "0_22e9f5f7-c1df-11ee-9641-7277dba3c6a7",
  "apiRequestId": "05be0e1bdf206764081e384573ada0dd",
  "createdAt": 1706887460576,
  "data": {
    "requestId": "22e9f5f7-c1df-11ee-9641-7277dba3c6a7",
    "requestType": "CUSTOMER_STATUS_CHANGE",
    "requesterId": 232134,
    "currentRequestState": "AdminTask",
    "updateTime": 1706887460576,
    "reason": "testing",
    "requestAttributes": {
      "queryParams": {
        "source": "INSTORE",
        "accountId": "",
        "use_async": "false",
        "identifierName": "mobile",
        "identifierValue": "919591399244"
      },
      "body": {
        "reason": "testing",
        "label": "Suspended"
      }
    }
  },
  "loyaltyEventId": null
}

{
  "eventName": "requestWorkflowEvent",
  "eventId": "11fe28ab-5d4c-478a-906f-03fe7d7b25c6",
  "orgId": 0,
  "refId": "0_22e9f5f7-c1df-11ee-9641-7277dba3c6a7",
  "apiRequestId": "07acef640bdeb5534263cc0ddec1c9dd",
  "createdAt": 1706955529408,
  "data": {
    "requestId": "22e9f5f7-c1df-11ee-9641-7277dba3c6a7",
    "requestType": "CUSTOMER_STATUS_CHANGE",
    "requesterId": 232134,
    "currentRequestState": "failed",
    "previousRequestState": "AdminTask",
    "updateTime": 1706955529407,
    "comment": "approving the customer status request",
    "requestAttributes": {
      "queryParams": {
        "source": "INSTORE",
        "accountId": "",
        "use_async": "false",
        "identifierName": "mobile",
        "identifierValue": "919591399244"
      },
      "body": {
        "reason": "testing",
        "label": "Suspended"
      }
    }
  },
  "loyaltyEventId": null
}

{
  "eventName": "requestWorkflowEvent",
  "eventId": "468a8fa7-f03e-4b7b-86b7-91eda4420af6",
  "orgId": 0,
  "refId": "0_75cedb31-c27f-11ee-bc64-7667ffaf5419",
  "apiRequestId": "cfaf3850903f4f041fb4e5d12fdc6308",
  "createdAt": 1706956350430,
  "data": {
    "requestId": "75cedb31-c27f-11ee-bc64-7667ffaf5419",
    "requestType": "CUSTOMER_STATUS_CHANGE",
    "requesterId": 232134,
    "currentRequestState": "approved",
    "previousRequestState": "AdminTask",
    "updateTime": 1706956350430,
    "comment": "approving the customer status request",
    "requestAttributes": {
      "queryParams": {
        "source": "INSTORE",
        "accountId": "",
        "use_async": "false",
        "identifierName": "mobile",
        "identifierValue": "919591399244"
      },
      "body": {
        "reason": "testing",
        "label": "bb"
      }
    }
  },
  "loyaltyEventId": null
}

Goodwill point request

{
  "eventName": "requestWorkflowEvent",
  "eventId": "bbc13325-7b79-4bb7-b57f-4791db6f3871",
  "orgId": 0,
  "refId": "0_f8a9bdd1-c280-11ee-bc64-7667ffaf5419",
  "apiRequestId": "e420fbacbe32b4d2db758282ebdeae4f",
  "createdAt": 1706956970545,
  "data": {
    "requestId": "f8a9bdd1-c280-11ee-bc64-7667ffaf5419",
    "requestType": "GOODWILL_POINTS",
    "requesterId": 232134,
    "currentRequestState": "AdminTask",
    "updateTime": 1706956970545,
    "requestAttributes": {
      "body": {
        "referenceId": "ref_id_12993141722",
        "reason": "reason",
        "baseType": "POINTS",
        "programId": 2739,
        "awardingTillId": 50682616,
        "earningEntityType": "CUSTOMER",
        "earningEntityId": 382332518,
        "points": 20,
        "source": "API"
      }
    }
  },
  "loyaltyEventId": null
}

{
  "eventName": "requestWorkflowEvent",
  "eventId": "d2540d72-f62c-400e-ad2a-422e8c00f187",
  "orgId": 0,
  "refId": "0_f8a9bdd1-c280-11ee-bc64-7667ffaf5419",
  "apiRequestId": "3e55d72e08aa213da99ec29fcf218298",
  "createdAt": 1706957216875,
  "data": {
    "requestId": "f8a9bdd1-c280-11ee-bc64-7667ffaf5419",
    "requestType": "GOODWILL_POINTS",
    "requesterId": 232134,
    "checkerId": 233253,
    "currentRequestState": "approved",
    "previousRequestState": "AdminTask",
    "updateTime": 1706957216875,
    "comment": "approving the goodwill points request",
    "requestAttributes": {
      "body": {
        "referenceId": "ref_id_12993141722",
        "reason": "reason",
        "baseType": "POINTS",
        "programId": 2739,
        "awardingTillId": 50682616,
        "earningEntityType": "CUSTOMER",
        "earningEntityId": 382332518,
        "points": 20,
        "source": "API"
      }
    }
  },
  "loyaltyEventId": null
}

Earn badge (Issue badge to customer)

{
  "eventName": "requestWorkflowEvent",
  "eventId": "32274496-3f73-483f-9743-2ab03ed74ecf",
  "orgId": 0,
  "refId": "0_57934965-c295-11ee-9c77-3ae88acc3158",
  "apiRequestId": "0155afd1c3a2bd55f76edbe636a84a13",
  "createdAt": 1706965718307,
  "data": {
    "requestId": "57934965-c295-11ee-9c77-3ae88acc3158",
    "requestType": "EARN_BADGE",
    "requesterId": 232134,
    "currentRequestState": "AdminTask",
    "updateTime": 1706965718306,
    "requestAttributes": {
      "body": {
        "triggeredBy": {
          "ownerType": "Goodwill_Module",
          "referenceId": "123"
        },
        "customerId": 382477526,
        "requestId": "0f77333928-9878-441c-a78e-c1d2334q",
        "badgeMetaId": "65be200710126e55359f1969"
      }
    }
  },
  "loyaltyEventId": null
}


{
  "eventName": "requestWorkflowEvent",
  "eventId": "7597f468-ebfc-4151-8b7a-6e5b2c3ef974",
  "orgId": 0,
  "refId": "0_57934965-c295-11ee-9c77-3ae88acc3158",
  "apiRequestId": "1f5c11d9c793311c2ac79333f0f147e6",
  "createdAt": 1706965813316,
  "data": {
    "requestId": "57934965-c295-11ee-9c77-3ae88acc3158",
    "requestType": "EARN_BADGE",
    "requesterId": 232134,
    "checkerId": 233253,
    "currentRequestState": "failed",
    "previousRequestState": "AdminTask",
    "updateTime": 1706965813316,
    "comment": "approving the earn badge request",
    "requestAttributes": {
      "body": {
        "triggeredBy": {
          "ownerType": "Goodwill_Module",
          "referenceId": "123"
        },
        "customerId": 382477526,
        "requestId": "0f77333928-9878-441c-a78e-c1d2334q",
        "badgeMetaId": "65be200710126e55359f1969"
      }
    }
  },
  "loyaltyEventId": null
}

Issue badge (Enrol customers to badge)

{
  "eventName": "requestWorkflowEvent",
  "eventId": "390a6575-cb60-4164-bd5d-2e06a421f3ba",
  "orgId": 0,
  "refId": "0_a24df7cd-c2bd-11ee-9cc2-bea6cdcb6ac2",
  "apiRequestId": "c6edd0830ecf4f9f80705b314f11043b",
  "createdAt": 1706983022684,
  "data": {
    "requestId": "a24df7cd-c2bd-11ee-9cc2-bea6cdcb6ac2",
    "requestType": "ISSUE_BADGE",
    "requesterId": 232134,
    "currentRequestState": "AdminTask",
    "updateTime": 1706983022684,
    "requestAttributes": {
      "body": {
        "triggeredBy": {
          "ownerType": "Goodwill_Module",
          "referenceId": "134"
        },
        "customers": [
          113460811
        ],
        "requestId": "e5811requestd62c5ec7d115a2859228cefd8ee8cgh",
        "badgeMetaId": "65be3c4d10126e55359f196a"
      }
    }
  },
  "loyaltyEventId": null
}




{
  "eventName": "requestWorkflowEvent",
  "eventId": "45bb68bc-29a4-4009-9337-72a7784fe189",
  "orgId": 0,
  "refId": "0_a24df7cd-c2bd-11ee-9cc2-bea6cdcb6ac2",
  "apiRequestId": "43e862ea6239afe41d8f1afbed35d32a",
  "createdAt": 1706983256871,
  "data": {
    "requestId": "a24df7cd-c2bd-11ee-9cc2-bea6cdcb6ac2",
    "requestType": "ISSUE_BADGE",
    "requesterId": 232134,
    "checkerId": 233253,
    "currentRequestState": "approved",
    "previousRequestState": "AdminTask",
    "updateTime": 1706983256871,
    "comment": "approving the issue badge request",
    "requestAttributes": {
      "body": {
        "triggeredBy": {
          "ownerType": "Goodwill_Module",
          "referenceId": "134"
        },
        "customers": [
          113460811
        ],
        "requestId": "e5811requestd62c5ec7d115a2859228cefd8ee8cgh",
        "badgeMetaId": "65be3c4d10126e55359f196a"
      }
    }
  },
  "loyaltyEventId": null
}

Alternate currencies

Alternate currencies issued

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
        eventName: alternateCurrenciesIssued
        loyaltyEventId: 1c1716568b10135aa4e59fda77935ea2014b3bfc
        orgId: 51182
        refId: 51182_1c1716568b10135aa4e59fda77935ea2014b3bfc
           
    }

Issued Alternate Currency Reversed

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,
                promotionAlternateCurrencies100,
                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
        eventName: issuedalternateCurrenciesReversed
        loyaltyEventId: 1c1716568b10135aa4e59fda77935ea2014b3bfc
        orgId: 51182
        refId: 51182_1c1716568b10135aa4e59fda77935ea2014b3bfc
           
    }

Loyalty Promotion

Issued loyalty promotion (promotionIssued)

{
    "eventName": "promotionIssued",
    "data": {
        "customerIdentifiers": {
            "customerId": 423817587,
            "instore": {
                "mobile": "919191920700",
                "email": "[email protected]",
                "cardNumbers": []
            }
        },
        "loyaltyProgramId": 2751,
        "promotionId": 200281,
        "promotionName": "Promo_L",
        "promotionStartDate": "2024-07-01",
        "promotionEndDate": "2024-08-31",
        "promotionIssuedDate": "2024-08-06",
        "promotionIssuedExpiryDate": "2024-08-31",
        "promotionDescription": "Promo_L",
        "customFields": [],
        "issueRestrictions": [
            {
                "limitOn": "CUSTOMER",
                "kpi": "MAX_NUMBER_OF_ISSUALS_PER_CUSTOMER",
                "maxLimit": 100
            }
        ],
        "redemptionRestrictions": [
            {
                "limitOn": "",
                "kpi": "MAX_REDEMPTIONS_PER_EARN_PER_CUSTOMER",
                "restrictionType": "NON_PERIOD_BASED",
                "maxLimit": 3
            }
        ],
        "issualId": 229
    },
    "orgId": 4000070,
    "refId": "4000070_aB8DFsImX7",
    "apiRequestId": "a4849fdcaffd0df64c2d6acbc91ec49b",
    "createdAt": 1722943950142
}

Earned loyalty promotion (promotionEarned)

{
    "eventName": "promotionEarned",
    "data": {
        "customerIdentifiers": {
            "customerId": 387337123,
            "instore": {
                "mobile": "919191920700",
                "email": "[email protected]",
                "cardNumbers": []
            }
        },
        "loyaltyProgramId": 2845,
        "promotionId": 1133570767,
        "promotionName": "Promo_Loyalty_Earn",
        "promotionStartDate": "2024-07-01",
        "promotionEndDate": "2024-08-31",
        "promotionEarnedDate": "2024-08-06",
        "promotionEarnedExpiryDate": "2024-08-31",
        "promotionDescription": "Promo_Loyalty_Earn",
        "customFields": [],
        "issualId": 2901,
        "earnedId": 2522,
        "earnRestrictions": [
            {
                "limitOn": "CUSTOMER",
                "kpi": "MAX_NUMBER_OF_EARNS_PER_CUSTOMER",
                "maxLimit": 3
            },
            {
                "limitOn": "CUSTOMER",
                "kpi": "MAX_POINTS_PER_EARN_PER_CUSTOMER",
                "maxLimit": -1
            }
        ],
        "redemptionRestrictions": [
            {
                "limitOn": "",
                "kpi": "MAX_REDEMPTIONS_PER_EARN_PER_CUSTOMER",
                "restrictionType": "NON_PERIOD_BASED",
                "maxLimit": 3
            }
        ]
    },
    "orgId": 51538,
    "refId": "51538_X07F0IEo6o",
    "apiRequestId": "b39b47ff9f6dd8cd7c2181a6cc7b12f3",
    "createdAt": 1722944534772
}

Revoke issued loyalty promotion (revokeIssuedPromotion)

{
    "eventName": "revokeIssuedPromotion",
    "data": {
        "customerIdentifiers": {
            "customerId": 387337123,
            "instore": {
                "mobile": "919191920700",
                "email": "[email protected]",
                "cardNumbers": []
            }
        },
        "loyaltyProgramId": 2845,
        "promotionId": 1133570767,
        "promotionName": "Promo_Loyalty_Earn",
        "promotionStartDate": "2024-07-01",
        "promotionEndDate": "2024-08-31",
        "promotionIssuedDate": "2024-08-06",
        "promotionIssuedExpiryDate": "2024-08-31",
        "promotionDescription": "Promo_Loyalty_Earn",
        "customFields": [],
        "issueRestrictions": [
            {
                "limitOn": "CUSTOMER",
                "kpi": "MAX_NUMBER_OF_ISSUALS_PER_CUSTOMER",
                "maxLimit": 3
            }
        ],
        "redemptionRestrictions": [
            {
                "limitOn": "",
                "kpi": "MAX_REDEMPTIONS_PER_EARN_PER_CUSTOMER",
                "restrictionType": "NON_PERIOD_BASED",
                "maxLimit": 3
            }
        ],
        "revokedIssualId": 2901
    },
    "orgId": 51538,
    "refId": "51538_V2KxxB3KKb",
    "apiRequestId": "c3560c2840c9254785bf98d7a9de6e1d",
    "createdAt": 1722945100073
}

Revoke earned loyalty promotion (revokeEarnedPromotion)

{
    "eventName": "revokeEarnedPromotion",
    "data": {
        "customerIdentifiers": {
            "customerId": 387337123,
            "instore": {
                "mobile": "919191920700",
                "email": "[email protected]",
                "cardNumbers": []
            }
        },
        "loyaltyProgramId": 2845,
        "promotionId": 1133570767,
        "promotionName": "Promo_Loyalty_Earn",
        "promotionStartDate": "2024-07-01",
        "promotionEndDate": "2024-08-31",
        "promotionDescription": "Promo_Loyalty_Earn",
        "customFields": [],
        "revokedEarnedPromotionDetails": [
            {
                "revokedEarnedId": 2523,
                "promotionEarnedDate": "2024-08-06",
                "promotionEarnedExpiryDate": "2024-08-31"
            }
        ],
        "earnRestrictions": [
            {
                "limitOn": "CUSTOMER",
                "kpi": "MAX_NUMBER_OF_EARNS_PER_CUSTOMER",
                "maxLimit": 3
            },
            {
                "limitOn": "CUSTOMER",
                "kpi": "MAX_POINTS_PER_EARN_PER_CUSTOMER",
                "maxLimit": -1
            }
        ],
        "redemptionRestrictions": [
            {
                "limitOn": "",
                "kpi": "MAX_REDEMPTIONS_PER_EARN_PER_CUSTOMER",
                "restrictionType": "NON_PERIOD_BASED",
                "maxLimit": 3
            }
        ]
    },
    "orgId": 51538,
    "refId": "51538_LEpXJt8Vd9",
    "apiRequestId": "025f37887d8814414da0b7e3fcb5d88e",
    "createdAt": 1722945241191
}