Heap.io

Heap.io is a popular analytics platform built for marketers, product managers, and customer success teams. With Heap, you can track every clip, tap or screen swipe action of your customers. With this data, and combining Heap’s cutting-edge analytics capabilities, you can segment your users based on their behavior, and offer them unique digital experiences. If boosting your conversion rates and customer engagement is your goal, then Heap.io is a great tool to have in your marketing stack.

RudderStack supports Heap.io as a destination to which you can send your event data in real-time.

Find the open source transformer code for this destination in the GitHub repository.

Connection compatibility

Destination info
Status: Generally Available Supported sources: Android, iOS , Web, Unity, AMP , Cloud, Warehouse, React Native , Flutter, Cordova, Shopify Refer to it as HEAP in the Integrations object.

Connection modes
Source	Cloud mode	Device mode	Hybrid mode
AMP
Android
Cloud
Cordova
Flutter
iOS
React Native
Shopify
Unity
Warehouse
Web

Supported message types
Source	Identify	Page	Track	Screen	Group	Alias
Cloud mode
Supported sources
Device mode
Web

In the web device mode integration, that is, using JavaScript SDK as a source, RudderStack loads the Heap native SDK from thehttps://cdn.heapanalytics.com/ domain.

Based on your website’s content security policy, you might need to allowlist this domain to load the Heap SDK successfully.

Get started

Once you have confirmed that the platform supports sending events to Heap.io, perform the steps below:

• From your RudderStack dashboard, add the source. Then, from the list of destinations, select Heap.io.
• Give a name to the destination and click Next. You should then see the following screen:

To configure Heap.io as a destination, you need the Heap App ID. To get the App ID, login to your Heap account and navigate to App** - Settings - **Projects, and copy the development or production App ID.

• Once you’ve entered the Heap App ID, click Next. Heap.io should now be configured as a destination on your RudderStack dashboard.

Identify

RudderStack’s identify method captures the relevant details about the visiting user.

A sample identify payload is as shown:

rudderanalytics.identify("user123", {
  name: "Name LastName",
  email: "example@domain.com",
})

userId or anonymousId is a required field to send the identify call successfully.

Track

With the track API, RudderStack makes a call to Heap.io to track your user actions as well as their associated properties.

A sample track call is as shown:

rudderanalytics.track("Order Completed", {
  userId: "user123"
  order_id: "12345",
  category: "clothing",
  revenue: 99.9,
  shipping: 13.99,
  tax: 10.99,
  promotion_id: "PROMO_NOW",
})

userId or anonymousId is a required field to send the track call successfully.

FAQ

How do I get my Heap App ID?

You can procure your Heap ID by logging into your Heap account and navigate to App - Settings - Projects, and copying the required development or production App ID. Click here to go to your Heap dashboard and get the App ID.

Questions? Contact us by email or on Slack