Cordial Connector Setup Guide

This article describes how to set up the Cordial connector.

Connector Actions

Action Name AudienceStream EventStream
Update List Value of a User
Upsert Contact
Contact Activities

Configure Settings

Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article.

After adding the connector, configure the following settings:

  • API key
    Cordial uses HTTP Basic Authentication (BA). From within the Cordial platform, you can generate an encoded API key for your account. This key is then used as the username for your BA credentials.
    For more information, see RESTful API Summary and Usage in the Cordial documentation.

Click Done when you are finished configuring the connector.

Action Settings — Parameters and Options

Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu.

The following section describes how to set up parameters and options for each action.

Action — Update List Value of a User


Parameter Description
Primary Key The Primary Key is defined by the contact’s unique email address value.
List Name Name of the list the contact will be added to within the Cordial database. Note that the lists are created prior to updating the contact.
For more information about updating Cordial database contacts, see Contacts in the Cordial documentation.

Action — Upsert Contact


Parameter Description
Email Email address of the contact to upsert.
Subscribed Status (Optional) Set the subscription status to one of the following: subscribed, unsubscribed, none.
Contact Attributes Contact attributes to set or update for the user (string or number values). For list updates use boolean values. For example: {list_name} : true.

Action — Contact Activities


Parameter Description
Action Name Set the name of the action or activity to record for the user to one of the following: click, open, send, or any user defined actions.
Contact Primary Key The name of the primary key used to identify the user. For example: email.
Contact Primary Key Value The value of the primary key used to identify the user. For example:
Action Properties Additional data about the action or activity to record for the user.
Action Timestamp Timestamp of the action or activity. Cordial automatically populates the timestamp if not provided in the request.

Was this page helpful?

This page was last updated: May 17, 2022