Managing loyalty notifications
Loyalty notifications allow you to be informed of the status of the loyalty points and tiers of your loyalty program. Requests from the notifications you create 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 and receive requests, 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. note This notification does not include imported loyalty points. |
Pending points Scheduled | Profile-based loyalty programs | Be notified of pending points in your loyalty program that are becoming active. note Requests of this notification type are not sent for deleted customers. |
Expiring points Scheduled | Profile-based loyalty programs | Be notified of expiring loyalty points through scheduled triggers. For each notification you create, you can add up to three triggers, each with a different alert time before points expiration. important You can create only one notification of this type. |
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
|
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
|
Upcoming tier downgrade Scheduled | Profile-based loyalty programs | Be notified of upcoming downgrades to loyalty tiers. You can add up to three scheduled notification triggers, each at a different alert time before the downgrade date. important
|
- With Real-time notifications, it can take up to 10 minutes to send requests after a qualifying event occurs.
When an update cannot be sent because of server errors (5xx
response codes) or
429 Too Many Requests
, resend attempts are made for a maximum of 10 minutes
with more time passing between each attempt.
See Notification Schemas
Notification batching
For notifications where batching is possible, the data for up to 1000 qualifying events is batched into a single request by default to optimize the use of hardware resources.
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 only:
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 only:
In the Schedule section, specify how long before these events you want to trigger alerts:
- Amount: Number of days or weeks.
- Period: Days or weeks.
noteOn the scheduled trigger day, requests are sent at 00:00 hours UTC.
-
For Pending points only:
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.
- (Optional) 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:
- If the Batching option is available, choose whether you want to leave it enabled or disable it.
- Review the request payload. See 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 requests 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.
- Next to 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 requests from that notification. To stop receiving requests 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.
- Next to the notification you want to delete, click .
- In the pop-up that appears, click Delete Notification.