Segment makes it easy to collect user data using one API and send it to hundreds of tools, including Heap. The Segment source automatically captures all user properties and events sent to Segment in Heap.
With Heap’s Segment source, you’ll be able to:
- Understand what drives feature engagement and customer retention.
- Find bottlenecks in signup and onboarding flows.
- Attribute conversion and identify the best performing marketing channels.
To set up the Heap Segment source, all you need to do is visit the Heap destination connection page in your Segment account. From this view, you’ll need to confirm the Source and provide your Heap app ID in the subsequent view.
You can find your Heap app ID by navigating to Account > Manage > Projects, then selecting the project you need to find the app ID for. All app IDs associated with environments on that project will be listed.
If you are using Segment to load Heap, do not also install the Heap snippet natively in your site. This could cause unexpected events and errors in your data.
The ID is also listed within the web installation snippet on the installation page.
Once enabled, Heap will automatically capture all of the data included in our standard autocapture solution in addition the following data from Segment:
- Any custom events tracked via Segment
Segment events coming from mobile SDKs and server-side sources will correspond to Heap custom events. and can be distinguished in the app via the Segment logo.
Segment events tracked from
analytics.js will look the same as Heap autocaptured events, since Segment calls Heap’s track function behind the scenes.
2. Any custom user properties sent as traits to Segment
Please refer to Segment’s documentation for more information on the Heap Segment Source.
Mapping Segment APIs to Heap
Heap supports Segment API calls in “device mode” to identify and track.
analytics.track are sent via heap.track.
We do not currently support
You can view Heap’s Segment device mode integration here.
Heap supports Segment API calls in “cloud mode” to /
- Calls to
/identifyare sent via Heap’s Add User Properties API.
- Calls to
/trackare sent via Heap’s Track API.
We do not support Segment event replay at this time.
You can view Heap’s Segment cloud mode integration here.
We currently support Segment’s cloud-based connection mode on mobile, which sends data to Heap via our server-side track API, but does not package Heap’s SDK with Segment’s. Setting up Heap in this way will not enable autocapture functionality, and only Segment-tracked events will be sent to Heap (as server-side events).
It is possible to install the Heap SDK natively as well as through Segment to get both autocaptured events and Segment-tracked events. Note that since Segment data will come into Heap as server-side events, this will limit the ability to perform “within-a-session” analysis. You can, however, use a time restriction (e.g. “within an hour”) as a proxy. Please consult your Account Manager or reach out to firstname.lastname@example.org to discuss this option further.