Hooks API

Web Hook

DeliverCustomReward1

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_identifier string required

    The reward identifier you have configured. To Bubblehouse, this is an opaque string.

  • reward_title string required

    The title of the reward in question.

  • unlock_time time required

    Time when the customer got access to this reward.

  • customer CustomerIdentity1 optional

    The customer who has unlocked the reward.

Output

  • delivered boolean required

    Whether you succeeded in delivering this reward to the user. Pass false to cause a refund and raise a failure.

  • message string optional

    An optional message to show to the user. Depending on the delivered flag, this will be an error message or a success message.

  • notes string optional

    Extra non-public information to record, visible to the staff.

Previous
CreateDiscount4