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

Getting Started for Native Mobile

For native iOS and Android app integration, start here once you've created your GrowSurf program.

Use cases

The GrowSurf mobile SDKs (iOS and Android) cover two primary use-cases:

  1. Track referrals to ensure that attribution persists in referral links through app installation so that the referrer receives credit when their referral signs up.

  2. Generate referral links for your logged-in users to give them a way to share their referral link and track the status of their referrals and rewards.


How the mobile flow works

  1. Enable Mobile SDK access for your GrowSurf program.

  2. Install the native SDK.

  3. Create a participant token for your logged-in app user by calling the backend create a mobile participant token, pass it to the app, then store it in the SDK. This creates a new participant or returns an existing one.

  4. The user clicks a "Refer and Earn" button in the UI, which opens the GrowSurf window via presentGrowSurfWindow(). The user's referral link is displayed to them, along with other stats.

  5. The user shares their referral link with a friend, who opens the link on their phone. The GrowSurf SDK will preserve referral attribution so that it survives during the journey where the referred friend opens or installs the app. On iOS, surviving a cold install (the friend installs the app from the link, then opens it) is deferred deep linking and depends on your attribution provider's deferred setup — see iOS SDK Attribution Providers.

  6. When the referred user signs up, they will be added as a new referred participant record when you call addReferredParticipant().


Next steps

Look at the iOS SDK or Android SDK docs for next steps:

iOS SDK (Beta)Android SDK (Beta)

Last updated

Was this helpful?