From 089a90c253306e0e666d36b30286e0171d0dc833 Mon Sep 17 00:00:00 2001 From: MaciekVoucherify <130568368+MaciekVoucherify@users.noreply.github.com> Date: Tue, 19 May 2026 17:33:38 +0200 Subject: [PATCH] reward-redeemed --- .../customer/reward-redemptions-completed.mdx | 2 +- documentation/api-reference/customer/rewarded.mdx | 2 +- .../api-reference/distribution-webhooks.mdx | 14 ++++++++++++-- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/documentation/api-reference/customer/reward-redemptions-completed.mdx b/documentation/api-reference/customer/reward-redemptions-completed.mdx index ff4b376ef..a3a293b3b 100644 --- a/documentation/api-reference/customer/reward-redemptions-completed.mdx +++ b/documentation/api-reference/customer/reward-redemptions-completed.mdx @@ -5,7 +5,7 @@ openapi: "/openapi-events/events-customer.json webhook EVENTS.CUSTOMER.REWARD_RE keywords: ['reward', 'redemption', 'complete'] --- -The `EVENTS.CUSTOMER.REWARD_REDEMPTIONS.COMPLETED` event indicates that redemption of a reward has been completed. +The `EVENTS.CUSTOMER.REWARD_REDEMPTIONS.COMPLETED` event indicates that a customer completed a reward redemption. If this event is sent as a notification in a Loyalty campaign, it is also sent with the `publication` object. diff --git a/documentation/api-reference/customer/rewarded.mdx b/documentation/api-reference/customer/rewarded.mdx index 7fa3d2ee7..16527ef00 100644 --- a/documentation/api-reference/customer/rewarded.mdx +++ b/documentation/api-reference/customer/rewarded.mdx @@ -7,6 +7,6 @@ keywords: ['customer', 'reward'] The `EVENTS.CUSTOMER.REWARDED` event indicates that a customer received a reward in exchange for points in a loyalty campaign. The action is usually a manual process started by the customer. -This event is used in a webhook configured in Distributions in Voucherify dashboard. +This event is used by the **Reward redeemed** trigger in Distributions in the Voucherify dashboard. This page documents only the event. If you need more details about the webhook payload data that includes this event, go to [Introduction to webhooks](/api-reference/introduction-to-webhooks "Introduction to webhooks v2024-01-01") page. \ No newline at end of file diff --git a/documentation/api-reference/distribution-webhooks.mdx b/documentation/api-reference/distribution-webhooks.mdx index 1f4c8411a..dc5f7f314 100644 --- a/documentation/api-reference/distribution-webhooks.mdx +++ b/documentation/api-reference/distribution-webhooks.mdx @@ -119,6 +119,12 @@ To re-enable a paused webhook: 2. Click the distribution that has been paused. 3. Click the set live icon in the upper right corner. + +The **Reward redeemed** trigger supports the `customer.rewarded` webhook event payload. + +The event is triggered after a customer redeems a loyalty reward. The payload may include digital rewards, material rewards, voucher rewards, and redemption details. + + ## Webhooks available in Distributions These webhooks are triggered by the events which cause distribution. @@ -148,7 +154,7 @@ The table below shows which distributions support webhooks: | Voucher | Loyalty pending points canceled | ❌ | ❌ | ✅ | | Voucher | Voucher redeemed | ❌ | ❌ | ✅ | | Voucher | Voucher redemption rolled back | ❌ | ❌ | ✅ | -| Customer rewards | Reward redemption | ❌ | ❌ | ✅ | +| Customer rewards | Reward redeemed | ❌ | ❌ | ✅ | | Manual messages | One or bulk messages | ✅ | ✅ | ❌ | | Publishing codes | Successfully published | ❌ | ❌ | ✅ | | Custom events | Custom event | ✅ | ✅ | ✅ | @@ -197,7 +203,9 @@ The table below shows which distributions support webhooks: * [Voucher redemption rolled back](/api-reference/customer/redemption-rollback-succeeded "Voucher redemption rolled back event documentation") * Customer rewards: - * [Reward redeemed](/api-reference/customer/rewarded "Customer rewarded documentation") + * [Reward redeemed](/api-reference/customer/reward-redemptions-completed) + +The **Reward redeemed** trigger supports the `customer.rewarded` webhook event payload. * Loyalty tier related activities: @@ -228,6 +236,8 @@ The following campaigns can also trigger webhook send outs as a distribution: ### Distribution webhook payload +Distribution webhooks use the payload structure of the event that triggered the distribution. + The list shows a general structure of a webhook payload set in Distributions. Indented bullet points mean that an object contains further properties or objects.