Skip to main content

Documentation Index

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

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

Fired when a customer successfully redeems points for a reward. At this point the points have been deducted and a discount code has been generated.

​
Payload fields

FieldTypeDescription
shopify_customer_idstringThe customer’s Shopify customer ID
emailstring | nullThe customer’s email address
points_redeemedintegerNumber of points spent on this redemption
points_balanceintegerThe customer’s remaining available points after this redemption
reward_namestringName of the reward that was redeemed
reward_idstring | nullInternal Mage Loyalty reward ID
discount_codestring | nullThe Shopify discount code generated for this redemption

​
Example payload

{
  "event": "points.redeemed",
  "shop": "my-store",
  "timestamp": "2026-02-18T12:00:00.000Z",
  "data": {
    "shopify_customer_id": "6789012345",
    "email": "jane@example.com",
    "points_redeemed": 500,
    "points_balance": 200,
    "reward_name": "$10 off",
    "reward_id": "clrew456def",
    "discount_code": "MAGE-A1B2C3"
  }
}

​
Common use cases

  • Send a follow-up email reminding the customer to use their discount code
  • Log redemptions in an external analytics or BI tool
  • Trigger a congratulatory push notification
  • Sync discount code data to a fulfilment or ERP system