Cordial Connector Setup Guide

[#1]

This article describes how to set up the Cordial connector in your Customer Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name	AudienceStream	EventStream
Update List Value of a User	✓	✓
Send an Automation Template	✓	✓
Upsert Contact	✓	✗
Contact Activities	✓	✗

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the settings:

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

The following sections describe how to set up parameters and options for each action.

Action - Update List Value of a User

Parameters

Parameter	Description
API Key	Cordial uses HTTP Basic Authentication (BA). From within the Cordial platform, you can generate an encoded API key for your account. The encoded API key is then used as the "username" for your BA credentials.
Primary Key	The "primary_key" is defined by the contact's unique "email address" value.
List Name	The name of the list the contact will be added to within the Cordial database. Note that the lists were created prior to updating the contact. For more information, see: https://cordial.zendesk.com/hc/en-us/articles/203885958-Contacts.

Action - Send an Automation Template

Parameters

Parameter	Description
API Key	Cordial uses HTTP Basic Authentication (BA). From within the Cordial platform, you can generate an encoded API key for your account. The API key is then used as the "username" for your BA credentials.
Message Key	The automation template to be sent is defined by the template's unique "key" value. For more information, see: https://cordial.zendesk.com/hc/en-us/articles/203886108-Automationtemplates.
Email	The email address to send to.

Action - Upsert Contact

Parameters

Parameter	Description
Email	The email address of the contact to insert or update.
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 booleans. For example: {list_name} : true

Action - Contact Activities

Parameters

Parameter	Description
Action Name	The name of the action or activity to record for the user. Can be click, open, send, or any other 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: user@test.com
Action Properties	Additional data about the action or activity to record for the user.
Action Timestamp	The timestamp of the action or activity. Cordial will automatically populate the timestamp if not provided in the request.