Skip to content

Commit 9be31e7

Browse files
markzegarelliweronika-kurczynastayseesong
authored
Voucherify deploy PR (#4539)
* Create index.md * Update index.md * Update index.md * Update index.md * Update index.md * Update index.md * Update index.md * Update index.md * Update index.md * Update index.md * Update index.md * delete comments * update info about custom url, delete comments * Update index.md * updates * format * Apply suggestions from code review Co-authored-by: stayseesong <[email protected]> --------- Co-authored-by: weronika-kurczyna <[email protected]> Co-authored-by: stayseesong <[email protected]>
1 parent 46c1e29 commit 9be31e7

File tree

3 files changed

+118
-2
lines changed
  • .github/styles/Vocab/Docs
  • src/connections
    • destinations/catalog/voucherify-actions
    • sources/catalog/cloud-apps/voucherify

3 files changed

+118
-2
lines changed

‎.github/styles/Vocab/Docs/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ varchar
149149
Vero
150150
Vidora
151151
viewability
152+
Voucherify
152153
waitlist
153154
walkthrough
154155
WebKit

‎src/connections/destinations/catalog/voucherify-actions/index.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Voucherify (Actions) Destination
3+
private: true
4+
hidden: true
5+
id: 63f529a8af3478b5a5363c53
6+
---
7+
{% include content/plan-grid.md name="actions" %}
8+
9+
[Voucherify](https://voucherify.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} 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. The Destination integration provides a continuous flow of customer data from Segment to Voucherify to create custom events, create or update customers, and build audiences.
10+
11+
Voucherify maintains this destination. For any issues with the destination, [contact the Voucherify Support team](mailto:[email protected]).
12+
13+
## Benefits of Voucherify (Actions) vs Voucherify (Classic)
14+
15+
The Voucherify (Actions) destination is bidirectional, which means you can configure Voucherify as both the destination and source of your customer data. The Destination Actions framework improves on classic destinations by enabling you to see and control how Segment sends the event data it receives from your sources to actions-based destinations. Each Action in a destination lists the event data it requires and the event data that is optional. You can also choose which event types, event names, or event property values trigger an Action. These Triggers and mappings make it possible to send different versions of the Action, depending on the context from which it is triggered.
16+
17+
## Getting started
18+
19+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
20+
2. Find the Destinations Actions item in the left navigation, and click it.
21+
3. Select Voucherify (Actions) and then **Configure Voucherify (Actions)**.
22+
4. Select an existing Source to connect to Voucherify (Actions).
23+
5. Enter the **API Key** and **API Token** into your Segment Settings UI, which you can find from your [Voucherify dashboard](https://voucherify.io/dashboard){:target="_blank"}.
24+
6. Enter **Custom URL**. Check your API region in Voucherify dashboard -> Project settings -> API endpoint. Then use one of [API Endpoints](https://docs.voucherify.io/docs/api-endpoints) and replace the **API** word with `segmentio` For example, if your default URL is: https://us1.api.voucherify.io, then use: https://us1.segmentio.voucherify.io. It also works for dedicated URLs.
25+
7. Select **Quick Setup** to start with pre-populated subscriptions, or **Customized Setup** to configure each action from scratch.
26+
8. Click **Configure Actions**.
27+
28+
### Find your API Key and API Token
29+
30+
On the Voucherify Dashboard page:
31+
1. Open the **Project settings** from the user context menu on the top right.
32+
2. Find the **Application Keys** section on the project page.
33+
3. Use **Application ID** and **Secret Key** respectively as the **API Key** and **API Token**.
34+
35+
{% include components/actions-fields.html %}
36+
37+

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

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,82 @@
11
---
2-
title: 'Voucherify Source'
2+
title: Voucherify Source
33
hidden: true
4-
---
4+
---
5+
[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.
6+
The integration is bidirectional, which means you can configure Voucherify as both the destination and source of customer data.
7+
8+
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also sync the exported data into your other enabled Segment Destinations.
9+
10+
This source is maintained by Voucherify. For any issues with the source, [contact the Voucherify team](mailto:[email protected]).
11+
12+
> info "This is a Beta source"
13+
> The Voucherify Source is currently in beta, which means that they are still actively developing the source. If you are interested in joining their beta program or have any feedback to help improve the Voucherify Source and its documentation, [contact the Voucherify team](mailto:[email protected]).
14+
15+
## Getting Started
16+
17+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
18+
2. Search for "Voucherify" in the Sources Catalog, select Voucherify, and click **Add Source**.
19+
3. On the next screen, give the Source a nickname configure any other settings. 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 Segment recommends you use something that reflects the source itself and distinguishes amongst your environments.
20+
4. Click **Add Source** to save your settings.
21+
5. Copy the Write key from the Segment UI and log in to your Voucherify account.
22+
6. In your Voucherify account, go to **Project Settings > Integrations > Segment.io > Connect** and enter the Write Key.
23+
24+
## Stream
25+
26+
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).
27+
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`. 
29+
30+
## Events
31+
Integrating by adding Voucherify as a Source to Segment supports the following events to be sent out of the box:
32+
- Redemption events (successful, failed, rolled back).
33+
- Validation events (only if connected with a customer).
34+
- Customer reward events.
35+
36+
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.
37+
38+
### 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. |
45+
46+
### 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+
58+
59+
### Validation events
60+
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:
67+
68+
69+
## Event Properties
70+
71+
The table below lists the properties included in the events listed above.
72+
73+
| Event | Description |
74+
| --------------- | ---------------------------------------------------- |
75+
| voucherifyEvent | The entire event object that occurred in Voucherify. |
76+
## Adding Destinations
77+
78+
Now that your Source is set up, you can connect it with Destinations.
79+
80+
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](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
81+
82+
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)