Voucherify (Actions) Destination

On this page

Destination Info
Partner Owned
  • This integration is partner owned. Please reach out to the partner's support for any issues.

Voucherify 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.

Voucherify maintains this destination. For any issues with the destination, contact the Voucherify Support team.

Benefits of Voucherify (Actions) vs Voucherify (Classic)

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.

Getting started

  1. From the Segment web app, click Catalog, then click Destinations.
  2. Find the Destinations Actions item in the left navigation, and click it.
  3. Select Voucherify (Actions) and then Configure Voucherify (Actions).
  4. Select an existing Source to connect to Voucherify (Actions).
  5. Enter the API Key and API Token into your Segment Settings UI, which you can find from your Voucherify dashboard.
  6. Enter Custom URL. Check your API region in Voucherify dashboard -> Project settings -> API endpoint. Then use one of 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.
  7. Select Quick Setup to start with pre-populated subscriptions, or Customized Setup to configure each action from scratch.
  8. Click Configure Actions.

Find your API Key and API Token

On the Voucherify Dashboard page:

  1. Open the Project settings from the user context menu on the top right.
  2. Find the Application Keys section on the project page.
  3. Use Application ID and Secret Key respectively as the API Key and API Token.

Destination Settings

Setting Description
Application ID Required.

Application ID can be found in Voucherify dashboard.
Custom Voucherify URL Required.

Check your API region in Voucherify dashboard -> Project settings -> API endpoint. For example, if you are using a project with a URL: https://us1.api.voucherify.io, your Custom URL will be: https://us1.segmentio.voucherify.io. It also works for dedicated URLs.
Secret Key Required.

Secret Key can be found in Voucherify dashboard.

Available Presets

Voucherify (Actions) has the following presets:

Preset Name Trigger Default Action
Add Custom Event (Screen Event) Event type = "screen"
 Add custom event
Add Custom Event (Page Event) Event type = "page"
 Add custom event
Assign Customer To Group Event type = "group"
 Assign customer to group
Create Or Update Customer Event type = "identify"
 Upsert Customer
Add Custom Event (Track Event) Event type = "track"
 Add custom event

Available Actions

Build your own Mappings. Combine supported triggers with the following Voucherify-supported actions:

Mapping limits per destination

Individual destination instances have support a maximum of 50 mappings.

Add custom event

Send the Track, Page or Screen event that will be saved as a custom event in Voucherify.

Add custom event is a Cloud action. The default Trigger is: type = "track" or type = "page" or type = "screen"

Click to show / hide fields

Field Description
Customer Object* Type: OBJECT

This is an object containing information about the customer.
Referral Object Type: OBJECT

If a conversion event for a referral program is set to a custom event, then you need to send the referral code in the payload to make a record of the conversion event.
Loyalty Object Type: OBJECT

If an earning rule in a loyalty program is based on a custom event. This objects allows you specify the loyalty card to which the custom event should be attributed to.
Track Event Metadata Type: OBJECT

The metadata object stores all custom attributes assigned to the custom event. A set of key/value pairs that you can attach to an event object. It can be useful for storing additional information about the event in a structured format. Event metadata schema is defined in the Dashboard > Project Settings > Event Schema > Edit particular event > Metadata property definition.
Event Name Type: STRING

The name of the event that will be saved as a custom event in Voucherify.
Event Type* Type: STRING

Type of the event. For example: identify, track, page, screen or group

Assign customer to group

Assign a specific group and its traits to the customer.

Assign customer to group is a Cloud action. The default Trigger is: type = "group"

Click to show / hide fields

Field Description
Customer Object* Type: OBJECT

Object containing information about the customer.
Group ID* Type: STRING

The ID used to uniquely identify a group to which customer belongs.
Group Traits Type: OBJECT

Traits of the group that will be created in customer metadata.
Event Type* Type: STRING

Type of the event. For example: identify, track, page, screen or group.

Upsert Customer

Send the identify event to create or update the customer

Upsert Customer is a Cloud action. The default Trigger is: type = "identify"

Click to show / hide fields

Field Description
Source ID* Type: STRING

The source_id which identifies the customer in Voucherify.
Name Type: STRING

First name and last name of the customer.
First Name Type: STRING

First name of the customer. It will be merged with last_name to create the name field.
Last Name Type: STRING

Last name of the customer. It will be merged with first_name to create the name field.
Description Type: STRING

An arbitrary string that you can attach to a customer object.
Email Address Type: STRING

The email that identifies the customer in Voucherify.
Phone Type: STRING

Phone number of the customer.
Birthdate Type: STRING

Birthdate of the customer. You can pass data here in date or datetime format (ISO 8601).
Address Type: OBJECT

Address of the customer.
Metadata Type: OBJECT

A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format.
Event Type* Type: STRING

Type of the event. For example: identify, track, page, screen or group

Engage

You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Engage sets that value to false.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Real-time to batch destination sync frequency

Real-time audience syncs to Voucherify (Actions) may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

Setting Description
Application ID
(required)		 string. Application ID can be found in Voucherify dashboard.
Custom Voucherify URL
(required)		 string. Check your API region in Voucherify dashboard -> Project settings -> API endpoint. For example, if you are using a project with a URL: https://us1.api.voucherify.io, your Custom URL will be: https://us1.segmentio.voucherify.io. It also works for dedicated URLs.
Secret Key
(required)		 password. Secret Key can be found in Voucherify dashboard.

This page was last modified: 27 Oct 2023

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account

Was this page helpful?