Skip to content

Commit e915ff5

Browse files
weronika-kurczynamarkzegarelli
weronika-kurczyna
and
markzegarelli
authored
Voucherify Source catalog docs update. (#4796)
* Add more precise description of events * add information about source_id * Update src/connections/sources/catalog/cloud-apps/voucherify/index.md Co-authored-by: markzegarelli <[email protected]> --------- Co-authored-by: markzegarelli <[email protected]>
1 parent e910fd0 commit e915ff5

File tree

1 file changed

+33
-28
lines changed
  • src/connections/sources/catalog/cloud-apps/voucherify

1 file changed

+33
-28
lines changed

‎src/connections/sources/catalog/cloud-apps/voucherify/index.md‎

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -25,54 +25,59 @@ This source is maintained by Voucherify. For any issues with the source, [contac
2525

2626
Voucherify uses the stream Source component to send Segment event data. It uses a server-side `track` method to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. These events are also assigned to user accounts in the Segment Profiles (Unify).
2727

28-
The default behavior is for Voucherify to pass the `userId` associated with the customer. There are cases in which Voucherify does not have an associated `userId`, and then the customer will be associated with an `anonymousId`. 
28+
By default, Voucherify passes a customer's associated `userId` to Segment. Because Voucherify sends customer-triggered events only, `anonymousId` is not used. The Voucherify source doesn't send anonymous events to Segment. As a result, events that aren't assigned to or called by a customer are ignored. For mapping, `source_id` on Voucherify events becomes the `user_id` in Segment.
2929

3030
## Events
3131
Integrating by adding Voucherify as a Source to Segment supports the following events to be sent out of the box:
3232
- Redemption events (successful, failed, rolled back).
3333
- Validation events (only if connected with a customer).
34+
- Publication events.
3435
- Customer reward events.
3536

3637
Below are the events that Voucherify sends to Segment. These events appear as tables in your warehouse and as regular events in other Destinations. Voucherify includes the `userId` if available.
3738

3839
### Redemption events
39-
| Event | Description |
40-
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
41-
| Redemption succeeded | Triggered when a redemption is successfully completed by a customer (successful use of a voucher to receive a discount or other reward). |
42-
| Redemption failed | Triggered when a redemption attempt fails due to an issue with the voucher or customer. |
43-
| Redemption rollback succeeded | Triggered when a redemption is successfully rolled back, which means removal of the voucher and reversal of any associated discount or reward. |
44-
| Redemption rollback failed | Triggered when an attempt to rollback the redemption fails. |
40+
| Event | Description | Fields |
41+
|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
42+
| Customer Redemption Succeeded | Triggered when a redemption is successfully completed by a customer (successful use of a voucher to receive a discount or other reward). | order (object), promotion_tier (object), redemption (object), voucher (object), holder (object) |
43+
| Customer Redemption Failed | Triggered when a redemption attempt fails due to an issue with the voucher or customer. | order (object), promotion_tier (object), redemption (object), voucher (object), holder (object) |
44+
| Customer Redemption Rollback Succeeded | Triggered when a redemption is successfully rolled back, which means removal of the voucher and reversal of any associated discount or reward. | order (object), promotion_tier (object), redemption (object), redemption_rollback (object), voucher (object), holder (object) |
45+
| Customer Redemption Rollback Failed | Triggered when an attempt to roll back the redemption fails. | order (object), promotion_tier (object), redemption (object), redemption_rollback (object), voucher (object), holder (object) |
4546

4647
### Customer rewarded events
47-
48-
| Event | Description |
49-
| -------------------------------------------- | ------------------------------------------------------------------------------------------- |
50-
| Customer creates a reward redemption request | Triggered when a customer redeems a reward in Voucherify account. |
51-
| Customer reward redemption completed | Triggered when a customer's redemption request is completed (customer received the reward). |
52-
| Reward redemption created | Triggered when a reward redemption is created. |
53-
| Reward redemption completed | Triggered when a reward redemption is successfully completed. |
54-
| Customer rewarded | Triggered when a customer is rewarded with a main reward. |
55-
| Customer rewarded with loyalty points | Triggered when a customer is rewarded with loyalty points. |
56-
57-
48+
| Event | Description | Fields |
49+
|---------------------------------------|---------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
50+
| Customer Reward Redemptions Created | Triggered when a customer redeems a reward in Voucherify account. | reward (object), reward_assignment (object), reward_redemption (object), voucher (object), source (object), holder (object), balance |
51+
| Customer Reward Redemptions Completed | Triggered when a customer's redemption request is completed (customer received the reward). | reward (object), reward_assignment (object), reward_redemption (object), voucher (object), source (object), holder (object), balance |
52+
| Customer Rewarded | Triggered when a customer is rewarded with a main reward. | redemption (object), referral_tier (object), reward (object), voucher (object), holder (object), balance |
53+
| Customer Rewarded Loyalty Points | Triggered when a customer is rewarded with loyalty points. | earning_rule (object), loyalty_tier (object), order (object), voucher (object), holder (object), balance |
5854

5955
### Validation events
56+
| Event | Description | Fields |
57+
|-------------------------------|------------------------------------------------------------------------------------|---------------------|
58+
| Customer Validation Succeeded | Triggered when a customer's validation is completed (customer entered valid code). | validation (object) |
59+
| Customer Validation Failed | Triggered when a customer's validation fails. | validation (object) |
6060

61-
| Event | Description |
62-
| -------------------- | ---------------------------------------------------------------------------------- |
63-
| Validation succeeded | Triggered when a customer's validation is completed (customer entered valid code). |
64-
| Validation failed | Triggered when a customer's validation fails. |
65-
66-
Publication events:
61+
### Publication events
62+
| Event | Description | Fields |
63+
|--------------------------------|--------------------------------------------------------------------------------------|----------------------|
64+
| Customer Publication Succeeded | Triggered when a publication (assigning a code to particular customer) is completed. | publication (object) |
65+
| Customer Publication Failed | Triggered when a publication (assigning a code to particular customer) fails. | publication (object) |
6766

6867

6968
## Event Properties
7069

71-
The table below lists the properties included in the events listed above.
70+
The table below shows common properties for each event.
71+
72+
| Event | Description |
73+
|-----------|-------------------------------------------------------------------------------------------------------------------|
74+
| userId | The id used to identify the customer in Voucherify. It's the same id as the source_id in Voucherify. |
75+
| email | Customer's email. |
76+
| event | Event name. |
77+
| timestamp | Date and time the event occurred |
78+
| customer | Customer object. Contains fields such as: id, email, source_id and name. |
79+
| campaign | Campaign object. Contains fields such as: id, name, created_at, type, active. It may include voucher information. |
7280

73-
| Event | Description |
74-
| --------------- | ---------------------------------------------------- |
75-
| voucherifyEvent | The entire event object that occurred in Voucherify. |
7681
## Adding Destinations
7782

7883
Now that your Source is set up, you can connect it with Destinations.

0 commit comments

Comments
 (0)