Skip to main content

Heap

Overview​

Heap is supported as:

  • Destination (Reverse ETL): Heap Conversions API (credential validation available).
    Loading/syncing records to Heap is still in development.

This page documents how to configure the Heap Conversions API destination and validate access.

Setup​

Before you configure the connector in the UI, gather:

  • Heap App ID
  • Heap API Key

These are used to request an auth token from Heap.

Authentication​

The connector authenticates against Heap using HTTP Basic Auth:

  • Username: app_id
  • Password: api_key

During credential validation, the connector calls:

  • POST https://heapanalytics.com/api/public/v0/auth_token

If the request fails, the connector reports a credential validation error.

Configuration reference​

FieldTypeRequiredDescription
app_idstring✅Your Heap App ID. Used as the Basic Auth username.
api_keystring✅Your Heap API key. Used as the Basic Auth password.

Streams / Objects​

This destination does not currently expose any configurable objects/streams for syncing.

Hashing and normalization​

This destination does not currently expose field-level hashing options.

Data contract​

A data contract for records sent to Heap is not yet available because destination loading is still in development.