Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 149 additions & 1 deletion src/_data/catalog/destinations_private.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination data last updated 2022-06-23 with Snapchat Conversions API
# destination data last updated 2022-07-07 with Heap Web (Actions)
items:
- id: 54521fd525e721e32a72ee8e
name: AdRoll
Expand Down Expand Up @@ -1398,3 +1398,151 @@ items:
event_type: SIGN_UP
event_conversion_type: WEB
trigger: event = "Signed Up"
- id: 62b256147cbb49302d1486d0
display_name: Heap Web (Actions)
name: Heap Web (Actions)
slug: actions-heap-web
previous_names:
- Heap Web (Actions)
website: https://heap.io/
status: PRIVATE_BETA
logo:
url: https://cdn.filepicker.io/api/file/3MfYsCdgQhu8cVRSPKE6
mark:
url: https://cdn.filepicker.io/api/file/jrbUXsZDQ708akn3cVyZ
methods:
track: true
pageview: true
identify: true
group: true
alias: true
platforms:
browser: true
mobile: false
server: false
components: []
browserUnbundlingSupported: false
browserUnbundlingPublic: false
replay: false
settings:
- name: appId
type: string
defaultValue: ''
description: >-
The app ID of the environment to which you want to send data. You can
find this ID on the
[Projects](https://heapanalytics.com/app/manage/projects) page.
required: true
label: Heap app ID
- name: disableTextCapture
type: boolean
defaultValue: false
description: >-
Setting to true will redact all target text on your website. For more
information visit the heap [docs
page](https://developers.heap.io/docs/web#global-data-redaction-via-disabling-text-capture).
required: true
label: Global data redaction via Disabling Text Capture
- name: secureCookie
type: boolean
defaultValue: false
description: >-
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](https://developers.heap.io/docs/web#securecookie).
required: true
label: Secure Cookie
actions:
- id: 9DNev5M9FhK634qd8TtqXN
name: Identify User
slug: identifyUser
description: Sets user identity
platform: WEB
hidden: false
defaultTrigger: type = "identify"
fields:
- id: aFcado7WC7fAAmth74Qrhx
sortOrder: 0
fieldKey: userId
label: Identity
type: STRING
description: The user's identity
placeholder: ''
defaultValue:
'@path': $.userId
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- id: w7z6gUcm8QVF2pWUtUzqa8
sortOrder: 1
fieldKey: traits
label: Traits
type: OBJECT
description: The Segment traits to be forwarded to Heap
placeholder: ''
defaultValue:
'@path': $.traits
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- id: hbxtT8G3frRQvjM6AoJ73p
name: Track Event
slug: trackEvent
description: Track events
platform: WEB
hidden: false
defaultTrigger: type = "track"
fields:
- id: qbPz8kfSwRSSuDNyd85CHg
sortOrder: 0
fieldKey: name
label: Name
type: STRING
description: The name of the event.
placeholder: ''
defaultValue:
'@path': $.event
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- id: mSD7ZxZJ44LWttkJAYQYT3
sortOrder: 1
fieldKey: properties
label: Properties
type: OBJECT
description: >-
A JSON object containing additional information about the event
that will be indexed by Heap.
placeholder: ''
defaultValue:
'@path': $.properties
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
presets:
- actionId: 9DNev5M9FhK634qd8TtqXN
name: Identify User
fields:
userId:
'@path': $.userId
traits:
'@path': $.traits
trigger: type = "identify"
- actionId: hbxtT8G3frRQvjM6AoJ73p
name: Track Event
fields:
name:
'@path': $.event
properties:
'@path': $.properties
trigger: type = "track"
40 changes: 40 additions & 0 deletions src/connections/destinations/catalog/actions-heap/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Heap (Actions) Destination
hide-boilerplate: true
hide-dossier: true
hidden: true
private: true
id: 62b256147cbb49302d1486d0
versions:
- name: Heap (Classic)
link: /docs/connections/destinations/heap
---

{% include content/plan-grid.md name="actions" %}

[Heap](https://heapanalytics.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} 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](/docs/connections/destinations/actions/) Heap destination. There's also a page about the [non-Actions Heap destination](/docs/connections/destinations/catalog/heap/). Both of these destinations receive data from Segment.


{% include content/ajs-upgrade.md %}

## Benefits of Heap (Actions) vs Heap Classic

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.

## Getting started

1. From the Segment web app, navigate to **Connections** and click **Add Destination**.
2. Search for **Heap (Actions)** and click it.
3. Click **Configure Heap**.
4. Select the Source to connect to Heap (Actions).

{% include components/actions-fields.html %}