The Cordial integration enables you to create, update, and subscribe contacts in Cordial based on user interactions within your experiences. This allows you to leverage collected user data for targeted Email or SMS campaigns.
Before you begin
Ensure you have administrative access to your Cordial account.
Generate an API key.
Identify your Cordial account URL.
Determine the specific data mappings between Experiences by Jebbit and Cordial.
Create a Cordial integration
Follow these steps to securely provide Experiences by Jebbit with access for the integration.
Copy the API Key and Account URL into a .txt file
Log in to your Cordial account and create an API Key
We recommend naming the Description to “Jebbit” or something similar.
Jebbit should provide you with the IP addresses to whitelist. If they have not already, please ask your Jebbit contact for this.
Provide access to all contact permissions.
Copy and paste your API Key into a new .txt file
Copy and paste your Account URL into a .txt file
For accounts located at HTTPS://admin.cordial.io/
The associated API URL is https://api.cordial.io/docs/v2/
For accounts located at HTTPS://usw2.admin.cordial.io/
The associated API URL is https://api.usw2.cordial.io/docs/v2/
Define data mappings and opt-in preferences
Identify the Jebbit attributes you wish to map to Cordial contact fields.
Provide the corresponding Cordial field names for each attribute.
Specify your data collection preferences:
Whether you will be collecting EU data, Non-EU data, or both.
Whether users should be subscribed automatically.
Any logic surrounding opt-ins, such as:
Only users who have opted in will be sent to Cordial (requires an opt-in box).
Only users who have opted in or where opt-in is NULL (either an opt-in box or automatic opt-in by entering PII).
All users regardless of choice, with opt-in status sent as a data value from Jebbit.
Add this information to your .txt file.
Example File
File Name:
Jane Doe - Company A.txt
Content:
API Key: XXXXXXXXXX
Account URL: https://api.cordial.io/docs/v2/
Non-EU Data
Data Mappings:
Jebbit Attribute: Email, Cordial Field: channels.email.address
Jebbit Attribute : Phone Number, Cordial Field: channels.sms.address
Jebbit Attribute : Source, Cordial Field: signup_source
Jebbit Attribute : Outcome, Cordial Field: outcome
Submit your .txt file via Dropbox File request
Transfer the information via the provided URL.
Next steps
The integrations team will confirm when the setup is complete and will be in contact regarding timelines and testing.