Custobar allows you to store participant data and manage communication through channels such as email and more. Through our built-in integration, you can automate the data transfer between Playable and Custobar.
Note! This article covers both the Custobar V1 and V2 integrations. Any differences in the integration setup will be clearly specified.
In this article, we'll explore the process of configuring the Custobar integration in the platform. We will cover how to:
Add the Custobar integration
To find the integration, go into the 'Integrations' tab on your campaign and select 'Add Integration.' In the following menu, select 'Email Provider' and scroll through the list until you find the Custobar option. Clicking it will start the setup process.
Custobar connects to Playable through an API key and domain endpoint. This means that, if you are adding the integration for the first time, you will need to insert these details from your Custobar account.
For example, your domain endpoint might look like this:
https://playable.custobar.com
Scopes required for Custobar integration
Depending on the version of your Custobar integration, specific API scopes must be available to enable successful data transfer between Playable and Custobar.
Scopes for V1
For the V1 integration, the following scopes are required:
/api/datasources/{id}/import//api/events
Scopes for V2
For the V2 integration, the required scopes are:
/api/data/customers/?email={email}/api/customers/upload/api/events/upload//api/datasources/{id}/import//api/events
Ensure that the correct version is selected during setup and that the appropriate scopes are configured in your Custobar account. If the required scopes are not available, the integration will fail to transfer data.
If you have previously set up a Custobar integration in Playable, you can reuse the configuration.
If you require further assistance in finding your API key or domain endpoint, you can check out Custobar’s own documentation.
Configure the Custobar integration
Once your API key and domain endpoint have been added, you can start configuring what data should be sent from Playable to Custobar. The first section is 'General integration settings.' Here, you can define what to do with duplicates by setting whether the user's information should be updated or if a new contact should be created.
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 the 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 can 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.
Map data fields
You will "map" each field from your campaign to a field in Custobar using drop-down menus. This drop-down is how you select where in Custobar the data should be sent.
For each data point, you can select an existing field from Custobar to parse the data to.
At the bottom of this section, you can add static information if you want to track something that is true for every player but is not collected in the campaign automatically.
For example, you can use static information if you want to track Playable as the user "source" in your database.
Send Events
The integration allows Playable to send "Events" to Custobar.
Default Events
Two default events are pre-coded into the integration, making it simple to start capturing meaningful data as events immediately:
LEADFAMLY_GAME:
This event is triggered by the core interaction in a campaign, for example sending through the Personality outcome and answers in a Personality test campaign.MAIL_SUBSCRIBE:
This event is triggered so a participant subscribes to receive email communication. You will need to set a Tag for the list and select which email list the participants should be subscribed to.
If the Campaign type selected supports sending "Game metric events" a Checkbox will be visible. An example could be Personality test where the participants Personality outcome and answers can be sent to Custobar as an event.
Custom Event definition
If the default events do not cover your campaign requirements, you can define custom events to fit your specific needs.
To manually define an event:
Press Add event
Select Condition for when the event should be added
Under Event select Define manually
Name the Event under "Custom event fields" and give your event the name that should appear in Custobar under "Custom event name"
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 playing through the game.
In the activity tab, you will be able to check if the data has successfully been transferred to Custobar.
To learn more about how to test the integration, please read this Help Center article.
You can also find more information about troubleshooting integrations in our Help Center or Custobar’s own support resources.