Skip to content

Commit a5a07a7

Browse files
markzegarelliGedRapstayseesong
authored
Heap (Actions) destination docs (#3187)
* Heap (Actions) documentation * Edits * Re-add version link * Apply suggestions from code review Co-authored-by: stayseesong <[email protected]> Co-authored-by: Gediminas Rapolavicius <[email protected]> Co-authored-by: stayseesong <[email protected]>
1 parent 8d7522e commit a5a07a7

File tree

2 files changed

+189
-1
lines changed

2 files changed

+189
-1
lines changed

src/_data/catalog/destinations_private.yml

Lines changed: 149 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2022-06-23 with Snapchat Conversions API
2+
# destination data last updated 2022-07-07 with Heap Web (Actions)
33
items:
44
- id: 54521fd525e721e32a72ee8e
55
name: AdRoll
@@ -1398,3 +1398,151 @@ items:
13981398
event_type: SIGN_UP
13991399
event_conversion_type: WEB
14001400
trigger: event = "Signed Up"
1401+
- id: 62b256147cbb49302d1486d0
1402+
display_name: Heap Web (Actions)
1403+
name: Heap Web (Actions)
1404+
slug: actions-heap-web
1405+
previous_names:
1406+
- Heap Web (Actions)
1407+
website: https://heap.io/
1408+
status: PRIVATE_BETA
1409+
logo:
1410+
url: https://cdn.filepicker.io/api/file/3MfYsCdgQhu8cVRSPKE6
1411+
mark:
1412+
url: https://cdn.filepicker.io/api/file/jrbUXsZDQ708akn3cVyZ
1413+
methods:
1414+
track: true
1415+
pageview: true
1416+
identify: true
1417+
group: true
1418+
alias: true
1419+
platforms:
1420+
browser: true
1421+
mobile: false
1422+
server: false
1423+
components: []
1424+
browserUnbundlingSupported: false
1425+
browserUnbundlingPublic: false
1426+
replay: false
1427+
settings:
1428+
- name: appId
1429+
type: string
1430+
defaultValue: ''
1431+
description: >-
1432+
The app ID of the environment to which you want to send data. You can
1433+
find this ID on the
1434+
[Projects](https://heapanalytics.com/app/manage/projects) page.
1435+
required: true
1436+
label: Heap app ID
1437+
- name: disableTextCapture
1438+
type: boolean
1439+
defaultValue: false
1440+
description: >-
1441+
Setting to true will redact all target text on your website. For more
1442+
information visit the heap [docs
1443+
page](https://developers.heap.io/docs/web#global-data-redaction-via-disabling-text-capture).
1444+
required: true
1445+
label: Global data redaction via Disabling Text Capture
1446+
- name: secureCookie
1447+
type: boolean
1448+
defaultValue: false
1449+
description: >-
1450+
This option is turned off by default to accommodate websites not
1451+
served over HTTPS. If your application uses HTTPS, we recommend
1452+
enabling secure cookies to prevent Heap cookies from being observed by
1453+
unauthorized parties. For more information visit the heap [docs
1454+
page](https://developers.heap.io/docs/web#securecookie).
1455+
required: true
1456+
label: Secure Cookie
1457+
actions:
1458+
- id: 9DNev5M9FhK634qd8TtqXN
1459+
name: Identify User
1460+
slug: identifyUser
1461+
description: Sets user identity
1462+
platform: WEB
1463+
hidden: false
1464+
defaultTrigger: type = "identify"
1465+
fields:
1466+
- id: aFcado7WC7fAAmth74Qrhx
1467+
sortOrder: 0
1468+
fieldKey: userId
1469+
label: Identity
1470+
type: STRING
1471+
description: The user's identity
1472+
placeholder: ''
1473+
defaultValue:
1474+
'@path': $.userId
1475+
required: false
1476+
multiple: false
1477+
choices: null
1478+
dynamic: false
1479+
allowNull: false
1480+
- id: w7z6gUcm8QVF2pWUtUzqa8
1481+
sortOrder: 1
1482+
fieldKey: traits
1483+
label: Traits
1484+
type: OBJECT
1485+
description: The Segment traits to be forwarded to Heap
1486+
placeholder: ''
1487+
defaultValue:
1488+
'@path': $.traits
1489+
required: false
1490+
multiple: false
1491+
choices: null
1492+
dynamic: false
1493+
allowNull: false
1494+
- id: hbxtT8G3frRQvjM6AoJ73p
1495+
name: Track Event
1496+
slug: trackEvent
1497+
description: Track events
1498+
platform: WEB
1499+
hidden: false
1500+
defaultTrigger: type = "track"
1501+
fields:
1502+
- id: qbPz8kfSwRSSuDNyd85CHg
1503+
sortOrder: 0
1504+
fieldKey: name
1505+
label: Name
1506+
type: STRING
1507+
description: The name of the event.
1508+
placeholder: ''
1509+
defaultValue:
1510+
'@path': $.event
1511+
required: true
1512+
multiple: false
1513+
choices: null
1514+
dynamic: false
1515+
allowNull: false
1516+
- id: mSD7ZxZJ44LWttkJAYQYT3
1517+
sortOrder: 1
1518+
fieldKey: properties
1519+
label: Properties
1520+
type: OBJECT
1521+
description: >-
1522+
A JSON object containing additional information about the event
1523+
that will be indexed by Heap.
1524+
placeholder: ''
1525+
defaultValue:
1526+
'@path': $.properties
1527+
required: false
1528+
multiple: false
1529+
choices: null
1530+
dynamic: false
1531+
allowNull: false
1532+
presets:
1533+
- actionId: 9DNev5M9FhK634qd8TtqXN
1534+
name: Identify User
1535+
fields:
1536+
userId:
1537+
'@path': $.userId
1538+
traits:
1539+
'@path': $.traits
1540+
trigger: type = "identify"
1541+
- actionId: hbxtT8G3frRQvjM6AoJ73p
1542+
name: Track Event
1543+
fields:
1544+
name:
1545+
'@path': $.event
1546+
properties:
1547+
'@path': $.properties
1548+
trigger: type = "track"
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Heap (Actions) Destination
3+
hide-boilerplate: true
4+
hide-dossier: true
5+
hidden: true
6+
private: true
7+
id: 62b256147cbb49302d1486d0
8+
versions:
9+
- name: Heap (Classic)
10+
link: /docs/connections/destinations/heap
11+
---
12+
13+
{% include content/plan-grid.md name="actions" %}
14+
15+
[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.
16+
17+
> success ""
18+
> **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.
19+
20+
21+
{% include content/ajs-upgrade.md %}
22+
23+
## Benefits of Heap (Actions) vs Heap Classic
24+
25+
Heap (Actions) provides the following benefits over the classic Heap destination:
26+
27+
- **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.
28+
29+
- **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.
30+
31+
- **Improved setup**. Clear default settings enable you to set up faster.
32+
33+
## Getting started
34+
35+
1. From the Segment web app, navigate to **Connections** and click **Add Destination**.
36+
2. Search for **Heap (Actions)** and click it.
37+
3. Click **Configure Heap**.
38+
4. Select the Source to connect to Heap (Actions).
39+
40+
{% include components/actions-fields.html %}

0 commit comments

Comments
 (0)