Overview

Our integration with Heap enables you to sync segments of behavioral data in Heap 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.

You can also send data from Cordial to Heap.

Send behavioral data from Heap 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.

1. Get your Cordial Webhook URL from your Cordial CSM.

2. Log in to Heap and navigate to Integrations > Developer hub. 

Contact Heap customer support to have the Developer hub enabled in your account.

3. Paste your Cordial Webhook URL into the appropriate field.

4. Leave the OAuth Redirect URL field empty.

5. Complete the What do you use to identify users in your product? field. This value (email, unique ID, etc.) will appear during the integration setup to help users match identities between Heap and Cordial.

6. Select Reveal Webhook secret and copy that value.

7. In Cordial, navigate to Integrations > Partners and locate the Heap card. Click Enable.

8. Click Configure under Inbound Settings. 

8. Paste in your Heap Webhook Secret.

9. Save the destination.

After a segment is synced, the data will be added to a list in Cordial. The list is named with the segment name in Heap with spaces removed. For example, when the “activeusers” segment 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 segment and the segment is synced, the contact is removed from the list. Please visit our Lists article for details on using lists.

Scriptable API

Cordial's Scriptable API offers asynchronous methods for sending data from Heap 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 Heap.

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

• Visit this article to learn how to create an API key from within Cordial.

Your Heap account ID and signature are required to use this feature.

Supported actions

• POST/heap/listMembership/{accountId}

POST/heap/listMembership/{accountId}

• * Required

  Parameters	Type	Description	Example
  id_token	string	Identifier for customer.	See example request.
  *action_type	string	Webhook action type.	See example request.
  *customer_config	object	Heap customer configuration. Schema:  *fields *field_id field_display_name field_type *value *id display_name	See example request.
  data	object	Heap sync data. Schema: *segment *id *name *sync_info *page_number (number) *total_pages (number) *sync_task_id (string) add *id remove *id	See example request.

• {
    "id_token": "bc2ae9f9-51ce-404e-9bf9-6b98cbc36f9e",
    "action_type": "segment.users.sync",
    "customer_config": {
      "fields": [
        {
          "field_id": "heap_identity_user_property",
          "field_display_name": "Heap Identity User Property",
          "field_type": "identity_mapping",
          "value": {
            "id": "email",
            "display_name": "email"
          }
        }
      ]
    },
    "data": {
      "segment": {
        "id": "15225086",
        "name": "Heap Test Segment"
      },
      "sync_info": {
        "page_number": 1,
        "total_pages": 2,
        "sync_task_id": "ce011f7a-f60e-4c8c-9b9d-90c6b5ec455b"
      },
      "add": [
        {
          "id": "user1@email.com"
        }
      ],
      "remove": [
        {
          "id": "user1@email.com"
        }
      ]
    }
  }