program_events/customer.approaching_reward_expiration

This webhook is triggered when customer’s reward is close to expiring. To subscribe to this webhook, your access token needs to contain the read_customers scope.

Available only to Shopify merchants

This webhook is triggered only when your reward expiration feature is enabled

Payload

object

required

Customer object with the same shape as the Customers API response

string

required

Title of the reward that is to expire

enum<string>

required

The type of the expiring reward. One of: voucher or gift_card

object

required

The source informs how the reward was acquired. One of: customer_redemption or rule_completion or tier_benefit

string

required

ISO 8601 timestamp of the reward’s approaching expiration

enum<string>

required

The type of discount provided. One of: flat or percentage

number | null

required

The discount provided by the claimed reward as a decimal value, e.g. $5 will be 5. Only included if the reward type is voucher

string | null

required

The voucher (coupon) code linked to the claimed reward. Only included if the reward type is voucher

Example

{
  "id": "bff1bddb-6cd8-4c2c-9619-18744657053c",
  "topic": "program_events/customer.approaching_reward_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_reward_expiration",
    "unique_until": nil,
    "properties": {
        "title": "$5 voucher",
        "source": {
            "kind": "customer_redemption"
        },
        "expires_at": "2014-01-01T03:00:05.000Z",
        "reward_type": "voucher",
        "voucher_code": "LL-PQ8V63",
        "discount_type": "flat",
        "discount_amount": 20,
        "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"
      },
    }
  }
}

Admin API

Resources

Webhooks

program_events/customer.approaching_reward_expiration

Payload

Example

​Payload

​Example

Payload

Example