Endpoints
Events
- Introduction to Voucherify webhooks
- Project settings webhooks
- Distribution webhooks
- HOOKCreated
- HOOKUpdated
- HOOKDeleted
- HOOKRedemption Succeeded
- HOOKRedemption Rollback Succeeded
- HOOKRewarded
- HOOKRewarded Loyalty Points
- HOOKReward Redemptions Created
- HOOKReward Redemptions Pending
- HOOKReward Redemptions Completed
- HOOKVoucher Loyalty Card Pending Points Activated
- HOOKVoucher Loyalty Card Pending Points Added
- HOOKVoucher Loyalty Card Pending Points Canceled
- HOOKVoucher Loyalty Card Pending Points Updated
- HOOKVoucher Loyalty Card Points Added
- HOOKVoucher Loyalty Card Points Expired
- HOOKVoucher Gift Balance Added
- HOOKSegment Entered
- HOOKSegment Left
- HOOKLoyalty Tier Joined
- HOOKLoyalty Tier Upgraded
- HOOKLoyalty Tier Downgraded
- HOOKLoyalty Tier Prolonged
- HOOKLoyalty Tier Left
- HOOKHolder Assignment Created
- HOOKHolder Assignment Deleted
- HOOKOrder Created
- HOOKOrder Paid
- HOOKOrder Updated
- HOOKOrder Canceled
- HOOKPublication Succeeded
- HOOKCustom Event
- HOOK
EVENTS.CUSTOMER.UPDATED event indicates that a customer was successfully updated in Voucherify.
This event is used in a webhook configured in Project settings in Voucherify dashboard.
The following API endpoints can update customer data, but don’t trigger customer update webhooks:
- POST
v1/customers/metadata/async - POST
v1/customers/bulk/async - POST
v1/customers/importCSV
Body
Customer details with details about loyalty and referral programs.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Total number of the redemptions made by the customer.
Total number of the redemptions that failed.
Total number of the redemptions that succeeded.
Total number of the redemptions that were rolled back for the customer.
Total number of the redemption rollbacks that failed.
Total number of the redemption rollbacks that succeeded.
Summary of gift card credits.
Show child attributes
Show child attributes
Total amount of gift card credits redeemed by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Remaining gift card balance across all gift cards. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Summary of loyalty points.
Show child attributes
Show child attributes
The total amount spent by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Total number of orders made by the customer.
Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Amount spent on last order. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Timestamp representing the date and time of the customer's last order in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Show child attributes
Show child attributes
Customer's loyalty points.
Total number of customers referred by the customer.
Contains campaigns with details about point balances and how many customers were referred by the customer.
Show child attributes
Show child attributes
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
Show child attributes
Show child attributes
Remaining point balance in campaign.
Customer's loyalty tier within the campaign.
"ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x"
Number of customers referred by the customer in the campaign.
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Show child attributes
Show child attributes
Total number of times this customer received a referral, i.e. was referred by another customer.
Contains an array of campaigns that served as the source of a referral for the customer.
Show child attributes
Show child attributes
Unique identifier of the campaign assigned by Voucherify.
"camp_rRsfatlwN7unSeUIJDCYedal"
Unique referrer ID assigned by Voucherify. This is the customer ID of a customer that is referring this customer.
"cust_sehkNIi8Uq2qQuRqSr7xn4Zi"
Related object id
"r_0b9d4cc4aa164dd073"
Related object type, i.e. redemption.
Timestamp representing the date and time when the customer was referred in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by JSON.
customer Customer's first and last name.
An arbitrary string that you can attach to a customer object.
Customer's email address.
Customer's phone number. This parameter is mandatory for sending out codes to customers via an SMS channel.
Customer's birthdate; format YYYY-MM-DD.
A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer.
The ID of an existing customer that will be linked to the redemption in this request.
A unique identifier of the customer who validates a voucher.
Object used to store system metadata information.
Timestamp representing the date and time when the customer was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the customer was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Response
Webhook accepted
Was this page helpful?