> For the complete documentation index, see [llms.txt](https://docs.growsurf.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.growsurf.com/integrations/intercom.md).

# Intercom

Update Intercom contacts with their unique share link and referrer information.

## Sync with Intercom <a href="#sync-with-your-mailerlite-group" id="sync-with-your-mailerlite-group"></a>

**Step 1:** In *Program Editor > 4. Options > Integrations*, click the *Connect to Intercom* button.

{% hint style="info" %}
Connect Intercom before importing participants. If participants are already in your program, follow [these ESP sync options](https://support.growsurf.com/article/385-how-can-i-sync-my-growsurf-participants-to-my-esp) to send their GrowSurf data to Intercom.
{% endhint %}

![](https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LeklWo0yn03AhWro2Ux%2F-Mea6aI1ofoDGoKMUICu%2F-Mea9XP1dOmIWjFL5Sbo%2FScreen%20Shot%202021-07-14%20at%202.54.14%20PM.png?alt=media\&token=77f258cd-0230-4b06-942a-39a2af5f3e1a)

**Step 2:** Log in to Intercom

![](https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LeklWo0yn03AhWro2Ux%2F-MeaC-O4c_gOa-y9GlHR%2F-MeaWpFWtXbM72CQVPvB%2FScreenshot_63.png?alt=media\&token=599825cb-be81-4a43-9e45-4169766bf853)

**Step 3:** Once connected, choose an Intercom Tag that you want to automatically sync to. GrowSurf will update/add Intercom contacts with their unique share link and referrer information every time a new participant is added or referred to your referral or affiliate program.

![](https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LeklWo0yn03AhWro2Ux%2F-Mea_6eCAQD1WgFnK9RA%2F-Mea_odFpDKPR_UnCxnh%2FScreenshot_65.png?alt=media\&token=277f3de2-2ede-4b99-aad0-0b7be00a1b4d)

## Examples

[View our Intercom tutorials](https://docs.growsurf.com/additional-integrations/intercom/tutorials) to see different kinds of examples that you can copy/paste into your email templates.

## **Contact Attributes** <a href="#subscriber-fields" id="subscriber-fields"></a>

GrowSurf will automatically create these new contact attributes for your Intercom contacts.

| **Contact Attributes**                     | **Tag**                                                  | **Type** | **Description**                                                                                                                                                                                        | **Example**                                                |
| ------------------------------------------ | -------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| **`growsurf_share_url`**                   | `{{ custom_data.growsurf_share_url }}`                   | TEXT     | The participant's unique referral link                                                                                                                                                                 | <https://growsurf.com?grsf=absc123>                        |
| **`growsurf_participant_id`**              | `{{ custom_data.growsurf_participant_id }}`              | TEXT     | The participant's unique GrowSurf ID                                                                                                                                                                   | abc123                                                     |
| **`growsurf_referral_status`**             | `{{ custom_data.growsurf_referral_status }}`             | TEXT     | The referral status of the participant\*                                                                                                                                                               | CREDIT\_PENDING                                            |
| **`growsurf_participant_first_name`**      | `{{ custom_data.growsurf_participant_first_name }}`      | TEXT     | The participant's first name                                                                                                                                                                           | Bob                                                        |
| **`growsurf_participant_last_name`**       | `{{ custom_data.growsurf_participant_last_name }}`       | TEXT     | The participant's last name                                                                                                                                                                            | Loblaw                                                     |
| **`growsurf_referrer_first_name`**         | `{{ custom_data.growsurf_referrer_first_name }}`         | TEXT     | The first name of the participant's referrer (if applicable)                                                                                                                                           | Gavin                                                      |
| **`growsurf_referrer_last_name`**          | `{{ custom_data.growsurf_referrer_last_name }}`          | TEXT     | The last name of the participant's referrer (if applicable)                                                                                                                                            | Belson                                                     |
| **`growsurf_referrer_email`**              | `{{ custom_data.growsurf_referrer_email }}`              | TEXT     | The email address of the participant's referrer (if applicable)                                                                                                                                        | <gavin.belson@hoolie.io>                                   |
| **`growsurf_total_referral_count`**        | `{{ custom_data.growsurf_total_referral_count }}`        | NUMBER   | The participant's all-time referral count                                                                                                                                                              | 0                                                          |
| **`growsurf_lead_count`**                  | `{{ custom_data.growsurf_lead_count }}`                  | NUMBER   | The participant's current lead count (pending referrals that have not converted yet)                                                                                                                   | 0                                                          |
| **`growsurf_monthly_referral_count`**      | `{{ custom_data.growsurf_monthly_referral_count }}`      | NUMBER   | The participant's current month referral count                                                                                                                                                         | 19                                                         |
| **`growsurf_prev_monthly_referral_count`** | `{{ custom_data.growsurf_prev_monthly_referral_count }}` | NUMBER   | The participant's previous month referral count                                                                                                                                                        | 200                                                        |
| **`growsurf_next_milestone`**              | `{{ custom_data.growsurf_next_milestone }}`              | TEXT     | The text for the next/upcoming milestone reward (only applies to milestone rewards. [See example here](https://docs.growsurf.com/developer-tools/embeddable-elements#embedded-next-milestone))         | You are only 2 referrals away from winning a free t-shirt! |
| **`growsurf_next_monthly_milestone`**      | `{{ custom_data.growsurf_next_monthly_milestone }}`      | TEXT     | The text for the next/upcoming monthly milestone reward (only applies to milestone rewards. [See example here](https://docs.growsurf.com/developer-tools/embeddable-elements#embedded-next-milestone)) | You are only 2 referrals away from winning a free t-shirt! |
| **`growsurf_total_invite_count`**          | `{{ custom_data.growsurf_total_invite_count }}`          | NUMBER   | The participant's all-time invite count                                                                                                                                                                | 112                                                        |
| **`growsurf_total_impression_count`**      | `{{ custom_data.growsurf_total_impression_count }}`      | NUMBER   | The participant's all-time impression count                                                                                                                                                            | 150                                                        |

\*g*rowsurf\_referral\_status* can have one of these values:

* `CREDIT_PENDING`: The participant must trigger a referral before their referrer receives credit.
* `CREDIT_AWARDED`: The participant triggered a referral, and their referrer received credit.
* `CREDIT_EXPIRED`: The participant did not trigger a referral before the referral credit expired.

You can use these attributes in your Intercom email templates. For example, use `{{ custom_data.growsurf_share_url }}` to add each participant's unique referral link.

​[​Learn more about Intercom emails here](https://www.intercom.com/help/en/articles/247-create-custom-email-templates).​

## **Troubleshooting Tips** <a href="#troubleshooting-tips" id="troubleshooting-tips"></a>

* Check the participant's activity logs if they do not sync. GrowSurf retries failed syncs for up to 7 days.
* **If you cannot see the GrowSurf participant's custom attributes within Intercom:**
  * Add the GrowSurf attributes in your [Intercom Qualification Settings](https://app.intercom.com/a/apps/ba5inddz/settings/qualification-settings): click the blue "Add Data" button at the bottom and select the attributes you want to see. They then appear on the participant's contact record in Intercom.
* **If the GrowSurf participant's referral count attributes are not being updated within Intercom:**
  * Intercom can take a few minutes to show updated data. Refresh the contact to see it.


---

# 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 following URL with the `ask` and `goal` query parameters:

```
GET https://docs.growsurf.com/integrations/intercom.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 `build a script that syncs our docs to a CMS` 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.
