> 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/embeddables.md).

# Embeddables

Add referral tracking to your Embeddables flow to automatically recognize new leads that come through referrals.

{% hint style="info" %}
**Please note the following requirement to make Embeddables work with GrowSurf**:

* The GrowSurf Universal Code must be installed on the webpage where your Embeddable is published. Your Embeddable runs on that page, so it can hand the email address straight to GrowSurf.
  {% endhint %}

## Prep Your Flow <a href="#prep-your-flow" id="prep-your-flow"></a>

If you have an Embeddables flow published on your website that you want to add referral tracking to, follow these instructions:‌

**Step 1:** Open the GrowSurf campaign editor and navigate to the *Installation* tab.‌

**Step 2:** Continue through the installation steps until you reach the referral tracking method section.​‌

**Step 3:** Click the Embeddables icon and follow your campaign-specific instructions. You will copy a block of JavaScript and paste it into an Embeddables Action.‌

**Step 4:** Once your Embeddables flow has been prepped, continue on with the rest of the GrowSurf installation process.‌

## How It Works <a href="#how-it-works" id="how-it-works"></a>

An Embeddable renders inline on your own page rather than in an iframe, and an Embeddables Action runs in that same page. So the Action can read the respondent's User Data and call GrowSurf directly.

In Embeddables, open the Logic card, go to *Triggers*, and add a trigger for the moment you have the respondent's email address — typically a click on the button that submits it. Create an Action on that trigger and paste in the code from the GrowSurf campaign editor. Then publish your Embeddable.

The Action reads these User Data keys, in order, and uses the first one it finds:

* Email address: `email`
* First name: `first_name`, `firstName`, or the first word of `full_name` / `fullName` / `name`
* Last name: `last_name`, `lastName`, or the second word of `full_name` / `fullName` / `name`

An answer that is not text — a multi-select, a file — is skipped rather than stored as someone's name. If your flow stores the email address under a different key, rename it in Embeddables or edit the `email` line in the Action to match.

## Additional Tips <a href="#additional-tips" id="additional-tips"></a>

* Pick a trigger that fires once the email address has actually been entered. A trigger on flow load runs before the respondent has typed anything, so nothing is sent to GrowSurf.
* While following your campaign-specific Embeddables instructions in the GrowSurf campaign editor, you may skip any steps that you have already completed from previous setup in Embeddables.
* If you run into issues or have any questions, please reach out to [GrowSurf support](https://support.growsurf.com/) for assistance.


---

# 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.growsurf.com/integrations/embeddables.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.