For the complete documentation index, see llms.txt. This page is also available as Markdown.

Getting Started for Web

For web integration, start here once you've created your GrowSurf program.

Sandbox/testing environment

To start building your referral or affiliate program in a "sandbox" environment, we recommend creating two GrowSurf separate programs (one for development and one for production).

A program, also known as campaign, is simply a referral or affiliate program. Every GrowSurf program has a unique ID that you can find in the URL or from the program's GrowSurf Universal Code. Learn more here.

Step 1: Install the GrowSurf Universal Code onto your site

Get the GrowSurf Universal Code.

The GrowSurf Universal Code is what allows referrals to be tracked and credited properly.

It's also what powers the GrowSurf window and embeddable elements to be displayed to your participants so that they can get their unique share link, click social share buttons, and check their referral stats and/or the leaderboard.

The GrowSurf Universal Code is a snippet of JavaScript that you paste into the <HEAD> of your website.

To get your program-specific GrowSurf Universal Code, follow the Installation steps in the Program Editor until you get to the instructions page (see image below).

Find your program-specific GrowSurf Universal Code in the Installation step of the Program Editor

Note:

  • Your program-specific GrowSurf Universal Code will work on any URL that shares the same origin (what's same-origin?) as the Share URL or Signup URL that you entered in the Installation step of the Program Editor. Click here for image

  • If you have Participant authentication/login enabled, you may want to set up Participant Auto Authentication.

  • To set up a development process that supports multiple environments (e.g, development, production), view this article.

Step 2: Connect integrations or use the GrowSurf API

GrowSurf provides no-code integrations (such as Stripe, HubSpot, Salesforce) to track when referred leads successfully convert. You can also use our web/mobile SDKs or REST API to integrate with GrowSurf.

Development Tool
Type
Description

Client-side

Open/close the GrowSurf window, generate referral links, track referral attribution.

Client-side

Open/close the GrowSurf window, generate referral links, track referral attribution.

Client-side

Open/close the GrowSurf window, generate referral links, track referral attribution.

Server-side

Create new participants, trigger referrals, get program data, and get participant data from a secure environment.

Step 3: Automate reward fulfillment

Set up automatic reward fulfillment and data syncing by using an integration or by using Webhooks.

Step 4: Open the GrowSurf window

The GrowSurf window is a widget that opens from within your product. It is the central command center for your program participants to share their unique link, send invites, and track the status of their referrals. It is branded, customizable, and available via web and mobile SDKs.


Troubleshooting

To troubleshoot common issues during installation, check out Help Center - Installation articles or contact GrowSurf support.

Last updated

Was this helpful?