> For the complete documentation index, see [llms.txt](https://docs.healthsherpa.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.healthsherpa.com/on-exchange-api-documentation/integration-guide/use-cases-and-features/link-your-crm-records-to-specific-healthsherpa-transactions.md).

# Link your CRM records to specific HealthSherpa transactions

## Overview

By using our deeplinking function you can add your identifier for your clients to HealthSherpa records, allowing us to include **your** identifier in things like exports and webhooks. 

This reduces the amount of work you do on your backend to map HealthSherpa data to clients in your CRM or system of record. 

To accomplish it, you'll link your users from your system to HealthSherpa (a process called [deeplinking](/on-exchange-api-documentation/api-reference/deeplinking-to-plan-quoting.md#step-1-environment-staging-or-production)) and pass **your system's identifier** for the client or household (in the `external_id` parameter). We'll associate your identifier with the subsequent activities for that client in HealthSherpa, and **include your identifier in future exports**. 

This also opens up the potential for additional integrations, including starting quotes pre-filled with data from your CRM or system of record. 

{% hint style="info" %}
For now, agents can also directly add your identifier to a HealthSherpa client record on the Client's Household Profile tab. 

We're currently developing a bulk import tool to fill in the external ID association for your entire HealthSherpa book of business. 
{% endhint %}

## Problems this solves

**Fuzzy matching** - Instead of matching HealthSherpa data to records in your systems by things like name, phone, or email, you can immediately match a HealthSherpa record because the HealthSherpa source data include your identifier. 

## What this looks like

<figure><img src="/files/3IZo5vLdIxlMTQ7iDBNu" alt=""><figcaption></figcaption></figure>

### Project scope and client requirements <a href="#project-scope-and-client-requirements" id="project-scope-and-client-requirements"></a>

This only requires you to use our deeplinking feature, which is the prerequisite for all other integrations. You'll need to have technical resources who can create a button in your CRM, and the URL tied to that button will need to include your system's identifier for that consumer/household, as well as passing any data you already have about the consumer(s).

### Compliance <a href="#compliance" id="compliance"></a>

CMS must approve agencies before they can use deeplinking.&#x20;

### Process <a href="#process" id="process"></a>

{% stepper %}
{% step %}

### Notify HealthSherpa of your intent to deeplink

Use the intake form to let us know you want to use this feature.
{% endstep %}

{% step %}

### HealthSherpa requests CMS approval

The review and approval process typically takes 2-3 weeks.
{% endstep %}

{% step %}

### While CMS reviews your request, build your deeplinks to HealthSherpa's test environment

You can build and test the functionality while CMS reviews, so that you're ready to deploy your code to your production environment once you have approval.

Our deeplinking documentation for developers is [here](/on-exchange-api-documentation/api-reference/deeplinking-to-plan-quoting.md).

{% hint style="info" %}
Be sure to pass the `external_id` parameter; you'll set this value to your system's identifier for the consumer/household.
{% endhint %}
{% endstep %}

{% step %}

### CMS approves, and HealthSherpa enables deeplinking in prod for your agency

We can enable deeplinking for a single-level agency, a specific downline, or an agency and all of its downline agencies.&#x20;
{% endstep %}

{% step %}

### You turn deeplinking on in production

As your agents start using the deeplinks, your book of business will begin to be populated with your identifiers. Those identifiers will show up in your exports, and, if enabled, webhooks.&#x20;
{% endstep %}
{% endstepper %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.healthsherpa.com/on-exchange-api-documentation/integration-guide/use-cases-and-features/link-your-crm-records-to-specific-healthsherpa-transactions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.