program_events/customer.reward_available_notification - LoyaltyLion

This webhook is triggered when the customer has a new reward available. The available_rewards array contains rewards that are actionable, in stock, enabled and affordable by the customer. 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

As many customers redeem their points immediately after earning them, this webhook is only sent after a 5 minute delay. If after 5 minutes the customer has redeemed their points and no longer has any rewards available, the webhook will not be sent

Payload

object

required

Customer object with the same shape as the Customers API response

object[]

required

Array of Reward objects with the same shape as the List Available Rewards API response

Example

Example

{
  "id": "bff1bddb-6cd8-4c2c-9619-18744657053c",
  "topic": "program_events/customer.reward_available_notification",
  "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": 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"
      },
      "available_rewards": [
        {
          "id": 121013,
          "kind": "cart_discount_voucher",
          "title": "10% Off",
          "method": "voucher",
          "content": {},
          "site_id": 12,
          "claim_url": "https://email.storerewards.co/track/a3hvr8d1808pvlpvvryt/click?p=2290s8fopfnsd0E/sh7292ksdp0",
          "order_type": "all",
          "point_cost": 500,
          "description": null,
          "target_site": {
            "id": 12,
            "url": "https://www.example.com",
            "name": "Example Store"
          },
          "target_type": "all",
          "usage_limit": 1,
          "discount_type": "percentage",
          "minimum_spend": nil,
          "discount_amount": 100,
          "session_options": nil,
          "target_products": [],
          "max_free_shipping": nil,
          "target_collections": [],
          "max_redemption_amount": 1,
          "min_redemption_amount": 1
        }
      ]
    }
  }
}

⌘I