Voyado is a robust customer experience platform that provides a comprehensive suite of tools for personalized marketing and customer loyalty programs. Integrating Playable with Voyado offers a unique possibility for leveraging gamification to supercharge your marketing efforts.
In this article, we'll explore the process of configuring the Voyado integration in the platform. We will cover how to:
Let's dive in!
Add Voyado and establish connection
To add the Voyado integration, navigate to the integrations tab > select 'email provider' > find and select Voyado on the list.
If you have previously set up a Voyado integration in Playable, you can reuse the configuration.
To integrate with Voyado, you need two kinds of information:
an API endpoint
an API key
These two will establish the connection between Playable and Voyado.
Get your Voyado API Key
Voyado recommends that you use an individual unique API key for every integration/system you will use to communicate with Voyado. Visit your Voyado Engage configuration area to create one for your Playable integration. You can see a step-by-step guide here.
Get your Voyado API endpoint
Your Voyado API URL usually has the format: domain.voyado.com or domain.staging.voyado.com if it's in your testing environment. You find it by copying the url you're visiting when you log in to Voyado. Read more here.
Environment | Example |
Staging | https://[domain].staging.voyado.com |
Production | https://[domain].voyado.com |
If the system returns an 'access violation' message, the values most likely are not correct. Double-check and try again.
Select trigger
The trigger is the event that determines when data should be sent through the integration.
The triggers available depend on the placement of your registration form(s) and whether you have included prizes in the campaign.
Trigger name | Event that triggers data transfer |
Primary registration form submitted | Data is sent every time the primary registration form (containing the email field) is submitted |
Game completed | Data is sent as soon as the game status is known (winner or loser), only if the primary registration form has already been submitted. Note: this option is only available if registration form is placed BEFORE the game. |
Prize won | Data is sent when a regular prize has a winner assigned (whether or not the game has been completed) |
Bulk prize won | Data is sent when a bulk prize has a winner assigned (whether or not the game has been completed) |
Add additional conditions
It is possible to add additional conditions to the trigger. Together with the trigger, these must be met in order for the data to be transferred.
Using the form field option you can define a specific field in the registration form(s) that must be filled out.
With the advanced option you have the option to set up a data flow based on more complex conditions. For example, the trigger could be based on performance in the game or a specific selection or data input in the registration form.
Select a contact type
In the contact type drop down you must choose between 'member' and 'contact type'.
In Voyado, the terms 'contact' and 'member' refer to different entities, each with its own distinct characteristics and functions.
A contact in Voyado refers to an individual or entity that exists within your database.
Members are a subset of contacts who have opted into a loyalty program or membership and have provided additional information beyond basic contact details.
You can read more about the contact types here.
Select a unique identifier
The unique identifier is used to determine whether the user information should be updated or if a new contact should be created. Typically, email is used as unique identifier. However, depending on the data structure in Voyado, it may prove more beneficial to use alternative values like phone number or ContactID.
It is important that the unique identifier is mapped correctly in the integration.
Map up information
In order to send data over to Voyado, you need to map information collected in Playable to your contact fields in Voyado. By mapping the data fields, you will make sure that data is sent to the correct contact fields.
The integration displays default contact fields (attributes) that data can be transferred to, like first name, last name, e-mail etc.
If you are not able to find the correct field, you may have to manually define it. Read more in the next section.
Manually define custom attributes
In addition to the standard contact attributes, it is also possible to adding custom contact attributes in Voyado. If you have added custom attributes in Voyado, you may have to 'manually define' fields in the integration. Read more about custom attributes.
If you choose to manually define a field, you must insert the attribute name from Voyado in the input field, as seen below:
Add custom triggers
In Voyado, automation flows can be initiated based on specific events. Playable facilitates the transmission of data via a custom trigger payload. This way, Playable can activate an automation flow in Voyado. Read more about custom triggers here.
Once you have created a custom trigger in Voyado, you must insert the TriggerId in the integration settings.
When setting up a custom trigger you can also choose, if the event should trigger an action when a contact is created, updated or both.
Add custom fields
Custom fields in Voyado allow you to store and manage additional information about contacts.
If you add a custom field in Playable, data will be transferred as part of the json payload, as in the example below:
Note! Custom fields must be mapped to a field from the registration form.
Add consent
Voyado consents are used to manage and track the permissions granted by individuals regarding their personal data.
If you have included a consent field in the registration form, like for example "Do you agree to receive our newsletter?" it is possible to transfer the consent to Voyado. Below you can see an example of a newsletter consent. Read more about consents here.
Note! The consent section will only be visible in the platform if you have set up a consent in Voyado.
Changing data values
The data values that Playable uses per default may not always align with the data values that Voyado expects. For example, the platform per default sends over 1/0 for check box values while Voyado primarily works with boolean true/false values rather than numerical representations like 1/0.
There are two ways you can accommodate data format or value challenges.
In the registration form
In a checkbox field you have the option to select what type of datatype the boolean value should be represented in.
Typecasting
Typecasting refers to the process of converting one data type into another. Within the Voyado integration, you can enable typecasting. This will allow you to convert data values into a format Voyado accepts.
The typecasting options available depends on the nature of the datavalue.
For a checkbox, you can choose between string, integer, float, boolean and array. The most common selection is boolean, but if you have multiple checkbox options you may have to send the values as an array instead.
Test and troubleshoot the integration
We always advise that you test the integration by going through the actual campaign. The testing process will depend on what your triggers are, but we suggest that you test by submitting the registration form(s) and play through the game.
In the activity tab, you will be able to check if the data has successfully been transferred to Voyado. Read more about troubleshooting integrations.
Test feature
It is also possible to use the test feature, which can be found at the end of the integration setup. You will either see a green checkmark or a red cross, depending on whether the registration successfully went through or not. The test feature does however not provide as detailed error descriptions, which is why we advice that you test via the actual campaign instead.
Using staging environment
When testing the integration, it is recommended to utilize the staging environment rather than the production environment. This prevents that test data is mixed with live data.