How can we help?

Send data from Amplitude to Cordial

Overview

With Amplitude and Cordial's cohort integration, you can sync users from Amplitude cohorts to Cordial lists. Using lists along with other contact data in Cordial, you can create dynamic segments of contacts for sending messages, searching contacts, and filtering analytics reports.

Send cohorts from Amplitude to Cordial

The Cordial destination is currently in open beta, which means that we're still actively developing the destination. If you have any feedback to help improve the Cordial destination and/or our documentation, contact the Cordial support team.

Cordial setup

1. Log into Cordial, click the Settings dropdown, and select API Keys.

2. Select New on the API Keys page.

Amplitude setup

1. Log into Amplitude and navigate to Data Destinations

2. Click View All Destinations, then select the Cordial - Cohort tile.

3. Complete the Name and API Key fields.

4. Reach out to your Cordial CSM to get your Amplitude service URL. Paste that URL into the Endpoint field.

For us-west-1 accounts, the URL is https://integrations-ingest-svc.cordial.com For us-west-2 accounts, the URL is https://integrations-ingest-svc.usw2.cordial.com

5. In Cordial, complete the Contact identifier name field. Users will be identified by this key in Cordial. For example, “email.”

6. In the Contact identifier mapping dropdown, select a user property name, the value of which will be passed as the value for Contact identifier.

7. Save the destination.

After a cohort is synced, the contacts will be added to a list in Cordial. The list is named with the cohort name in Amplitude with spaces removed. For example, when the “activeusers” cohort with 10 users is synced to Cordial, you will see exactly 10 contacts added to the “activeusers” list. When a user is removed from a cohort and the cohort is synced, the contact is removed from the list. Please refer to our Lists article for details on using lists.

Scriptable API

Cordial's Scriptable API offers asynchronous methods for sending data from Amplitude to Cordial. This allows you to stream data, send multiple API requests at the same time, and have more precise control over how Cordial interacts with Amplitude.

You can use Swagger to access and test our scriptable API offerings. In order to do so, you'll need an API key.

Supported actions

POST/amplitude/addContactsToList

Method URI path
POST

amplitude/addContactsToList

Create a new list in real time.

 

  • * Required

    Parameters Type Description Example
    *contacts

    object

    Identifies contacts to add to list.

    See example request.

    *cohortId

    string

    ID for Amplitude cohort.

    See example request.
    *cohortName

    string

    Name for Amplitude cohort.

    See example request.
  • {
      "contacts": [
        {
          "email": "test@example.com"
        }
      ],
      "cohortId": "h51r",
      "cohortName": "Cohort Test"
    }

POST/amplitude/removeContactsFromList

Method URI path
POST

amplitude/addContactsToList

Remove contacts from a list in real time.

 

  • * Required

    Parameters Type Description Example
    *contacts

    object

    Identifies contacts to remove to list.

    See example request.

    *cohortId

    string

    ID for Amplitude cohort.

    See example request.
    *cohortName

    string

    Name for Amplitude cohort.

    See example request.
  • {
      "contacts": [
        {
          "email": "test@example.com"
        }
      ],
      "cohortId": "h51r",
      "cohortName": "Cohort Test"
    }

 

Comments

0 comments

Please sign in to leave a comment.