Event notification

Event Notifications is a framework that provides near real-time data of events generated in the Capillary System and helps brands subscribe to notifications about particular events.

Overview

Event Notification allows building integrations with Capillary events that originate either through Capillary API (such as customerAdded and transactionAdded)requests or Capillary products such as Loyalty+ (such as pointsIssued and pointsRedeemed), Engage+ or other. Once an event notification is configured, brands can build custom solutions to trigger for pre-configured actions.
Event Notifications are sent through Webhooks configured in Capillary Event Notifications. The following is the top-level diagram, of the Events Notification framework (ENS).

Use Cases

There are several use cases of event notifications. A couple of examples are provided in the following.

• Enable PII-less Communication

In some cases, brands prefer not to send customers' personally identifiable information (PII data) such as names, email ID, and mobile number to Capillary and manage communication completely at their end. Event Notification can be used to get the events that require communication such as customer registration, transaction, points issual, points redemption, points transfer, etc. On receiving these events, clients can send communication to customers with their names and identifiers as needed.

• Integration with 3rd Party Applications

Event notification can be used to build integrations with 3rd party applications. For example, send a survey link to a customer post transaction event from a survey application such as Medallia; sync customer’s loyalty information to an e-commerce platform such as Magento. Integration can be built to receive real-time events, enrich information using Capillary APIs (if required), and sync it to the 3rd party application using the brand's APIs.

Steps involved in ENS set up

The following are the steps involved in the set up of the Event Notification Service (ENS) for a client.

• Webhook creation

Webhooks let you create an integration URL that is required to post events data from ENS to Webhook. Before starting with the configuration process, you need to create a Webhook account and generate a URL. The URL is further used to post events generated by the client (This can be done by creating an API proxy for API Gateway such as Apigee).

• Event Notification Configuration

Once you have the Webhook URL, you need to subscribe to the events that need to be notified. This can be done either through UI or API. For more details, see Add Event Notification

• Event Consumption

Once the setup is completed, the client can consume and process events data and use the data to configure actions to trigger. For more details see, Consuming event notification

At present notification the following event notifcations can be configured:

• rewardIssued: Notification that a reward has been issued to a customer.
• streakCustomerUnEnrolment: Notification that a customer has been unenrolled from a streak program.
• issueRewardFailure: Notification that there was a failure in issuing a reward.
• notInterestedBillAdded: Notification that a bill has been added under the 'not interested' category.
• groupUpdated: Notification that a customer group has been updated.
• promisedToCurrentPointsConversion: Notification of the conversion of promised points to current points.
• pointsTransferredReceived: Notification that points transferred have been received by a customer.
• groupCreated: Notification that a new customer group has been created.
• partnerProgramUpdated: Notification that a partner program has been updated.
• pointsIssued: Notification that points have been issued to a customer.
• supplementaryMembershipExpiryReminder: Reminder that a supplementary membership is about to expire.
• targetCustomerEnrolment: Notification that a customer has been enrolled in a target program.
• unifiedTargetsUnAchieved: Notification that unified targets have not been achieved.
• partnerProgramDelinked: Notification that a partner program has been delinked.
• badgeEarned: Notification that a customer has earned a badge.
• cartPromotionIssued: Notification that a cart promotion has been issued.
• rewardCreated: Notification that a reward has been created.
• manualPointsAdjustment: Notification that there has been a manual adjustment to points.
• redeemedPointsReversed: Notification that redeemed points have been reversed.
• cartPromotionEarned: Notification that a cart promotion has been earned.
• tierDowngraded: Notification that a customer has been downgraded to a lower tier.
• pointsTransferredInitiated: Notification that a points transfer has been initiated.
• tierUpgraded: Notification that a customer has been upgraded to a higher tier.
• loyaltyCustomerMerge: Notification that loyalty accounts have been merged.
• partnerProgramLinked: Notification that a partner program has been linked.
• requestUpdated: Notification that a request has been updated.
• promotionIssued: Notification that a promotion has been issued.
• targetPeriodStarted: Notification that a target period has started.
• pointsExpiryChange: Notification that the points expiry date has changed.
• pointsExpired: Notification that points have expired.
• unifiedTargetsAchieved: Notification that unified targets have been achieved.
• rewardUpdated: Notification that a reward has been updated.
• transactionUpdated: Notification that a transaction has been updated.
• customerAdded: Notification that a new customer has been added.
• groupMemberRemoved: Notification that a member has been removed from a group.
• targetValueAchieved: Notification that a target value has been achieved.
• singlePointsExpiryUpdated: Notification that the expiry date of single points has been updated.
• alternateCurrenciesIssued: Notification that alternate currencies have been issued.
• transactionRejected: Notification that a transaction has been rejected.
• tierDowngradeReminder: Reminder that a customer is about to be downgraded to a lower tier.
• issuedPointsReversed: Notification that issued points have been reversed.
• groupMemberAdded: Notification that a member has been added to a group.
• pointsContributionToGroup: Notification that points have been contributed to a group.
• streakLevelUnAchieved: Notification that a streak level has not been achieved.
• CouponRedeem: Notification that a coupon has been redeemed.
• promotionEarned: Notification that a promotion has been earned.
• retroBillAdded: Notification that a retro bill has been added.
• pointsExpiryReminder: Reminder that points are about to expire.
• pointsRedeemed: Notification that points have been redeemed.
• cartPromotionRevoked: Notification that a cart promotion has been revoked.
• transactionAdded: Notification that a new transaction has been added.
• rejectedTransactionRetrigger: Notification that a rejected transaction has been retriggered.
• streakCustomerEnrolment: Notification that a customer has been enrolled in a streak program.
• CouponIssue: Notification that a coupon has been issued.
• IssueBulkCoupon: Notification that bulk coupons have been issued by specifying the count under a series.
• tierRenewed: Notification that a customer’s tier has been renewed.
• streakLevelAchieved: Notification that a streak level has been achieved.
• cardUpdated: Notification that a card has been updated.
• targetAchievedValueUpdated: Notification that the achieved value of a target has been updated.
• cartPromotionRedeemed: Notification that a cart promotion has been redeemed.
• targetValueUpdated: Notification that the value of a target has been updated.
• customerUpdated: Notification that customer details have been updated.
• issuedAlternateCurrenciesReversed: Notification that issued alternate currencies have been reversed.
• requestWorkflowEvent: Notification of an event in the request workflow.
• targetPeriodCompleted: Notification that a target period has been completed.