Welcome to Encatch Docs
Data syncBetaConnectorsAnalytics

Heap

Send Encatch survey events to Heap - where to find the details in Heap and how to set up the connection

Overview

The Heap connector sends survey events to a Heap environment as server-side events, with the user's identity and, if you choose, their traits as user properties.

What it getsSurvey events as server-side events
EventsSurvey shown, started, submitted, partially submitted and dismissed
Anonymous respondentsSupported, with Include anonymous respondents on
User profileUpdated with the user's traits when Update the user's profile is on
StatusAvailable

What You'll Need

Before you start, make sure you have:

  • A Heap environment — the one that should get the events
  • Its App ID — the environment's ID (Step 1)
  • Its data residency — United States, or Europe if your account uses Heap's EU data residency

Step 1: Get your App ID in Heap

  1. In Heap, open Account → Manage → Projects.
  2. Find the environment that should get the survey events and copy its ID. This is the App ID.
  3. Check which region your Heap account is on. Choose Europe only if the account uses Heap's EU data residency.

Pick the right region. Heap answers success for events sent to the wrong region and then drops them, so Test connection still passes. Always check that the test event appears in Heap's Live data feed.


Step 2: Add the connection in Encatch

  1. In Encatch, open Data sync → Survey events and click Add connection.
  2. Choose Heap.
  3. Enter a Name you'll recognise in the list and in Logs.
  4. Fill in the Heap settings:
FieldWhat to enter
Data residencyUnited States (default) or Europe.
App IDThe environment's ID.
  1. Press Test connection. Encatch shows what Heap answered.

Encatch keeps the keys encrypted and never shows them again. To change one later, press Replace.


Step 3: Choose what to send

  1. Under Surveys, choose All surveys or Only these surveys.
  2. Under What is sent, tick the events to send. A new connection starts with Survey shown, started, submitted and dismissed ticked. Survey partially submitted is off until you tick it.
  3. Rename an event if you want another name in Heap. The defaults are encatch_survey_shown, encatch_survey_started, encatch_survey_submitted, encatch_survey_partial and encatch_survey_dismissed.
  4. To also send responses of people who are not signed in, turn on Include anonymous respondents.
  5. Open Advanced options to choose how users are identified, whether answers are sent and the rate limit.

Every option is explained in Connection settings.


Step 4: Save and start sending

Click Save. Saving does not start sending: press Start sending when you are ready. From then on events go out as they happen, and every delivery is listed in Logs.


Check it in Heap

Test connection sends one event named encatch_test_event. In Heap, open Data → Live data feed and check that the test event appears within a few seconds. Heap's Users view lists only users with sessions, so to see survey events by user, build a chart on the event and group it by Identity.


Good to know

  • Profile update. With Update the user's profile on, the user's Encatch traits are set as Heap user properties.
  • Anonymous respondents arrive without an identity, under the device ID.
  • Rate limit. Heap limits each person (30 requests per 30 seconds), not the connection as a whole.

Troubleshooting

What you seeWhat it meansWhat to do
Delivered, but nothing in the Live data feedThe data residency is wrongSwitch Data residency, save and test again
Events arrive, users don't show in UsersHeap lists only users with sessions thereUse a chart grouped by Identity

Was this page helpful?