Skip to main content

Heap

Heap as a data destination​

Send events from Dopt to Heap for analysis.

Setup​

  1. Navigate to your Heap Projects page to find and copy the App ID for your project. Here’s how to find your App ID.
  2. In Dopt, navigate to Settings > Integrations.
  3. Click “Create Integration” and select Heap, select the Dopt environment you wish to send events from, paste in the Heap App ID, and click Create.

When configuring Heap, you can also send a test event to check if the integration is set up correctly. If you do, Dopt will send a dopt_heap_test event.

Events​

Dopt sends 3 events downstream as track calls.

flow_state_change​

This event is fired whenever the state of a flow changes.

Example event

{
  app_id: $appId,
  identity: $userId,
  event: 'flow_state_change',
  properties: {
    environment: 'development',
    flow_id: 'getting-started',
    flow_name: 'Getting started',
    flow_version: 1,
    flow_state: 'started', //started, stopped, finished, or reset
    workspace: 'acme.com'
  },
}

block_state_change​

This event is fired whenever the state of a block changes.

Example event

{
  app_id: $appId,
  identity: $userId,
  event: 'block_state_change',
  properties: {
    block_id: 'example-app-tutorial',
    block_name: 'example app tutorial',
    block_state: 'EXITED', //ENTERED or EXITED
    block_type: '' // start, webhook, etc
    environment: 'development',
    flow_id: 'getting-started',
    flow_name: 'Getting started',
    flow_version: 1,
    workspace: 'acme.com'
  },
}

path_transition​

This event is fired whenever a path is transitioned.

Example event

{
  app_id: $appId,
  identity: $userId,
  event: 'path_transition',
  properties: {
    path_transition: 'default',
    block_id: '00015', //block the path originates from
    block_name: 'Start',
    block_type: 'entry'
    environment: 'development',
    flow_id: 'getting-started',
    flow_name: 'Getting started',
    flow_version: 1,
    workspace: 'acme.com'
  },
}