Planhat Destination

Planhat quick info

Planhat accepts Page, Alias, Group, Identify, and Track calls. If you reference it in the Integrations object, call it “Planhat”.

Getting Started

Getting data from Segment to Planhat’s Customer Success Tool is easy.

Once the Segment library is integrated with your product, toggle Planhat on in your Segment destinations, and add your Planhat API Key which you can generate in Planhat under App Settings > API Access.

The Segment Planhat destination is 100% handled through our servers, so you don’t need to bundle their iOS or Android SDKs. Your Segment SDK will be enough.

Planhat supports the identify, page, and track methods at the moment.


When you identify a user, we’ll pass that user’s information to Planhat with userId as Planhat’s External User ID. Segment’s special traits recognized as Planhat’s standard contact profile fields (in parentheses) are:

  • name (name)
  • title (title)
  • email (email)
  • user_id (externalId)

In addition, all calls will get Segment as ‘source’.

If the userId or matches an existing Contact in Planhat the Identify-call will automatically be associated with that Contact. Otherwise a new Contact will be created in Planhat. New Contacts received from Segment can either be discarded or manually assigned to a Customer profile in Planhat.


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.

Supported Sources and Connection Modes

Segment offers an optional Device-based Connection Mode for Mobile data going to Planhat, so that you can use Planhat features that collect data directly from the mobile device. To do this, you must package the Segment-Planhat mobile SDK with the Segment mobile library.


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

Setting Description
Tenant Token
string. Add your Planhat Tenant Token, which you can find in Planhat under App Settings > API Access
Direct Integration Channels array, defaults to server, client.

The channels this direct integration supports.
Direct Integration Endpoint string, defaults to https://{{ subdomain }} .

The API endpoint of the direct integration.
select, defaults to api.

Your Planhat API subdomain.

This page was last modified: 25 Nov 2019

Get started with Segment

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