Skip to main content

Heap integration

Command AI's integration with Heap works in two directions:

  1. Command AI —> Heap: send Command AI-generated events to Heap, so you can build dashboards using Command AI events (and mix them with other events in Heap)
  2. Heap —> Command AI: use segments built in Heap for Who targeting in Command AI
One-time configuration

Once configured, the integration will "just work" — no maintenance required. You will not need to make any code changes to handle new/removed users that enter your synced segments.

Configuring Heap integration

  1. Navigate to Integrations and click “Connect” on the Heap card.

    Heap integration card

  2. To send Command AI-generated events to Heap, set the toggle to “Send”.

    Heap send events toggle UI

  3. To use the segments built in Heap, click “Sync with Heap”.

    Heap connect segments UI

  4. At this point, you will OAuth into Heap.

    1. Select the Heap environment you want to connect to Command AI.
    2. Click "Allow".

    Heap OAuth

  5. To finish syncing Heap heap, you’ll need to log in to Heap at https://heapanalytics.com/login.

Syncing Heap heap with Command AI​

  1. Inside Heap, click on "Data" in the left-hand menu, and then select "Segments".

    Heap admin UI to find Segments

  2. Choose a segment, then scroll down to the "Integrations" section in the right-hand detail pane for the segment. Turn on the toggle next to "Command AI".

    Heap segment integrations

  3. Select the Heap User ID that should be used to link data to Command AI. Then click “Confirm”.

    Heap integration user mapping

  4. If the integration modal closes, you will have to click the toggle next to the Command AI integration again.

  5. From here, we recommend using the "Enable Recurring Sync" option. You can also use “Sync now” if your plan does not have any remaining recurring syncs

    1. Recurring sync: Updates every 4 hours automatically
    2. Sync now: Only syncs once (must sync manually thereafter)

Heap sync options

tip

Because Heap emphasizes granular controls on integrations, you must repeat the above process for any segment that you want to connect to Command AI.

How to use Heap segments in Command AI​

There are many ways to use Heap segments in Command AI, and we'll walk through a few!r

Deploy a product tour to a specific segment​

If you want to target a product tour to a specific Heap segment:

  • From the Product Tours dashboard, click into a product tour or create a new one.
  • Select the "Targeting" tab.
  • In the Audience dropdown select “Custom”.
  • Click "Add condition", open the first dropdown, and choose "Heap Segment".
  • Then choose the desired Heap segment.

Using a Heap segment in a product tour

Deploy a checklist to a target segment​

If you want to deploy a checklist to a specific Heap segment:

  • From the Checklist dashboard, click into a checklist or create a new one.
  • Select the "Targeting" tab.
  • In the Audience dropdown select “Custom”.
  • Click "Add condition", open the first dropdown, and choose "Heap Segment".
  • Then choose the desired Heap segment.

Using a Heap segment in a checklist

FAQs​

What events are sent to Heap?​

If enabled, these events are sent to Heap.

How frequently are Heap segments updated?​

Heap segments are synced about every 4 hours.