HeadsUp AI Destination

HeadsUp AI quick info

HeadsUp AI is in beta, and accepts Page, Group, Identify, and Track calls. If you reference it in the Integrations object, call it “HeadsUp AI”.

HeadsUp AI allows customers to build metrics on top of their existing Segment analytics to better understand customer behavior and gauge health scores.

This destination is maintained by HeadsUp. For any issues with the destination, contact the HeadsUp AI Support team.

Getting Started

  1. From the Destinations catalog page in the Segment App, click Add Destination.
  2. Search for “HeadsUp AI” in the Destinations Catalog, and select the HeadsUp AI Destination.
  3. Choose which Source should send data to the HeadsUp AI destination.
  4. Go to the HeadsUp Onboarding page, find and copy the “Segment API key”.
  5. Back in the Segment App, go back to the the HeadsUp AI Destination settings, and enter the “API Key”.

Identify

If you aren’t familiar with the Segment Spec, take a look at the Identify method documentation to learn about what it does. An example call would look like:

analytics.identify('userId123', {
  email: 'john.doe@example.com'
});

Segment sends Identify calls to HeadsUp as an identify event. The email field is required. Identify calls without an email fail with a 400 code.

Track

If you aren’t familiar with the Segment Spec, take a look at the Track method documentation to learn about what it does. An example call would look like:

analytics.track('Login Button Clicked')

Segment sends Track calls to HeadsUp as a track event. Use Track events to perform metric aggregations, such as how many times a user logged into your application in the past 30 days.

Page

If you aren’t familiar with the Segment Spec, take a look at the Page method documentation to learn about what it does. An example call would look like:

analytics.page()

Segment sends Page calls to HeadsUp as a pageview.

Group

If you aren’t familiar with the Segment Spec, take a look at the Group method documentation to learn about what it does. An example call would look like:

analytics.group("0e8c78ea9d97a7b8185e8632", {
  name: "HeadsUp"
});

Segment sends Group calls to HeadsUp as a group event. Use Group events to aggregate user behavior across organizations.

Personas

You can send computed traits and audiences generated using Segment Personas to this destination as a user property. To learn more about Personas, contact us for a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Personas sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Personas sets that value to false.

When you first create an audience, Personas sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

Setting Description
API Key
(required)
string. You can find your API key within the HeadsUp onboarding flow.

This page was last modified: 18 May 2021



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account