Skip to content

Commit c88d0e2

Browse files
weronika-kurczynaweronika-kurczyna
authored
Merge pull request #1 from rspective/voucherify/source
Voucherify source docs
2 parents ffc2bff + 4131ab4 commit c88d0e2

File tree

1 file changed

+131
-4
lines changed
  • src/connections/sources/catalog/cloud-apps/voucherify

1 file changed

+131
-4
lines changed

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

+131-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,131 @@
1-
---
2-
title: 'Voucherify Source'
3-
hidden: true
4-
---
1+
## title: Voucherify Source
2+
3+
[Voucherify](https://voucherify.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is an API-first Promotion Engine for growth teams. With Voucherify, marketers can run dynamic and personalized promotions and loyalty programs without the involvement of the development team. Run CDP-powered coupons, discounts, referrals, loyalty programs, gift cards, cashback, bundles, and more.
4+
The integration is bidirectional; therefore, Voucherify can be configured as both the Destination and Source of customer data.
5+
6+
This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations.
7+
8+
This source is maintained by Voucherify. For any issues with the source, [contact their Support team](mailto:[email protected]).
9+
10+
_**NOTE:** The Voucherify Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on <Month_Name DD, YYYY>. If you are interested in joining their beta program or have any feedback to help improve the Voucherify Source and its documentation, [let their team know](mailto:[email protected])!_
11+
12+
## Getting Started
13+
14+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
15+
2. Search for "Voucherify" in the Sources Catalog, select Voucherify, and click **Add Source**.
16+
3. On the next screen, give the Source a nickname configure any other settings.
17+
18+
- The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments.
19+
4. Click **Add Source** to save your settings.
20+
5. Copy the Write key from the Segment UI and log in to your Voucherify account.
21+
6. To finish the setup, go to Project Settings > Integrations > Segment.io -> Connect, enter the Write Key and confirm.
22+
23+
## Stream
24+
25+
Voucherify uses our 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).
26+
27+
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+
29+
## Events
30+
Integrating by adding Voucherify as a Source to Segment supports the following events to be sent out of the box:
31+
- Redemption events (successful, failed, rolled back).
32+
- Validation events (only if connected with a customer).
33+
- Customer reward events.
34+
35+
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.
36+
37+
Redemption events:
38+
39+
<table>
40+
<tr>
41+
<td>Redemption succeeded</td>
42+
<td>Triggered when a redemption is successfully completed by a customer (successful use of a voucher to receive a discount or other reward).</td>
43+
</tr>
44+
<tr>
45+
<td>Redemption failed</td>
46+
<td>Triggered when a redemption attempt fails due to an issue with the voucher or customer.</td>
47+
</tr>
48+
<tr>
49+
<td>Redemption rollback succeeded</td>
50+
<td>Triggered when a redemption is successfully rolled back, which means removal of the voucher and reversal of any associated discount or reward.</td>
51+
</tr>
52+
<tr>
53+
<td>Redemption rollback failed</td>
54+
<td>Triggered when an attempt to rollback the redemption fails. </td>
55+
</tr>
56+
</table>
57+
58+
Customer rewarded events:
59+
60+
<table>
61+
<tr>
62+
<td>Customer creates a reward redemption request</td>
63+
<td>Triggered when a customer redeems a reward in Voucherify account.</td>
64+
</tr>
65+
<tr>
66+
<td>Customer reward redemption completed</td>
67+
<td>Triggered when a customer's redemption request is completed (customer received the reward).</td>
68+
</tr>
69+
<tr>
70+
<td>Reward redemption created</td>
71+
<td>Triggered when a reward redemption is created.</td>
72+
</tr>
73+
<tr>
74+
<td>Reward redemption completed</td>
75+
<td>Triggered when a reward redemption is successfuly completed.</td>
76+
</tr>
77+
<tr>
78+
<td>Customer rewarded</td>
79+
<td>Triggered when a customer is rewarded with a main reward.</td>
80+
</tr>
81+
<tr>
82+
<td>Customer rewarded with loyalty points</td>
83+
<td>Triggered when a customer is rewarded with loyalty points.</td>
84+
</tr>
85+
<tr>
86+
</table>
87+
88+
Validation events:
89+
90+
<table>
91+
<tr>
92+
<td>Validation succeeded</td>
93+
<td>Triggered when a customer's validation is completed (customer entered valid code).</td>
94+
</tr>
95+
<tr>
96+
<td>Validation failed</td>
97+
<td>Triggered when a customer's validation fails.</td>
98+
</tr>
99+
</table>
100+
101+
Publication events:
102+
103+
<table>
104+
<tr>
105+
<td>Publication succeeded</td>
106+
<td>Triggered when a publication (assigning a code to particular customer) is completed.</td>
107+
</tr>
108+
<tr>
109+
<td>Publication failed</td>
110+
<td>Triggered when a publication (assigning a code to particular customer) fails.</td>
111+
</tr>
112+
</table>
113+
114+
## Event Properties
115+
116+
The table below lists the properties included in the events listed above.
117+
118+
<table>
119+
<tr>
120+
<td>voucherifyEvent</td>
121+
<td>The entire event object that occurred in Voucherify.</td>
122+
</tr>
123+
</table>
124+
125+
## Adding Destinations
126+
127+
Now that your Source is set up, you can connect it with Destinations.
128+
129+
Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](https://segment.com/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
130+
131+
If there are any issues with how the events are arriving to Segment, [contact the Voucherify support team](mailto:[email protected]).

0 commit comments

Comments
 (0)