Hooks API

DeliverCustomReward1

Notifies that a custom reward has been unlocked by a customer.

Method	POST
Kind	Mutation Hook
URL	The webhook URL you specify, with `:name` replaced by `DeliverCustomReward1`
Authentication	JWT HS256 Bearer token

Custom rewards is an advanced feature enabled by Bubblehouse upon request. We will help you set it up.

Input

reward_identifierstringrequired
The reward identifier you have configured. To Bubblehouse, this is an opaque string.
reward_titlestringrequired
The title of the reward in question.
unlock_timetimerequired
Time when the customer got access to this reward.
customerCustomerIdentity1optional
The customer who has unlocked the reward.

Output

deliveredbooleanrequired
Whether you succeeded in delivering this reward to the user. Pass false to cause a refund and raise a failure.
messagestringoptional
An optional message to show to the user. Depending on the delivered flag, this will be an error message or a success message.
notesstringoptional
Extra non-public information to record, visible to the staff.

Specific Errors

Status	Error	Reason & Examples
None.

API-wide Errors

Status	Error	Reason & Examples
None.

Global Errors

Status	Error	Reason & Examples
None.

Previous: CreateDiscount4
Next: NoteCustomerUpdates1