Balance expiration reminder triggered

Topic: v1/customer/balanceExpirationReminderTriggered

This webhook is triggered when it is time to remind a customer that their points are about to expire, based on the store's "remind N days before expiration" settings. It does not send a reminder itself — it signals that the reminder moment has arrived so you can notify the customer in your own way.

Payload example:

{
    "timestamp": "2024-05-27T06:34:39.662Z",
    "customer": {
        "email": "customer@gmail.com",
        "phone": null,
        "shopifyCustomerId": 5784483037269
    },
    "currentBalance": 2000.5,
    "expirationDate": "2026-08-13T06:59:25.353Z",
    "reminderType": "warning"
}

Documentation table

Properties

timestampstring: Timestamp when the reminder was triggered in ISO 8601 format.
customerobject: Customer identifier details.
currentBalancenumber: Current balance of the customer that is about to expire.
expirationDatestring: Date when the customer's points expire, in ISO 8601 format. Use it to compute the exact number of days left until expiration.
reminderTypestring: Which reminder was triggered. One of warning (first reminder) or lastChance (final reminder).

The timestamp remains unchanged when Growave retries to resend it.

Documentation table​

Properties

Documentation table