Heap (Actions) Destination
Additional versions of this destination are available
This page is about the Heap (Actions) Destination. See below for information about other versions of the Heap destination:
Heap automatically captures every user interaction with no extra code. This includes clicks, taps, gestures, form submissions, page views, and more.
Success!
Good to know: This page is about the Actions-framework Heap destination. There's also a page about the non-Actions Heap destination. Both of these destinations receive data from Segment.
Heap (Actions) provides the following benefits over the classic Heap destination:
- More control with clearer mapping. Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to the destination.
- Increased transparency. All Segment ingested events display the Segment icon in Heap, so you can identify the source of the event, and foster greater data trust.
- Improved setup. Clear default settings enable you to set up faster.
- From the Segment web app, navigate to Connections and click Add Destination.
- Search for Heap (Actions) and click it.
- Click Configure Heap.
- Select the Source to connect to Heap (Actions).
The app ID of the environment to which you want to send data. You can find this ID on the Projects page.
Optional
This is an optional setting. When set, nested array items will be sent in as new Heap events. Defaults to 0.
Optional
Setting to true will redact all target text on your website. For more information visit the heap docs page.
Optional
This is an optional setting used to set the host that loads heap-js. This setting is used when heapJS is self-hosted. In most cased this should be left unset. The hostname should not contain https or app id it will be populated like so: https://${hostname}/js/heap-${appId}.js. For more information visit the heap docs page.
Optional
This option is turned off by default to accommodate websites not served over HTTPS. If your application uses HTTPS, we recommend enabling secure cookies to prevent Heap cookies from being observed by unauthorized parties. For more information visit the heap docs page.
Optional
This is an optional setting. This is used to set up first-party data collection. For most cased this should not be set. For more information visit the heap docs page.
Heap Web (Actions) has the following presets
| Preset Name | Trigger | Default Action |
|---|---|---|
| Track Event | Event type = "track" | Track Event |
| Identify User | Event type = "identify" | Identify User |
Build your own Mappings. Combine supported triggers with the following Heap Web-supported actions:
Mapping limits per destination
Individual destination instances support a maximum of 5 mappings.
Sets user identity
Identify User is a Web action. The default Trigger is type = "identify"
Optional
The user's identity
Optional
The Segment traits to be forwarded to Heap
Track events
Track Event is a Web action. The default Trigger is type = "track"
The name of the event.
Optional
A JSON object containing additional information about the event that will be indexed by Heap.
Optional
a string that uniquely identifies a user, such as an email, handle, or username. This means no two users in one environment may share the same identity. More on identify: https://developers.heap.io/docs/using-identify
Optional
The segment anonymous identifier for the user
Optional
An object with key-value properties you want associated with the user. Each property must either be a number or string with fewer than 1024 characters.