Managing loyalty notifications
Loyalty notifications allow you to be informed about the status of the loyalty points of your loyalty program. Notifications are available only for profile-based loyalty programs and are sent as webhooks.
To learn about the other notification types, see Managing Application notifications.
Notification types
For any given profile-based loyalty program, you can create and manage notifications of the following types:
Notification type | Description |
---|---|
Added or deducted points | 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 | 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 | 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. |
Creating a loyalty notification
You can create notifications for each of your profile-based 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.
In Notification name, type a name for the notification.
For added or 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:
In the Schedule section, specify how long before the points' expiration date you want to trigger alerts:
- Amount: The number of days or weeks.
- Period: Days before expiration date or Weeks before expiration date.
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, review the request payload.
noteSee the notification schemas.
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.