Distribution webhooks

Distribution-based webhooks in Voucherify let your application automatically receive notifications related to distribution events. They help you track the results of distributions and quickly respond when certain actions occur. For example, your application can be notified when a voucher is successfully published, a scheduled campaign message is delivered, or when a customer enters or leaves a specific customer segment.

Configuring Distribution webhooks

1. In Voucherify dashboard, go to Distributions in the Engagement section.
2. Click Create distribution.
3. Select the appropriate trigger that creates a sendout.
4. In Action, define what kind of distribution action you want to create.
5. In Channels, add Webhook. You can add many channels within one distribution.
6. In the webhook channel, provide the event name, URL, and any optional HTTP headers.
7. Select the attributes to add them to the webhook payload. Optionally, map the attributes to your own keys.

To edit, pause, activate, or delete a distribution, click the three dots icon located on the far right of each row in the Distributions list view.

You can also add distribution webhooks while creating a loyalty or referral programs. The process follows similar pattern.

Re-enabling a webhook

To re-enable a paused webhook:

1. Go to the Distribution Manager.
2. Click the distribution that has been paused.
3. Click the set live icon in the upper right corner.

Webhooks available in Distributions

These webhooks are triggered by the events which cause distribution.

Some distribution events, for example Customer entered segment, have different purposes:

• Notify customers about promotion
• Send and publish unique codes from campaign
• Send plain message to customers

The table below shows which distributions support webhooks:

• Custom events:
  • Custom event
• Segment related activities:
  • Customer entered segment
  • Customer left segment
• Manual messages:
  • Notify customers about promotion – covered by the MANUAL_DISTRIBUTION_SCHEDULE event
  • Send and publish unique codes from a campaign – covered by the MANUAL_DISTRIBUTION_SCHEDULE event
  • Send a plain message to customers – does not support webhooks as a distribution channel
• Cart related activities:
  • Order updated
  • Order paid
  • Order created
  • Order canceled
• Publishing codes:
  • Successfully published
• Voucher related activities:
  • Gift credits added
  • Loyalty points added
  • Loyalty card points expired
  • Loyalty pending points added
  • Loyalty pending points updated
  • Loyalty pending points activated
  • Loyalty pending points canceled
  • Voucher redeemed
  • Voucher redemption rolled back
• Customer rewards:
  • Reward redeemed
• Loyalty tier related activities:
  • Customer entered loyalty tier structure
  • Customer left loyalty tier structure
  • Customer loyalty tier upgraded
  • Customer loyalty tier downgraded
  • Customer loyalty tier prolonged
  • Customer rewarded loyalty points
• Referral related activities:
  • Customer was referred

Loyalty and referral campaign Distributions

The following campaigns can also trigger webhook sendouts as a distribution:

• Loyalty campaigns:
  • Send loyalty program code
  • Loyalty points gained
  • Reward redeemed
• Referral campaigns:
  • Send referral code to the referrer
  • Customer referred (documentation in progress)

Distribution webhook payload