Documentation / Product / Integrations / Cordial

Cordial

Authentication

  1. Our integration uses Cordial's HTTP API where authentication works through secure keys. To generate a key log in to your Cordial dashboard, at the right top corner click on your user name and select API Keys:

    cordial dashboard api key

  2. Click New.

    cordial add key

  3. In the API key name fields enter a descriptive name.

  4. Enter Lytics' IP address 104.154.89.25 to the IP Address field.

    cordial key form

  5. Click Generate Key. Your new key should be listed. Click the copy to clipboard icon or manually copy your API key.

Adding auth to Lytics

There are two kinds of authorizations for Cordial in Lytics. One is used for real time updates, the other for bulk updates.

The bulk export uses Cordial's API key and SFTP credentials since flat files are uploaded to Cordial. We offer a SFTP instance where the credentials are:

  • Account Domain is your username
  • Data API Key is your password
  • The host is lytics.brickftp.com

Real Time auth

  1. Log in to your Lytics account and navigate to Data > Integrations.
  2. Select the Cordial tile.
  3. Select Authorizations and click Create Cordial Real Time.
  4. In the Cordial API Key field paste your Cordial API key.

    add cordial key to lytics

  5. Enter a Description for the authorization.

  6. CLick on "Authorize".

Bulk auth

  1. Log in to your Lytics account and navigate to Data > Integrations.
  2. Select the Cordial tile.
  3. Select Authorizations and click Create Cordial Bulk.
  4. In the Cordial API Key field paste your Cordial API key.

If you want to use Lytics managed SFTP:

  1. In the Host field set lytics.brickftp.com.
  2. In the Port field leave as 22.
  3. In the Username field use your account Domain.
  4. In the Password field use your Data API Key.
  5. Click Authorize.

Cordial Auth Form

Otherwise you can use your own SFTP service, as long as it is accessible outside if your company network.

Export

Summary
FrequencyReal-time
WhereCordial List
NameUser specified Cordial list
Identifiersemail
Mapped Fieldsyes
Segment Membershipno
Typeadd and removal via profile updates
  1. Authenticate, if you have not previously done so.

  2. Navigate to the Cordial tile, select an API key to use, then set up your export according to your needs.

    • Email Field: Name of email field in the Lytics profiles. This is a required field.
    • Audience: Choose a Lytics audience to export to Cordial. Members of this audience will be kept up to date between Lytics and Cordial.
    • List: List to be populated in Cordial. If no list is set one will be created and named LYTICS_{audience slug}, all upper case.
    • Field Mapping: Maps Lytics field names to Cordial ones.
    • Existing Users: Add users who already exist in the selected Lytics audience. Unchecked by default.
    • Time-based Triggers: "Trigger on time-based changes e.g., Last Visit was more than 7 days ago.

Bulk Export

Summary
FrequencyDaily, Weekly, Monthly, with Daily as default
WhereCordial List
NameUser specified Cordial list
Identifiersemail
Mapped Fieldsyes
Segment Membershipno
Typeadd and removal via profile updates
  1. Authenticate, if you have not previously done so.

  2. Navigate to the Cordial tile, select an API key to use, then set up your export according to your needs.

    • Email Field: Name of email field in the Lytics profiles. This is a required field.
    • Audience: Choose a Lytics audience to export to Cordial. Members of this audience will be kept up to date between Lytics and Cordial.
    • List: List to be populated in Cordial. If no list is set one will be created and named LYTICS_{audience slug}, all upper case.
    • Field Mapping: Maps Lytics field names to Cordial ones.
    • Frequency: Defines how often an export should run. Defaults to daily.
    • Existing Users: Add users who already exist in the selected Lytics audience. Unchecked by default.
    • Time-based Triggers: "Trigger on time-based changes e.g., Last Visit was more than 7 days ago.

Importing activity

Summary
FrequencyEvery 6 hours
Streamcordial_activity
User fieldsCordial Contant ID and custom user fields
User activitymessage-sent, open, click, optout, bounce, complaint, custom

Lytics has an integration to import activity from Cordial, it uses the same kind of credentials used by Bulk Exports.

The import configuration is very simple:

  • Import Since: Events from that date on will be imported. The date format should be yyyy-mm-dd, e.g. 2019-03-27.