Integration Guide

How to Sync GrowSurf Referral Data to Braze User Profiles

Connect Braze once, and every participant’s referral link, referral counts, and milestone progress stays current on their Braze profile.

Want the full setup walkthrough?

Use these docs for exact setup steps, supported fields, and troubleshooting.

GrowSurf Braze setup guide Braze partner docs for GrowSurf

GrowSurf writes referral data straight onto Braze user profiles. Participants are matched by email address, so the profile your team already segments on picks up the participant’s referral link, referral counts, referrer details, and milestone progress.

Use this guide when you want referral data available in Braze for segmentation and Liquid personalization without building the sync yourself. It works the same on a referral program and an affiliate program.

Integration Steps

Create a Braze REST API key with the users.track permission

In Braze, open Settings > APIs and Identifiers > API Keys and select Create API Key. Make a dedicated key for GrowSurf, enable the users.track permission, and copy it. On the same tab, note the REST endpoint Braze shows you — something like https://rest.iad-01.braze.com or https://rest.fra-01.braze.eu. You need both pieces in the next step.

Find Braze in your GrowSurf program

Searching for Braze in the GrowSurf Program Editor integrations list — Search the integrations list in Program Editor > 4. Options > Integrations.

Connect Braze before you import participants. Everyone who joins or gets referred after that syncs on their own.

Select your REST endpoint and paste the key

The Braze REST endpoint dropdown and API key field in GrowSurf — Pick the instance that matches the REST endpoint you noted in Braze, then paste the key.

Pick the instance that matches your Braze REST endpoint — US-01 goes with rest.iad-01, for example — paste the key, and select Submit. GrowSurf stores the key securely and does not show it again. Connecting does not call Braze; the first participant sync is what confirms the endpoint, the key, and the permission all line up.

Know which attributes land on the profile

GrowSurf writes 15 custom attributes, each prefixed with grsf_:

GrowSurf data	Attribute key	Type	What it holds
Share URL	`grsf_share_url`	String	The participant’s unique referral link
Participant ID	`grsf_participant_id`	String	The participant’s GrowSurf ID
Referral Status	`grsf_referral_status`	String	`CREDIT_PENDING`, `CREDIT_AWARDED`, or `CREDIT_EXPIRED`
Participant First Name	`grsf_participant_first_name`	String	The participant’s first name
Participant Last Name	`grsf_participant_last_name`	String	The participant’s last name
Referrer First Name	`grsf_referrer_first_name`	String	The referrer’s first name, when there is one
Referrer Last Name	`grsf_referrer_last_name`	String	The referrer’s last name, when there is one
Referrer Email	`grsf_referrer_email`	String	The referrer’s email, when there is one
Total Referral Count	`grsf_total_referral_count`	Number	All-time referral count
Monthly Referral Count	`grsf_monthly_referral_count`	Number	Referral count for the current month
Previous Monthly Referral Count	`grsf_prev_monthly_referral_count`	Number	Referral count for the previous month
Next Milestone	`grsf_next_milestone`	String	The next milestone message, on programs with milestone rewards
Next Monthly Milestone	`grsf_next_monthly_milestone`	String	The next monthly milestone message, when there is one
Total Invite Count	`grsf_total_invite_count`	Number	All-time invite count
Total Impression Count	`grsf_total_impression_count`	Number	All-time referral-link view count

The first sync writes all 15. After that only changed attributes go across, and a string attribute that becomes empty is cleared in Braze rather than left stale.

Confirm the data landed

In Braze, open Audience > User Search and look up a participant by email. The grsf_ attributes appear once the first sync runs. If the program already has participants, use the existing-participant sync options to push their current referral data across.

Code Snippets

Once the attributes are on the profile, reference them in any Braze message with Liquid:

<p>Your referral link:</p>
<a href="{{custom_attribute.${grsf_share_url}}}">{{custom_attribute.${grsf_share_url}}}</a>
<p>You have {{custom_attribute.${grsf_total_referral_count}}} referrals so far.</p>

Braze wraps custom attribute names in ${}. Keep the grsf_ names exactly as GrowSurf creates them or the tag renders empty.

Tips

Connect Braze before the first import

The sync starts when the integration is connected. Connecting first means you never have to backfill a batch of participants by hand.

One email, one profile

Braze profiles are matched by email. If the same person is a participant in two connected GrowSurf programs, the most recent sync wins for the grsf_ attributes on that profile.

Check the activity log when one person looks wrong

A participant’s GrowSurf activity log records each sync and the reason for any failure. That is faster than re-running an export when only one profile is off.

FAQ

Does GrowSurf send custom events to Braze?

No. The integration writes profile attributes only — no custom events, purchases, or subscription changes.

Which Braze permission does the key need?

users.track. A key without it connects fine but fails on the first sync, so create the key with that permission enabled.

Does this work on an affiliate program?

Yes. The Braze sync runs on both referral programs and affiliate programs.

How to Sync GrowSurf Referral Data to Braze User Profiles

Integration Steps

Create a Braze REST API key with the users.track permission

Find Braze in your GrowSurf program

Select your REST endpoint and paste the key

Know which attributes land on the profile

Confirm the data landed

Code Snippets

Tips

Connect Braze before the first import

One email, one profile

Check the activity log when one person looks wrong

How to Build Braze Segments from GrowSurf Referral Data

How to Trigger Customer.io Journeys from GrowSurf Referral Data

How to Build Klaviyo Referral Segments with GrowSurf

FAQ

Does GrowSurf send custom events to Braze?

Which Braze permission does the key need?

Does this work on an affiliate program?

Turn word of mouth into steady growthfrom your customers

Built for lean teams,scaled for category leaders

View GrowSurfCustomer Examples

Turn word of mouth into steady growth
from your customers

Built for lean teams,
scaled for category leaders

View GrowSurf
Customer Examples