The Voucherify Developer Hub

Welcome to the Voucherify developer hub. You'll find comprehensive guides and documentation to help you start working with Voucherify as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Dashboard overview

The Voucherify Dashboard is a feature-rich user interface for marketers to manage promo campaigns on their own. It also helps administrators and developers configure your Voucherify account.

The Dashboard home shows at-a-glance information about the activity on your account. This includes promotion performance charts, but also a list of failed redemptions which may require action.

Navigating the Dashboard

The Dashboard is organized into separate sections. Each section represents a particular area of the API, mapping the core objects you can read about in Key concepts. The goal of each view is to enable marketing teams to operate on these objects without needing to use the API.

Basic promotion workflow

To see how particular Voucherify dashboard sections support promotion workflow, let's run through one of the common promo scenarios: sending a one-off coupon for a particular product via email, only to loyal customers

Dashboard sectionDescription
CustomersThe first step is to create a segment of loyal customers. Assuming you've already imported your customer base, you can use this view to filter "loyal customers" based on their attributes. Remember that the segments can work in a dynamic way, including and excluding customers from a group when a parameter being a part of the filter's criteria changes.
ProductsThe next stage is to map your inventory so that the validation engine recognizes which products are in a cart. This view shows the products which you've imported with the API. You can also manually add and modify products and SKUs here.
Campaigns creatorIn this view, you can generate unique codes with a custom pattern, define what discount they should carry, and set business limits on them. This includes:

- rules based on customer segments, products, and a cart structure
- expiry date and validity timeframes
- number of possible redemptions
VouchersAll created codes, either with a campaign or standalone, land in the Vouchers view. You can browse them with filters and monitor their performance. The UI also allows for manual modification of voucher attributes and status.
DistributionWhen you define a customer segment and create codes within a campaign, you can finally deliver them to customers via email. With the distribution view, you can connect all the blocks with a given marketing channel. When you turn on the distribution, it automatically fires out a new email with a unique code to every customer who enters your segment. The messages can be styled with both predefined and custom templates.
RedemptionsYour customers are now redeeming their codes. To see the campaign's performance, go to the Redemptions view which gives you a way to filter redemptions by campaign, date, customer or, possibly the most important information, the status. Every failed redemption is listed here with a detailed reason for the unsuccessful operation.
Campaigns If you want to have a bird's eye view of all promo activities, the Campaigns view will be very useful. It shows an overview of all promotion, including activity status, discount type, timeframes, number of codes and redemptions.
OrdersThis view serves mainly for informational purposes. It stores all transactions which have come through a Voucherify account, including details about customers and the order structure. You might want to monitor orders because they can be used as a trigger for distributions.

Monitoring your promotions

The Dashboard also helps you monitor overall campaign performance and specific voucher changes in time. The Campaigns view displays the current number of redemptions per campaign. In the Customer view, you'll find the redemptions performed by a selected profile. If you're interested in the redemptions performed with a given voucher, type a voucher code into the search.

If you want to run reporting on your Voucherify data, consider filtering and exporting them as a CSV file. Vouchers, Customers, and Redemptions offer this functionality.

Monitoring your integration

  • API keys - In Project Settings, you'll find API keys and the information about the current version of API for a project. Additionally, you can control client-side features access, including white-listed domains.
  • events - Every resource you can find in the dashboard contains a timeline of actions performed on it. This gives you an idea who and how modified the object's state, with the API or dashboard.
  • logs - Voucherify logs every successful or failed request made using your API keys. Each resource contains detailed information about the original request, including request (and response) body. You can find them in the Events and LOGS sections.
  • metadata - The Project Settings section also gives you the ability to define the schema for custom fields.
  • integrations - Here, you can turn on and off your third-party connectors.

Team member access

Your Voucherify space is organized around separate projects. Each project has separate API keys and membership settings. You can invite team members to access your Dashboard and help manage your promo campaigns.

Each team member can have different privileges that restrict the information they can see or actions they can take in a project. There are 4 predefined roles, being: ADMIN, USER, VIEWER, MERCHANT but you can create your own ones by selecting appropriate privileges.

Updated about a year ago

Dashboard overview

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.