Overview

Cordial is a real-time platform that helps you connect with your customers by delivering relevant messages across multiple channels.

Integrating Cordial with Lytics allows you to import user activity from Cordial and use Lytics' powerful insights to build behavioral audiences and improve your targeting. You can export Lytics audiences in real time or in bulk to Cordial for use in your marketing campaigns.

Authorization

If you haven't already done so, you will need to set up a Cordial account before you begin the process described below. If you are new to creating authorizations in Lytics, see the Authorizations documentation for more information.

You will also need to create an Account Settings that Lytics will use to import/export data. If you need use IP addresses to create an API key, contact your Account Manager for the current list of Lytics' IP addresses.

Select Cordial from the list of providers.
Select the method for authorization. Note that different methods may support different job types. Cordial supports the following authorization methods:
- Cordial Real Time authorization
- Cordial Bulk authorization
Enter a Label to identify your authorization.
(Optional) Enter a Description for further context on your authorization.
Complete the configuration steps needed for your authorization. These steps will vary by method.
Click Save Authorization.

Cordial Real Time Authorization

In the Cordial API Key field, enter your Cordial API key.
Click Save Authorization.

Cordial Bulk Authorization

During the configuration process for authorizations of type Cordial Bulk, in addition to Cordial API key, you will also need the SFTP server credentials like hostname, port, username and password.

In the Cordial API Key field, enter your Cordial API key.
In the Host text field, enter the host name or IP address of the SFTP server you want to store files before importing to Cordial.
In the Port text field, enter the port number for the SFTP server.
In the Username text field, enter the username for the SFTP server.
In the Password text field, enter the password for the SFTP server.
In the Folder text field, enter path to the folder to save the file. If the path is not given, Lytics will export the file to the user's home directory.
Click Save Authorization.

Import Activity

Import contact activity data from Cordial to build targeted audiences in Lytics.

Integration Details

Implementation Type: Server-side Integration.
Implementation Technique: REST API Integration and File Based Transfer Integration.
Frequency: Activity data is received every 6 hours in a Batch Integration
Resulting Data: Activity data for Cordial contacts will be collected as User Fields

This integration utilizes the Cordial Activity Export API to import contact activity data to Lytics. On each run of the job, it will:

Create the Contact Activity export job in Cordial to export activity (message-, open, click, opt-out, bounce, complaint, custom) data to a file in SFTP server.
Import the data from the exported file to Lytics in the cordial_activity stream.
Repeats step 1 and 2 every 6 hours.

Fields

The following fields are included in the default mapping of the cordial_activity stream:

Source Field	Lytics User Field	Description	Type
_id	cr_system_event_id	Cordial System Event ID	string
action	cr_event_action	Cordial Event Action	string
cID	cr_contact_id `unique id`		string
first	cr_first	Cordial Unique Event	bool
mcID	cr_message_contact_id	Cordial Message Contact ID	string
message_name	cr_message_name	Cordial Message Name	string
message_sent	cr_message_sent_timestamp	Cordial Message Sent Timestamp	date
time	cr_event_timestamp	Cordial Event Timestamp	date

Configuration

Follow these steps to set up and configure an import of contact activity from Cordial in the Lytics platform. If you are new to creating jobs in Lytics, see the Jobs Dashboard documentation for more information.

Select Cordial from the list of providers.
Select Import Activity from the list.
Select the Authorization you would like to use or create a new one.
Enter a Label to identify this job you are creating in Lytics.
(Optional) Enter a Description for further context on your job.
(Optional) In the Import Since text box, enter events after this date will be imported. The date format should be yyyy-mm-dd, for example, 2019-03-27. If left empty, activity data from the last 7 days will be imported.
Click Start Import.

Export Audiences (Real Time)

Export Lytics audiences in real time to refine the targeting of your Cordial campaigns with behavioral insights from Lytics. For this job, all existing members of the selected Lytics audience are exported to the chosen list in Cordial and new members are exported in real time.

Integration Details

Implementation Type: Server-side Integration
Implementation Technique: REST API Integration, Audience Trigger Integration
Frequency: Real-time Integration, with a one-time configurable Backfill of the audience.
Resulting Data: Lytics users that are members of the selected audience are exported to the selected Cordial list.

This integration utilizes the Cordial Contacts API to create a Cordial contact if it doesn't already exist. Then the contact is put in the selected Cordial list. On each run of the job, it will:

Run a backfill of the selected Lytics audience, and create or add contacts in the selected Cordial list.
After a backfill, the job will receive real-time updates when a user enters or exits the audience.
For each user entering the audience, it will create and add the contact in the Cordial list. It will also export the attributes that are mapped during work configuration.
For each user exiting the selected audience, the job will remove the contact from the Cordial list.

Fields

You can export any Lytics user fields to Cordial Account Contact Attributes. Lytics allows you to map user profile fields with the corresponding contact attributes as part of the job configuration.

Configuration

Follow these steps to set up and configure an export job for Cordial in the Lytics platform. If you are new to creating jobs in Lytics, see the Jobs Dashboard documentation for more information.

Select Cordial from the list of providers.
Select the export Export Audiences (Real-time) from the list.
Select the Authorization you would like to use or create a new one.
Enter a Label to identify this job you are creating in Lytics.
(Optional) Enter a Description for further context on your job.
From the Audience drop-down list, select the Lytics audience you would like to export to Cordial.
From the Email Field input, select name of email field in the Lytics profiles.
(Optional) From the List input, select the Cordial list you want to export your audience to. If no list is selected, a new Cordial list will be created named Lytics_{lytics_audience_name}.
(Optional) From the Field Mapping input, select Lytics data fields from the left drop-down list and Cordial contact attributes from the right drop-down list.
(Optional) Select the Existing Users checkbox, to add users who already exist in the selected Lytics audience.
Click Start Export.

Export Audiences (Bulk)

Export Lytics audiences in bulk for use in your Cordial campaigns, leveraging rich, behavioral audiences powered by Lytics data science.
For this job, all existing members of the selected Lytics audience are exported to the chosen list in Cordial and new members are exported in batch.

Integration Details

Implementation Type: Server-side Integration
Implementation Technique: File Based Transfer Integration, Audience Trigger Integration.
Frequency: Batch Integration, with a one-time configurable Backfill of the audience.
Resulting Data: Lytics users that are members of the selected audience are exported to Cordial and added to the selected Cordial list.

This integration utilizes the Cordial Contacts Import API to export a batch of users to Cordial. The job exports users to Cordial in batches of 30,000. On each run of the job, it will:

Run an one-time backfill of the selected Lytics audience, writes the user in the CSV file and registers the import job in Cordial using Cordial Import API
After a backfill, the job will receive real-time updates when a user enters or exits the audience.
For each user entering/exiting the audience, it will create a batch of 30,000 users and export them to a file so that it can be imported into Cordial.

Fields

You can export any Lytics user fields to Cordial Account Contact Attributes. Lytics allows you to map user profile fields with the corresponding contact attributes as part of the job configuration.

Configuration

Follow these steps to set up and configure an export job for Cordial in the Lytics platform.

Select Cordial from the list of providers.
Select the export Export Bulk from the list.
Select the Authorization you would like to use or create a new one.
Enter a Label to identify this job you are creating in Lytics.
(Optional) Enter a Description for further context on your job.
Select the Lytics Audience to export.
Using the Email Field drop-down list, select the Lytics user field that contains the user's email address.
Using the List drop-down list, select the Cordial list you want to export your audience to. If no list is selected, a new Cordial list will be created named Lytics_{lytics_audience_name}.
(Optional) Use the Fields Mapping input to map Lytics fields to the existing Cordial account contact attributes. Select Lytics data fields from the left drop-down list and Cordial contact attributes from the right drop-down list.
(Optional) Use the Frequency drop-down list to specify how often the job should run. If nothing is selected, it will run daily by default.
(Optional) Check the Existing Users checkbox to immediately export users who currently exist in the selected Lytics audience. Deselecting it will only export users as they enter or exit the audience.
Click Start Export.