Heap

Server-side event and user property delivery to Heap via the Server-Side API for autocapture-complementary analytics.

⚠️

This integration is currently in beta. Configuration and behaviour may change.

Configuration

FieldTypeRequiredDescription
app_idstringYesYour Heap environment’s App ID. Found in Account > Manage > Environment settings.
api_keysecretYesServer-side API key for authenticating Heap API requests. Generated in Account > Manage > API Keys.

Quick Setup

  1. Navigate to Integrations in the sidebar.
  2. Open the Integration Library tab.
  3. Find Heap or filter by Analytics.
  4. Click Install, select a variant if available, and fill in the required fields.
  5. Click Install Integration to create the integration with a ready-to-use default configuration.

API Setup

curl -X POST http://localhost:8084/v1/admin/integration-catalog/heap/install \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Heap",
    "variant": "default",
    "config": {
      "app_id": "1234567890",
      "api_key": "your_api_key"
    },
    "delivery_mode": "server_side"
  }'

Delivery

Events are delivered server-side from your Datafly Signal infrastructure directly to the Heap API. No client-side scripts are loaded for this integration.

Visit Heap documentation for full API documentation and credential setup instructions.