No Result

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.

Getting started

RudderStack supports sending event data to Heap via the following connection modes:

Connection ModeWebMobileServer
Device modeSupported--
Cloud modeSupportedSupportedSupported
In a web device mode integration, that is, using JavaScript SDK as a source, the Heap native SDK is loaded from https://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.

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:
screen shot 2020 12 03 at 2 20 59 pm Heap.io Connection Settings on RudderStack dashboard

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.
The Heap destination currently supports only track and identify calls.

Identify

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

A sample identify payload is as shown in the snippet below:

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

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", {
  order_id: "12345",
  category: "clothing",
  revenue: 99.9,
  shipping: 13.99,
  tax: 10.99,
  promotion_id: "PROMO_NOW",
})

FAQs

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.

Contact us

For more information on the topics covered on this page, email us or start a conversation in our Slack community.

On this page