Skip to main content
Send Candu Events to Heap

Send Candu analytics events such as views, clicks and checklist completions to Heap.

Jonathan Anderson avatar
Written by Jonathan Anderson
Updated this week

Candu helps you build, iterate, and personalize your in-app content experiences. Measuring the impact of your content is essential.

You can send events captured in Candu back to Heap, enabling you to leverage Heap's analytics capabilities to gain insights into user behavior and further improve your product experience.

Setting up Candu's Heap Integration

Step 1: Get your Heap App ID

  1. Log in to Heap.

  2. Navigate to Account > Manage > Projects.

  3. Locate the project named Main with environment Production.

  4. In the details panel, scroll to the Environments section.

  5. Copy the Production ID - this is your Heap App ID.

A screenshot showing users how to find their Heap App ID.

Step 2: Setup the integration in Candu

  1. Log in to your Candu account.

  2. Go to the Settings > Integrations page.

  3. Add your Heap App ID and hit 'Save Changes.'

A screenshot of Candu's integrations page, where you can add your Heap ID.

Step 3: Test Your Heap Data Integration

  1. Perform actions in your Candu components (e.g., click a live Candu button) to trigger sample events you've chosen to track.

  2. Check your Heap dashboard to verify that events are being logged correctly. Note that it may take a few minutes for the data to appear.

A screenshot of how candu events will appear within Heap's interface.

Events Tracked

For a complete list of Candu's event schema, see Candu SDK event names.

When integrated with Heap, Candu automatically sends the following events:

  • Content views (candu.sdk.content)

  • User interactions (candu.sdk.content.interaction)

  • Form submissions (candu.sdk.form_submit)

  • Checklist completions (candu.sdk.tutorial.checklist_group_complete)

  • Tour interactions (candu.sdk.tour_step_tooltip, candu.sdk.tour_completed)

  • Hotspot engagement (candu.sdk.hotspot_tooltip, candu.sdk.hotspot_beacon)

Each event includes relevant metadata such as:

  • Content ID

  • Segment ID

  • Document ID

  • Version ID

  • Placement ID

  • Node ID (for component events)

Troubleshooting

If you're not seeing events in Heap:

  1. Verify your App ID is correct and matches your Production environment ID

  2. Ensure the integration is saved correctly in Candu

  3. Check that your content is published and live

  4. Confirm that your Heap implementation is working by testing other events

Did this answer your question?