Partner Program

A partner program in Capillary is a type of loyalty program that is created and managed outside the Capillary platform, typically by an external brand or partner.

Partner Program Linked (partnerProgramLinked)

Notifies when a user is linked to a partner program.

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

Notifies when a partner program is updated.

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

Notifies when a partner program linked to a user's loyalty program is removed.

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

Notifies when a a supplementary membership linked to a loyalty program is about to expire. A supplementary loyalty program is a smaller program that operates alongside primary loyalty programs but runs for a shorter duration.

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