Managing loyalty notifications
Loyalty notifications allow you to be informed of the status of the loyalty points and tiers of your loyalty program. Notification updates are sent as webhooks.
To learn about Application notifications, see Managing Application notifications.
Notification types
A notification type represents a qualifying loyalty program-related event for which you can create a notification to receive updates, for example, loyalty points that are expiring soon.
Depending on the notification type, you can create notifications in loyalty programs that are profile-based or card-based. You can create and manage notifications of the following types:
Notification type | Availability | Description |
---|---|---|
Added/deducted points Real-time | Profile-based loyalty programs | Be notified of changes to the points balance of your loyalty programs in real time, whether they happen through the Campaign Manager, Management API, or the Rule Engine. important You can create only one notification of this type. |
Pending points Scheduled | Profile-based loyalty programs | Be notified of pending points in your loyalty program that are becoming active. note Updates of this notification type are not sent for deleted customers. |
Expiring points Scheduled | Profile-based loyalty programs | Be notified of expiring loyalty points. For each notification you create, you can add up to 3 triggers, each at a different alert time before the points' expiration date. |
Tier upgrade Real-time | Profile-based loyalty programs | Be notified of upgrades to loyalty tiers in real time for loyalty programs where the loyalty tiers are defined. important You can create only one notification of this type. |
Tier downgrade Real-time | Profile-based loyalty programs | Be notified of downgrades to loyalty tiers in real time for loyalty programs where the loyalty tiers are defined. important You can create only one notification of this type. |
Upcoming tier downgrade Scheduled | Profile-based loyalty programs | Be notified of upcoming downgrades to loyalty tiers. You can add up to 3 scheduled notification triggers, each at a different alert time before the downgrade date. important You can create only one notification of this type. |
- With Real-time notifications, it can take up to 10 minutes to send updates after a qualifying event occurs.
- By default, up to 1000 updates are batched and sent as a single update to optimize the use of hardware resources.
When an update cannot be sent because of server errors (5xx
status codes),
resend attempts are made for a maximum of 5 hours
with more time passing between each attempt.
See Notification Schemas
Creating a loyalty notification
You can create notifications for each of your loyalty programs. When you create a notification, it is automatically activated.
To create a loyalty notification:
-
In Loyalty, select the loyalty program for which you want to create a notification.
-
On the left-side menu of the loyalty program, click Notifications.
-
Click Create Notification.
-
In the Create Notification drawer, select the type of notification to create.
tipTier upgrade, Tier downgrade, and Upcoming tier downgrade are nested inside Tier-related changes.
-
In Notification name, type a name for the notification.
-
For Added/deducted points:
In the Notification sources section, specify which sources should trigger a notification:
- All: Notify when loyalty points are added or deducted from all sources.
- Campaign Manager: Notify only when points are manually added or manually deducted in the customer profile.
- Management API: Notify only when one of the following endpoints is called:
- Rule Engine: Notify only when points are added or deducted as the result of a reward effect.
-
For Expiring points and Upcoming tier downgrade:
In the Schedule section, specify how many days and weeks ahead of time you want to trigger alerts:
- Amount: The number of days or weeks.
- Period: Days or Weeks.
noteOn the scheduled trigger day, these notifications are sent at 00:00 hours UTC.
tipTo add a trigger, click Add Trigger. To delete one, click .
-
For Pending points:
noteThese notifications are sent daily at 00:00 hours UTC only when there are loyalty points becoming active in the following 24 hours. You cannot change this schedule.
-
In the Request section, specify the details of the webhook request:
- Verb indicates the HTTP request method:
POST
. - In URL, type the URL where you want to receive notifications.
- In Header, type a custom header that describes the request.
- (Optional) Click Add header for each additional header value required by the receiving party, and enter the corresponding headers.
- Verb indicates the HTTP request method:
-
In the Payload preview section:
- For Expiring points: Choose whether notifications should be batched.
- Review the request payload.
noteSee the notification schemas.
-
(Optional) To validate the URL and headers you entered by sending a test request, click Test Notification.
-
Click Create Notification.
Deactivating a loyalty notification
To stop receiving updates from a loyalty notification, you can deactivate it. You can reactivate the notification at a later time.
To deactivate a loyalty notification:
- On the left-side menu of the loyalty program, click Notifications.
- To the right of the notification, toggle Active.
- In the confirmation window, click Deactivate Notification.
To reactivate a notification, follow the above steps, and in the confirmation window, click Activate Notification.
Editing a loyalty notification
Depending on the notification type, you can edit all or some of the details of a loyalty notification at any time.
To edit a loyalty notification:
- On the left-side menu of the loyalty program where you want to edit a notification, click Notifications.
- To the right of the notification you want to edit, click .
- Edit the required details.
- Click Save.
Deleting a loyalty notification
When you delete a loyalty notification, you also stop receiving loyalty updates from that notification. To stop receiving loyalty updates but retain the notification, consider deactivating the notification instead.
To delete a loyalty notification:
- On the left-side menu of the loyalty program where you want to delete a notification, click Notifications.
- To the right of the notification you want to edit, click .
- In the pop-up that appears, click Delete Notification.