This webhook is triggered when a customer claims a custom reward which has had a fulfilment webhook URL configured.

You cannot subscribe to this webhook topic via the LoyaltyLion API. Instead, the webhook is managed automatically by LoyaltyLion. To change the webhook URL, update the custom reward in your LoyaltyLion admin.

When you respond to this webhook with a successful response (a 2xx status code), we’ll consider this particular redemption to have been successful

​
Payload

​
test
boolean
required

Indicates if this is a test webhook. A webhook with this value set to true will be sent when you create or update a custom reward, to confirm that the URL is valid and your server is responding

​
reward_id
number
required

The LoyaltyLion ID of the reward that was redeemed

​
reward_identifier
string
required

The custom reward identifier set by you when creating the reward

​
customer_id
number
required

The LoyaltyLion ID of the customer redeeming this reward

​
customer_merchant_id
number
required

The ID of the customer in your platform or ecommerce store

​
customer_email
number
required

The email address of the customer redeeming this reward

​
Example

Example
{
  "test": false,
  "reward_id": 6,
  "reward_identifier": "surprise-gift-next-order",
  "customer_id": 5,
  "customer_merchant_id": "2075071365",
  "customer_email": "jesca.blue@example.com"
}