Skip to main content
This webhook is triggered when customer’s points are close to expiring. To subscribe to this webhook, your access token needs to contain the read_customers scope.
This webhook is triggered only when your point expiration feature is enabled

​
Payload

​
customer
object
required
Customer object with the same shape as the Customers API response
​
expire_points_at
string
required
ISO 8601 timestamp of the customer’s approaching point expiration
​
points_to_expire
number | null
required
The number of customer points that are approaching expiration
​
earned_on
string | null
required
ISO 8601 timestamp of when the expiring points were acquired

​
Example

Example

{
  "id": "bff1bddb-6cd8-4c2c-9619-18744657053c",
  "topic": "program_events/customer.approaching_points_expiration",
  "created_at": "2018-01-01T03:00:05.000Z",
  "payload": {
    "id": "332d90cd-1ba1-4a7b-abd1-79e643b4b89f",
    "created_at": "2018-01-01T03:00:05.000Z",
    "kind": "customer.approaching_points_expiration",
    "unique_until": nil,
    "properties": {
        "expire_points_at": "2024-01-01T03:00:05.000Z",
        "points_to_expire": 136,
        "earned_on": "2023-01-01T03:00:05.000Z"
        "customer": {
            "id": 6932,
        "merchant_id": "2134606599",
        "email": "jessica@example.com",
        "points_approved": 200,
        "points_pending": 300,
        "points_spent": 500,
        "rewards_claimed": 5,
        "rewards_used": 0,
        "properties": {
          "name": "Jessica White"
        },
        "metadata": {},
        "birthday": "1990-01-29",
        "blocked": false,
        "guest": false,
        "enrolled": true,
        "enrolled_at": "2015-12-10T03:00:00.000Z",
        "referral_id": "a4e",
        "referred_by": {
          "id": 3958,
          "merchant_id": "192838592"
        },
        "loyalty_tier_membership": {
          "started_at": "2017-03-03 00:00:00Z",
          "expires_at": null,
          "manual": false,
          "loyalty_tier": {
            "id": 16,
            "name": "Silver",
            "position": 2,
            "default": false,
            "hidden": false,
            "lower_bound": "200.01",
            "upper_bound": "400.00"
          }
        },
        "tier_eligibility": {
          "kind": "points",
          "valid_until": null,
          "tier_points": {
            "now": 250,
            "at_expiration": null
          },
          "points_needed_for_renewal": null,
          "points_needed_for_upgrade": 150,
          "upgrade_tier": {
            "id": 17,
            "name": "Gold",
            "threshold": 400
          },
          "forecasted_tier": null
        },
        "insights_segment": "Loyal",
        "referral_url": "https://prz.io/KzByQ2Fa",
        "created_at": "2016-12-10T03:00:00.000Z",
        "updated_at": "2018-01-01T03:00:00.000Z"
      },
    }
  }
}