Skip to content

reward-redeemed #1257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MaciekVoucherify wants to merge 1 commit into
base: master
Choose a base branch
from
Open

reward-redeemed #1257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/api-reference/customer/reward-redemptions-completed.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion documentation/api-reference/customer/rewarded.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Note>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.</Note>
14 changes: 12 additions & 2 deletions documentation/api-reference/distribution-webhooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Note>
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.
</Note>

## Webhooks available in Distributions

These webhooks are triggered by the events which cause distribution.
Expand Down Expand Up @@ -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 | ✅ | ✅ | ✅ |
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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.

<Note>
Expand Down
Loading