Send Data from Cordial to Segment

Overview

The Segment integration supports Cordial as a source, allowing you to pipe cross-channel engagement data from Cordial to Segment, where it can then be routed to any of Segment's integrations.  

Event Data

As events fire in Cordial, they are automatically piped directly to Segment.  Each of the events below (along with all supporting metadata and contact identifiers) are included in the integration.  

Email Channel Events

Mobile Channel Events

SMS MMS Channel Events

REST Channel Events

Custom Events

Enable and Authenticate Cordial as a Source

You can enable the Segment integration by following the steps below.

1. Once you've created Cordial as a source in your Segment account, copy the Write Key.

2. Log into your Cordial account, navigate to Marketplace in the upper right corner, and select Enable on the Segment modal.
 

3. In the Outbound Data Settings panel, paste in your write key from your Segment source project.

Configure Allowed and Blocked events

You can choose to block or allow specific events per each channel and per your custom events.  By default, "Send all events" is set for each case.

Data Examples

Example of a click event in Cordial (with nested objects and arrays)

{
  "action": "click",
  "time": "2021-10-22T16:11:48+0000",
  "bmID": "45:6172e28c897f2011ab137761:ot",
  "cID": "5c673e6b10986b7e3cd505d1",
  "mcID": "45:6172e28c897f2011ab137761:ot:5c673e6b10986b7e3cd505d1:1",
  "first": true,
  "lTags": [
    "threadsdemo"
  ],
  "_id": "6172e2c81815fd55160c82b1",
  "d": {
    "type": "computer",
    "device": "WebKit",
    "platform": "Windows",
    "browser": "Chrome",
    "robot": false,
    "bot_score": 18,
    "bot_verified": false,
    "asn": 701,
    "threat_score": 0
  },
  "properties": {
    "foo": "bar",
    "foo2": "bar2"
   },
  "system_properties": {
    "ed": "cordial.com",
    "mTags": [
      "test1",
      "test2"
    ],
  "link": "http://www.threads.com",
  "lKey": "http://www.threads.com",
  "rl": "http://www.threads.com?$utm_source=test1&utm_campaign=april1&utm_medium=test3"
  }
}

Example of a Cordial click event as passed to Segment (flattened)

{
  "anonymousId": "5c673e6b10986b7e3cd505d1",
  "context": {
    "library": {
      "name": "unknown",
      "version": "unknown"
    },
    "source": "cordial"
  },
  "event": "Email Link Clicked",
  "integrations": {},
  "messageId": "api-.....",
  "properties": {
    "_id": "6172e2c81815fd55160c82b1",
    "action": "click",
    "bmID": "45:6172e28c897f2011ab137761:ot",
    "cID": "5c673e6b10986b7e3cd505d1",
    "campaign_id": "45:6172e28c897f2011ab137761:ot",
    "campaign_name": "Fall Sale",
    "email_id": "45:6172e28c897f2011ab137761:ot:5c673e6b10986b7e3cd505d1:1",
    "email_subject": "Fall Sale 10% Off",
    "first": true,
    "link_url": "http://www.cordial.com?$utm_source=test1&utm_campaign=april1&utm_medium=test3",
    "mcID": "45:6172e28c897f2011ab137761:ot:5c673e6b10986b7e3cd505d1:1",
    "system_properties_ed": "cordial.com",
    "system_properties_mTags_0": "test1",
    "system_properties_mTags_1": "test2",
    "system_properties_lKey": "http://www.threads.com",
    "system_properties_rl": "http://www.threads.com?$utm_source=test1&utm_campaign=april1&utm_medium=test3",
    "properties_foo": "bar",
    "properties_foo2": "bar2",
    "lTags_0": "threadsdemo",
    "d_type": "computer",
    "d_device": "WebKit",
    "d_platform": "Windows",
    "d_browser": "Chrome",
    "d_robot": false,
    "d_bot_score": 18,
    "d_bot_verified": false,
    "d_asn": 701,
    "d_threat_score": 0
  },
  "receivedAt": "2021-10-22T16:11:53.270Z",
  "sentAt": "2021-10-22T16:11:53.000Z",
  "timestamp": "2021-10-22T16:11:53.540Z",
  "type": "track",
  "writeKey": "...."
}