Heap Connector Setup Guide

[#1]

This article describes how to set up the Heap connector.

Table of Contents Placeholder

Connector Actions

Action Name	AudienceStream	EventStream
Add User Properties	✓	✗
Track	✗	✓

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.

Action Settings - Parameters and Options

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

This section describes how to set up parameters and options for each action.

Action - Add User Properties

Parameters

Parameter	Description
App ID	The app_id corresponding to one of your projects.
identity	An identity, typically corresponding to an existing user. If no such identity exists, a new user is created with that identity. Limited to 255 characters. For more information, see: Heap: Add User Properties
User Properties	An object with key-value properties you want associated with the user. Each key and property must either be a number or string with fewer than 1024 characters. For more information, see: Heap: Add User Properties

Action - Track

Parameters

Parameter	Description
App ID	The app_id corresponding to one of your projects.
identity	An identity, typically corresponding to an existing user. If no such identity exists, then a new user will be created with that identity. Limited to 255 characters. For more information, see the Heap documentation.
Event	The name of the server-side event. Limited to 1024 characters. For more information, see the Heap documentation.
Properties	An object with key-value properties you want associated with the user. Each key and property must either be a number or string with fewer than 1024 characters. For more information, see the Heap documentation.
Timestamp	ISO 8601 or Unix epoch milliseconds. Example: 2017-03-10T22:21:56+00:00 For more information, see the Heap documentation.