Hooks API
Web HookDeliverCustomReward1
Notifies that a custom reward has been unlocked by a customer.
| Kind | Mutation Hook |
|---|---|
| Method | POST |
| 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_identifierstring requiredThe reward identifier you have configured. To Bubblehouse, this is an opaque string.
-
reward_titlestring requiredThe title of the reward in question.
-
Time when the customer got access to this reward.
-
The customer who has unlocked the reward.
Output
-
deliveredboolean requiredWhether you succeeded in delivering this reward to the user. Pass false to cause a refund and raise a failure.
-
messagestring optionalAn optional message to show to the user. Depending on the delivered flag, this will be an error message or a success message.
-
notesstring optionalExtra non-public information to record, visible to the staff.