program_events/customer.claimed_reward

This webhook is triggered when a customer has claimed a reward. To subscribe to this webhook, your access token needs to contain the read_customers scope.

This webhook is currently only triggered for voucher and gift card rewards

Payload

object

required

Customer object with the same shape as the Customers API response

string

required

Title of the reward that was claimed

enum<string>

required

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

enum<string>

required

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

string | null

required

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

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 final four characters of the gift card applied. Only present if the claimed reward was a gift card

string | null

required

The currency of the gift card. Only present if the claimed reward was a gift card

integer | null

required

The initial balance of the gift card as a decimal value, e.g. $5 will be 5. Only present if the claimed reward was a gift card

integer | null

required

The current balance of the gift card as a decimal value, e.g. $5 will be 5. Only present if the claimed reward was a gift card

Example

{
  "id": "bff1bddb-6cd8-4c2c-9619-18744657053c",
  "topic": "program_events/customer.claimed_reward",
  "created_at": "2018-01-01T03:00:05.000Z",
  "payload": {
    "properties": {
      "title": "$5 voucher",
      "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": null,
        "referred_by": null,
        "loyalty_tier_membership": null,
        "tier_eligibility": null,
        "insights_segment": "Loyal",
        "referral_url": null,
        "created_at": "2016-12-10T03:00:00.000Z",
        "updated_at": "2018-01-01T03:00:00.000Z"
      },
      "reward_type": "voucher",
      "voucher_code": "LL-PQ8V63",
      "discount_type": "flat",
      "discount_amount": 20
    }
  }
}

Admin API

Resources

Webhooks

program_events/customer.claimed_reward

Payload

Example

​Payload

​Example

Payload

Example