> For the complete documentation index, see [llms.txt](https://integrations.drivetrain.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.drivetrain.ai/integration-guide/readme/customer-success/integrating-with-planhat.md).

# Integrating with Planhat

Sync Planhat customer success data with Drivetrain to track retention and NRR alongside financials. Covers API token setup and account setup.

## Before you start <a href="#before-you-start" id="before-you-start"></a>

* **In Drivetrain:** you need to be an admin.
* **In Planhat:** API access, and permission to create Private Apps (called **Service Accounts** in original Planhat). Access to them is controlled by the **ServiceAccount** data model permission; if you don't see them, ask your Planhat admin.

## Step 1: Create a Private App and token in Planhat <a href="#step-1-create-a-private-app-and-token" id="step-1-create-a-private-app-and-token"></a>

1. Open the **App Center** global tool, click **+ New app**, then **+ Private app** in the top-left corner.
2. Name it `Drivetrain Integration`. Under **Copy Permissions From**, choose **Start from scratch** (copying a role gives the app that role's broader access), then click **Create**.
3. On the **Permissions** tab, give the app access only to the objects you want in Drivetrain (for example companies, licenses, assets, opportunities and users). Click **Save**.
4. On the **Info** tab, set **Set Expiration** to the longest option (365 days at most). Tokens expire after 30 days by default.
5. Click **Generate new token** and copy it. Planhat shows the token only once.

<figure><img src="https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-b7dc6586de7bcfc84d15c4513ea12d2b23e068d9%2FPlanhat-1.gif?alt=media" alt=""><figcaption></figcaption></figure>

## Step 2: Connect in Drivetrain <a href="#step-2-connect-in-drivetrain" id="step-2-connect-in-drivetrain"></a>

1. Go to **Data** in the left navigation, click the **+** button and select **Planhat** (under **Others**, or search for it).
2. Drivetrain shows **Planhat is a premium integration**. Click **Request access**.
3. Click **Add field** and enter `API token` with the token as its value. If the form already lists fields under **Connector fields**, fill those in instead. Click **Submit credentials**.
4. Planhat appears on the **Data** page with the status **Credentials submitted**. Drivetrain completes the setup and runs the first sync; the **Sync** option stays hidden until then.

## What data comes in <a href="#what-data-comes-in" id="what-data-comes-in"></a>

Planhat objects such as companies, licenses, assets, opportunities, and your Planhat users and their roles. Give the token access to every object you need.

## Before the token expires <a href="#before-the-token-expires" id="before-the-token-expires"></a>

When the token expires, syncs stop. Before its expiry date, generate a new token on the app's **Info** tab and send it to your customer success manager.

## Troubleshooting <a href="#troubleshooting" id="troubleshooting"></a>

| What you see                                                                   | Cause and fix                                                                                                                                                                      |
| ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Submit credentials** does nothing                                            | No field has both a name and a value. Fill in both: a row missing either is dropped without warning.                                                                               |
| You submitted a wrong value                                                    | While the status is **Credentials submitted**, repeat Step 2. The new submission replaces the pending one.                                                                         |
| `This connector is currently being set up. Please try again once it finishes.` | Drivetrain has started setting up or syncing this connector, so your submission wasn't saved. Don't submit again: send the corrected credentials to your customer success manager. |
| **Planhat not in your subscription**                                           | Planhat isn't in your plan. Contact Drivetrain support to add it.                                                                                                                  |
| You need to change credentials after setup                                     | Don't repeat Step 2: after setup, that creates a second connection. Send the new credentials to your customer success manager.                                                     |
| Syncs stop after a few weeks                                                   | The token expired (30 days by default). Generate a new one with a longer expiry and send it to your customer success manager.                                                      |
| You lost the token before submitting it                                        | Planhat can't show it again. Generate a new token.                                                                                                                                 |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://integrations.drivetrain.ai/integration-guide/readme/customer-success/integrating-with-planhat.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
