In this article, we'll explore the process of configuring the Agillic integration in the platform. We will cover how to:
Adding the integration
In the Agillic integration, you need two kinds of information to connect to the API.
Developer Key
Secret
It is possible to see here how you add the integration on a campaign:
If you have previously set up a Agillic integration in Playable, you can reuse the configuration.
After inserting the developer key and secret, you will be able to go to proceed to the next step of the setup. If the system gives an invalid_client error message, then the values aren’t correct. Double-check and try again.
Select trigger
Under triggers there are different options depending on your campaign setup.
Primary registration form submitted
Secondary registration form submitted
Game completed
Bulk prize won
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.
Mapping data fields
When it comes to mapping data fields, you need to decide which data fields should be transferred to Agillic via the integration. The default setup contains name, email, and terms and conditions, so you will map the Name field in Playable with the Agillic attribute by selecting it in the dropdown. In this case, Name is mapped to First Name and E-mail to E-mail.
You can also map the terms and conditions field, which by default is a value of 1 or 0 in Playable but in Agillic you need to use the value called true or false. You can change the value of this field by editing the registration form field. If you can’t find the right value in the dropdown, then make sure that the attribute is also available in the integration setup.
If you want to add more fields to the form so that you can map additional information in the integration, then look in our Academy under the course on registration forms.
Manually define:
The integration only shows default/standardized values in the dropdown, for example, First Name, Last Name, E-mail e.g. However, in Agillic it is possible to create your own data fields, so you may need to use the Manually define option from the drop-down. This gives you the opportunity to map the field to any attribute in Agillic, you just need to insert the correct attribute name below.
Example:
In this campaign, you wanted to map up the zip codes of each of the recipients. Therefore the registration form on the campaign contains a form field called Zip code. You want to transfer that value to Agillic. Therefore you create an attribute called Zip code and then insert the value in the field in Playable.
One-to-Many
Something unique to the Agillic integration is One-to-Many data mapping. One-to-Many Data is different structurally from Person Data and may require some preparation work before you are completely comfortable using it. Below we share our best practice on how you can start off right when working with One-to-many Data.
First, choose the desired One to Many table. It is possible to map to multiple different tables if needed. Once you’ve chosen a table, the attributes from this table will be available in the dropdown menus, and you can map your data fields to them. Unlike with person data, you will not Manually define the attribute. You must select one of the available One to Many attributes from the dropdown.
Read more about how and why to use One to Many Data here. For more information, reach out to Agillic.
Event ID
Events in Agillic serve two primary purposes. You can track actions with Events and also trigger actions. Each Event has a starting value of 0 (for each recipient).
In order to use a specific event in Agillic based on a campaign from Playable, you will insert the event name in the Event ID field to trigger it. Then each registration will trigger the event, which can either create a specific email flow or create a form of tracking on the recipient.
Read more about Events in Agillic here.
Unique identifier
The unique identifier is the field that determines what the integration searches for when it needs to determine whether to create a new user or update the user. The norm and the default setting would be to search out a recipient by email. However, in some cases it could be more useful to use a mobile number or recipient ID based on the data structure in Agillic.
It is important that the unique identifier is mapped up in the integration.
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 Agillic. To learn more about how to test the integration, please read this Help Center article.
You can also find more information about troubleshooting integrations.