Skip to main content

Managing loyalty notifications

Loyalty notifications allow you to be informed of the status of the loyalty points and tiers of your loyalty program. Updates 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 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 typeAvailabilityDescription
Added/deducted points
Real-time		Profile-based loyalty programsBe 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 programsBe 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
Card-based loyalty programs

Be notified of expiring loyalty points through scheduled triggers.

For each notification you create, you can add up to 3 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 programsBe 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 programsBe 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 programsBe 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.

note
  • With Real-time notifications, it can take up to 10 minutes to send updates after a qualifying event occurs.
  • By default, in notifications where batching is possible, up to 1000 updates are batched and sent as a single update to optimize the use of hardware resources.
Retry policy

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 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:

  1. In Loyalty, select the loyalty program for which you want to create a notification.

  2. On the left-side menu of the loyalty program, click Notifications.

  3. Click Create Notification.

  4. In the Create Notification drawer, select the type of notification to create.

    tip

    Tier upgrade, Tier downgrade, and Upcoming tier downgrade are nested inside Tier-related changes.

  5. In Notification name, type a name for the notification.

  6. 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.

  7. 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.
    note

    On the scheduled trigger day, updates are sent at 00:00 hours UTC.

  8. For Pending points only:

    note

    These 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.

  9. 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.

  10. In the Payload preview section:

    • For Expiring points only: Choose whether updates should be batched.
    • Review the request payload. See the notification schemas.

  11. (Optional) To validate the URL and headers you entered by sending a test request, click Test Notification.

  12. 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:

  1. On the left-side menu of the loyalty program, click Notifications.
  2. To the right of the notification, toggle Active.
  3. In the confirmation window, click Deactivate Notification.
note

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:

  1. On the left-side menu of the loyalty program where you want to edit a notification, click Notifications.
  2. Next to the notification you want to edit, click .
  3. Edit the required details.
  4. 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:

  1. On the left-side menu of the loyalty program where you want to delete a notification, click Notifications.
  2. Next to the notification you want to delete, click .
  3. In the pop-up that appears, click Delete Notification.