Loyalty notifications
Loyalty notifications allow you to be informed of the status of the loyalty points and tiers of your loyalty program.
In a similar way to webhooks, notifications send requests to a URL of your choice with a predefined payload. To view the payload content, see the notification schemas.
Depending on the notification type, the following are possible:
- Requests are sent either in real time after a qualifying loyalty event occurs or based on a schedule before it occurs.
- You can configure the request payload size. A larger payload means fewer requests are sent, optimizing the use of hardware resources.
To learn about notifications for Applications, see 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.
You can create and manage notifications of the following types:
Added/deducted points Real-time
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. However, this does not include imported loyalty points.
You can create only one notification of this type in profile-based and card-based loyalty programs.
Request delivery
Requests are sent immediately after a qualifying event occurs.
Pending points Scheduled
Be notified of pending points in your loyalty program that are becoming active.
You can create one or more notifications of this type in profile-based loyalty programs. Requests are not sent for deleted customers.
Payload size
When you create a notification, you can configure the payload to contain up to 2000 objects per request.
Expiring points Scheduled
Be notified of expiring loyalty points through scheduled triggers. You can add up to three scheduled request triggers, each with a different alert time before points expiration.
Any points added after 00:00 UTC on the day before the expiration date are not included
in the request, regardless of when the request triggers are scheduled.
This means that the minimum schedule time is 1 day before expiration.
For example, for an expiration date of 26 March, only the points from before 25 March 00:00 UTC are included.
You can create only one notification of this type in profile-based and card-based loyalty programs.
Payload size
When you create a notification, you can configure the payload to contain up to 2000 objects per request.
Tier upgrade Real-time
Be notified of upgrades to loyalty tiers in real time for loyalty programs where the loyalty tiers are defined.
You can create one or more notifications of this type in profile-based loyalty programs with scheduled tier downgrade.
Request delivery
Requests are sent every 10 minutes.
Payload size
When you create a notification, you can configure the payload to contain up to 2000 objects per request.
Tier downgrade Real-time
Be notified of downgrades to loyalty tiers in real time for loyalty programs where the loyalty tiers are defined.
You can create only one notification of this type in profile-based loyalty programs with scheduled tier downgrade or without an absolute tier expiration date.
Request delivery
Requests are sent every 10 minutes.
Payload size
When you create a notification, you can configure the payload to contain up to 2000 objects per request.
Upcoming tier downgrade Scheduled
Be notified of upcoming downgrades to loyalty tiers. You can add up to three scheduled request triggers, each at a different alert time before the downgrade date.
You can create only one notification of this type in profile-based loyalty programs with scheduled tier downgrade or without an absolute tier expiration date.
Request delivery
Requests are sent every 10 minutes.
Payload size
When you create a notification, you can configure the payload to contain up to 2000 objects per request.
See Notification Schemas
Request logging and retry policy
All notification types have a response timeout of 10 seconds. Requests that time out are logged with no response code.
Progressively delayed resend attempts are made up to 10 times
or until a 2xx response is received, whichever occurs first. Resend attempts are made
when a notification request cannot be sent for the following reasons:
5xxresponse codes.429 Too Many Requestsresponse code.- There's no response at all.