API reference
- Introduction
- Authentication
- Pagination
Resources
- Customers
- Activities
- Transactions
- Orders
- Emails
- Webhooks
Webhooks
- Introduction
- Webhook events
- customers/update
- loyalty_emails/unsubscribe
- rewards/store_fulfilment
- program_events/customer.enrolled
- program_events/customer.tier_upgraded
- program_events/customer.tier_downgraded
- program_events/customer.reward_available_notification
- program_events/customer.recurring_reward_available_reminder
- program_events/customer.claimed_reward
- program_events/customer.points_earned
- program_events/customer.referral_complete
- program_events/customer.rule_completed
- program_events/customer.approaching_tier_upgrade
- program_events/customer.moved_to_defected_segment
- program_events/customer.moved_to_loyal_segment
- program_events/customer.moved_to_at_risk_segment
program_events/customer.tier_upgraded
This webhook is triggered when a customer moves up a tier.
To subscribe to this webhook, your access token needs to contain the
read_customers scope.
This webhook is not triggered when a customer moves into their first tier
Payload
Customer object with the same shape as the Customers API response
1The lower bound of the tier. For spend-based tiers, this will be a decimal value, e.g. a lower bound of $100 will be 100.00
For point-based tiers, this value will be divided by 100. To get the correct value for the bound, multiply it by 100. For example, if the lower bound of the tier is 5000, the value returned will be 50.00
The upper bound of the tier. For spend-based tiers, this will be a decimal value, e.g. a lower bound of $100 will be 100.00
For point-based tiers, this value will be divided by 100. To get the correct value for the bound, multiply it by 100. For example, if the lower bound of the tier is 5000, the value returned will be 50.00
This will be null if there is no upper bound for the tier.
1The lower bound of the tier. For spend-based tiers, this will be a decimal value, e.g. a lower bound of $100 will be 100.00
For point-based tiers, this value will be divided by 100. To get the correct value for the bound, multiply it by 100. For example, if the lower bound of the tier is 5000, the value returned will be 50.00
The upper bound of the tier. For spend-based tiers, this will be a decimal value, e.g. a lower bound of $100 will be 100.00
For point-based tiers, this value will be divided by 100. To get the correct value for the bound, multiply it by 100. For example, if the lower bound of the tier is 5000, the value returned will be 50.00
This will be null if there is no upper bound for the tier.
Example
{
"id": "bff1bddb-6cd8-4c2c-9619-18744657053c",
"topic": "program_events/customer.tier_upgraded",
"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.tier_upgraded",
"unique_until": nil,
"properties": {
"customer": {
"id": 6932,
"merchant_id": "2134606599",
"email": "jessica@example.com",
"points_approved": 200,
"points_pending": 300,
"points_spent": 500,
"rewards_claimed": 5,
"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"
}
},
"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"
},
"previous_tier": {
"id": 15,
"name": "Bronze",
"number": 1,
"default": true,
"hidden": false,
"lower_bound": "0.00",
"upper_bound": "200.00"
},
"new_tier": {
"id": 16,
"name": "Silver",
"number": 2,
"default": false,
"hidden": false,
"lower_bound": "200.01",
"upper_bound": "400.00"
}
}
}
}