Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.loyaltylion.com/llms.txt

Use this file to discover all available pages before exploring further.

This webhook is fired when a customer is close to moving up a tier. The constraint (i.e. how close a customer should be to the next tier before this webhook is sent) can be configured in your LoyaltyLion admin. To subscribe to this webhook, your access token needs to contain the read_customers scope.
This webhook has a 7 day cool-down period per individual customer

​
Payload

​
customer
object
required
Customer object with the same shape as the Customers API response
​
current_tier
object
required
The loyalty tier the customer is currently in
​
next_tier
object
required
The next tier the customer is approaching
​
points_required
number | null
required
If tiers are points-based, the number of points required to reach the next tier
​
spend_required
number | null
required
If tiers are spend-based, the spend required to reach the next tier

​
Example

Example
{
  "id": "bff1bddb-6cd8-4c2c-9619-18744657053c",
  "topic": "program_events/customer.approaching_tier_upgrade",
  "created_at": "2018-01-01T03:00:05.000Z",
  "payload": {
    "properties": {
      "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": 15,
            "name": "Bronze",
            "position": 1,
            "default": true,
            "hidden": false,
            "lower_bound": "0.00",
            "upper_bound": "200.00"
          }
        },
        "tier_eligibility": {
          "kind": "points",
          "valid_until": null,
          "tier_points": {
            "now": 180,
            "at_expiration": null
          },
          "points_needed_for_renewal": null,
          "points_needed_for_upgrade": 20,
          "upgrade_tier": {
            "id": 16,
            "name": "Silver",
            "threshold": 200
          },
          "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"
      },
      "next_tier": {
        "id": 16,
        "name": "Silver",
        "number": 2,
        "default": false,
        "hidden": false,
        "lower_bound": "200.01",
        "upper_bound": "400.00"
      },
      "current_tier": {
        "id": 15,
        "name": "Bronze",
        "number": 1,
        "default": true,
        "hidden": false,
        "lower_bound": "0.00",
        "upper_bound": "200.00"
      }
    }
  }
}