Playable has made an integration using Agillic's Recipient API, which allows you to easily connect your campaigns and games in Playable to your Agillic instance.

This article will cover the basic principles that you need to be familiar with to set up the integration in Playable, including where to find the relevant information in Agillic that you will need in Playable.

With the integration set up, you can easily create or update your recipients with Person or One-to-Many Data in Agillic and even use event triggers to trigger certain flows for the recipients.

In order to use this integration, your organization must have:

• An Agillic instance, with a user who has
  • Access to create Agillic API Credentials
  • Access to the Agillic Data module
  • Access to the Agillic Flows module
  • Email field which is marked as unique
• A Playable account
  • Appropriate permission levels
  • Campaigns set up

As this integration is built and maintained by Playable, you should contact your responsible there, to hear about the Playable-specific requirements.

Integrating leads directly into Agillic is an effective way to gather data, be relevant in your communications and allows you to nurture the leads directly from Agillic. The integration between Playable and Agillic has made this workflow as easy as possible for you as a configurator.

Finally, Playable also has an article on how to setup this integration in the Playable platform which you can find here.

Data Fields

In order to store data from Playable, you need to be familiar with the data structure configured in Agillic. Especially important are the fields used for communication, so make sure you are aware of the fields used for email address, mobile number, and permissions. You can check what fields you use in System Settings under Person Data:

Furthermore, you can create new fields in the Agillic data structure, to accommodate the campaigns built in Playable. You could for example add a field like COMPETITION_SOURCE or COMPETITION_SCORE if you want to write a certain score to the recipient in Agillic. This could either be Person Data or One-to-Many Data and you add the data fields in the Data module. These fields and the saved values can be referenced in conditions, to enable you to segment & personalise on an even more granular level

If you are in doubt as to when to use Person Data and One-to-Many Data in relation to your Playable campaign, here are some things to keep in mind.

Person Data is primarily used for permissions, preferences or for flagging recipients that have done X or Y. Person Data fields will be overwritten for each campaign a lead participates in, if new data is sent over to the field. Person Data is a naturally simpler structure, so keep that in mind.

The advantage of using One-to-Many Data for your Playable campaigns is that you get an overview of the different campaigns a lead has participated in. For example, you will be able to store the data if a lead participates in multiple games or in one game multiple times.

Permissions

The integration should only send recipients to Agillic if they have provided consent. This consent should be included in the integration as a data field: building a double opt-in campaign is an additional step you may want to take. Make sure you are familiar with your Agillic instance's existing permission structure, before handling permissions with this integration.

Read more about our best practice of permission handling here.

Field Types

If you use number fields, date or timestamp field types, remember to check the different formats, so you ensure that the output from Playable matches the input format in Agillic. It is recommended to adjust the format in Playable as the format defined in Agillic is likely to be used in a variety of other integrations.

Find the date and timestamp formats in API settings.

Events

The integration also supports the triggering of Events that you can attach to specific campaigns in Playable, so side effects are applied to recipients when triggered.

Side effects triggered by Events can for example be used to:

• Start flows configured to be triggered by events
  • Double opt-in campaign
  • Communication directly related to signup
  • Confirmation of competition participation
• Apply data side effects
  • Update specific data fields with specific data values 

Testing

Each Playable campaign using the integration should be fully tested on your Agillic staging environment with staging API Credentials, before publishing the Agillic entities to production, and using production API credentials in Playable. This can include full end-to-end tests, all the way from the Playable Campaign, to the recipients created & updated, permissions set, communications received, and any other additional data set through the integration.

See our best practice on testing in Agillic here.

Finding the API Keys

As the integration is API based, you need to insert the API keys in Playable which will authorise the call to your Agillic instance. The API keys are separate between your staging and production environment. In this way, you should conduct all your testing towards your staging environment with test recipients and when you are ready to go live, you need to switch to the API keys on production. By replacing the keys with production values, the integration will send the API calls to your production database.

In order to find the API keys, navigate to System Settings and Integrations: