Heap Integration
Integration guide between Appcues and Heap
Table of Contents
Heap and Appcues have partnered to create a bi-directional flow of information enabling customers to maximize the value of both solutions. Completing the two-way integration requires setup in both Appcues and Heap.
How to use this integration
Appcues to Heap Mobile
To send data from Appcues mobile to Heap see the guide for your application in the Mobile Integrations doc.
Appcues to Heap
Go to Settings > Connections and click the Heap card to activate it.
Once Heap and Appcues are integrated, you can automatically find Appcues data under your Events category, where Source = ‘Appcues’. Appcues events appear on a general level, such as Flow Completed, Flow Started, Step Skipped, etc. (note for Step Interacted only stepChildId, stepChildNumber, and interactionType will be available and for Form Submitted only interactionType will be available in Heap)
To get the most out of this integration, you'll also want to be tracking events from your own application in Heap. These events might look like User signed up, created project, invited user, sent email, etc. -- it all depends on what your platform is and what your users can and should accomplish within it.
Use Case Examples
What data is sent from Appcues to Heap?
The following events are sent from Appcues to Heap when the integration is enabled: flow events, form events, NPS events, checklist events, pin events, banner events, and custom events.
| flow_started | form_submitted | checklist_skipped |
| flow_completed | form_field_submitted | checklist_dismissed |
| flow_skipped | nps_feedback | checklist_item_started |
| flow_aborted | nps_score | checklist_item_completed |
| step_started | nps_clicked_update_nps_score | appcues_custom (CTT events) |
| step_completed | nps_ask_me_later_selected_at | v2:experience_started |
| step_skipped | nps_survey_started | v2:step_seen |
| step_interacted | checklist_shown | v2:icon_seen |
| step_aborted | checklist_completed | v2:step_interaction |
| Builder track event | v2:experience_dismissed |
Note: you must have our Events Broadcaster feature enabled to send appcues_custom events. Please reach out to support@appcues.com if you're interested!
Defining your event
By creating a new event you can specify which Appcues flow you'd like to use in your Heap analysis. For instance, you can limit your event to a certain flow by using a filter when creating your event:
Creating your funnel
You can then use Heap analysis modules - such as funnels - to look at adoption such as: how many users who start a flow complete it? Select the two events you created (Flow Started and Flow Completed) and click run query to view your results.
Heap to Appcues
Sync a Heap segment to Appcues to target users based on what they did in Heap. You set this up in Heap, and it syncs segment membership only. Heap events don't sync.
Before you start
- The Appcues destination is turned on for your Heap account. Heap asks you to contact your Heap account manager to enable it.
- You're an Admin in Heap.
- A Heap user property holds the same values as your Appcues User IDs. If you also send Appcues data to Heap, Heap stores the Appcues User ID in a property called
appcuesUserID. See Match User IDs across integrations. - Appcues is installed on every page where Heap is installed.
Sync a segment
- In Heap, connect the Appcues destination. Enter your Appcues account ID (in Settings > Web), your Legacy API key, your region (US or EU), and the Heap property that holds the Appcues User ID.
- In Heap, go to Data > Segments and open a public segment.
- Turn on the Appcues toggle. Choose a one-time sync or a recurring sync. Heap allows up to 30 recurring syncs at a time.
- In Appcues, go to Settings > Properties. The segment appears as a true/false user property named
[Heap]followed by the segment name. - Create an Appcues segment with a rule where that property is
true, then use the segment to target your experiences.
Recurring syncs refresh the list on Heap's schedule, so membership isn't real time. If you rename the segment in Heap, the property in Appcues keeps its original name.
EU-hosted accounts support both directions.
For more detail, see Heap's Appcues integration doc.