# GrowSurf Docs

## GrowSurf Docs

- [Welcome](https://docs.growsurf.com/readme.md)
- [Getting Started for Web](https://docs.growsurf.com/getting-started.md): For web integration, start here once you've created your GrowSurf program.
- [Referral Program Workflow](https://docs.growsurf.com/getting-started/referral-program-workflow.md): Follow a referred friend from a shared link through signup, the action that counts, and reward approval and delivery.
- [Affiliate Program Workflow](https://docs.growsurf.com/getting-started/affiliate-program-workflow.md): Follow a sale from an affiliate's link through commission, review, and payout to what the affiliate sees.
- [Google Tag Manager](https://docs.growsurf.com/getting-started/google-tag-manager.md): Install GrowSurf with Google Tag Manager, step by step.
- [Participant Auto Authentication](https://docs.growsurf.com/getting-started/participant-auto-authentication.md): If your program is configured to have participants log in, you can set up Participant Auto Authentication to automatically log participants into their browser.
- [Getting Started for Native Mobile](https://docs.growsurf.com/getting-started-for-native-mobile.md): For native iOS and Android app integration, start here once you've created your GrowSurf program.
- [Build with AI](https://docs.growsurf.com/build-with-ai.md): Copy prompts that help an AI assistant create your GrowSurf account and build a draft referral or affiliate program for you to review.
- [Embeddable Elements](https://docs.growsurf.com/developer-tools/embeddable-elements.md): Embedded elements are UI elements you can embed into your web app to create a whitelabel referral experience within your own user portal. Referral links are auto-generated for your users.
- [JavaScript SDK](https://docs.growsurf.com/developer-tools/javascript-sdk.md): Use the JavaScript SDK to interact with your GrowSurf program and participant data.
- [Tutorials](https://docs.growsurf.com/developer-tools/javascript-sdk/tutorials.md): How to implement the GrowSurf JavaScript SDK in common use-case scenarios.
- [Single Page Applications](https://docs.growsurf.com/developer-tools/javascript-sdk/single-page-applications.md): View sample code and troubleshooting tips for integrating GrowSurf into common JavaScript frameworks such as React and Vue.
- [API Reference](https://docs.growsurf.com/developer-tools/javascript-sdk/api-reference.md): This reference documents the GrowSurf JavaScript SDK, including all available public methods and examples of each.
- [Client Response Codes](https://docs.growsurf.com/developer-tools/javascript-sdk/api-response-codes.md): Use these codes to troubleshoot errors when using the JavaScript SDK or Embeddable Elements.
- [iOS SDK](https://docs.growsurf.com/developer-tools/ios-sdk.md): Install and use the GrowSurf iOS SDK to capture referral attribution, create referred participants, and show a native referral window in your app.
- [Attribution Providers](https://docs.growsurf.com/developer-tools/ios-sdk/attribution-providers.md): Configure direct deep links and attribution adapters for the GrowSurf iOS SDK.
- [API Reference](https://docs.growsurf.com/developer-tools/ios-sdk/api-reference.md): Public methods, attribution adapters, and models exposed by the GrowSurf iOS SDK.
- [Models and Errors](https://docs.growsurf.com/developer-tools/ios-sdk/models-and-errors.md): Models, callbacks, stores, and errors exposed by the GrowSurf iOS SDK.
- [Android SDK](https://docs.growsurf.com/developer-tools/android-sdk.md): Install and use the GrowSurf Android SDK to capture referral attribution, create referred participants, and show a native referral window in your app.
- [Attribution Providers](https://docs.growsurf.com/developer-tools/android-sdk/attribution-providers.md): Configure direct deep links, Google Play Install Referrer, and attribution adapters for the GrowSurf Android SDK.
- [API Reference](https://docs.growsurf.com/developer-tools/android-sdk/api-reference.md): Public methods, Java callback overloads, attribution adapters, and models exposed by the GrowSurf Android SDK.
- [Models and Errors](https://docs.growsurf.com/developer-tools/android-sdk/models-and-errors.md): Models, callbacks, stores, interfaces, and errors exposed by the GrowSurf Android SDK.
- [REST API](https://docs.growsurf.com/developer-tools/rest-api.md): Use the REST API to create and manage your GrowSurf programs, participants, referrals, rewards, webhooks, and team settings from a secure server-side environment.
- [Tutorials](https://docs.growsurf.com/developer-tools/rest-api/tutorials.md): How to implement the GrowSurf REST API in common use-case scenarios.
- [Objects](https://docs.growsurf.com/developer-tools/rest-api/api-objects.md)
- [API Reference](https://docs.growsurf.com/developer-tools/rest-api/api-reference.md): This reference documents the GrowSurf REST API, including all available public methods and examples of each.
- [API Guidelines](https://docs.growsurf.com/developer-tools/rest-api/api-guidelines.md): Follow these standard guidelines when interacting with GrowSurf APIs.
- [API Lifecycle Policy](https://docs.growsurf.com/developer-tools/rest-api/api-lifecycle.md): Learn how GrowSurf versions the REST API and guarantees notice before breaking removals.
- [API Response Codes](https://docs.growsurf.com/developer-tools/rest-api/api-response-codes.md): Use these codes to troubleshoot API errors.
- [API Libraries](https://docs.growsurf.com/developer-tools/rest-api/api-libraries.md): Official GrowSurf API libraries for popular languages like TypeScript, Python, PHP, Ruby, and Java.
- [Webhooks](https://docs.growsurf.com/developer-tools/webhooks.md): Webhooks send data to your server when important events occur in your referral/affiliate program. This lets you deliver rewards automatically or update users in your database.
- [Securing Your Webhooks (optional)](https://docs.growsurf.com/developer-tools/webhooks/securing-your-webhooks.md): Add a webhook secret so your endpoint can confirm each request comes from GrowSurf.
- [Examples](https://docs.growsurf.com/developer-tools/webhooks/examples.md): How to implement Webhooks for your GrowSurf program.
- [Events Reference](https://docs.growsurf.com/developer-tools/webhooks/events-reference.md): Below are sample request payloads you will receive based on the webhook event types you have selected for your program.
- [Metadata](https://docs.growsurf.com/developer-tools/metadata.md): Use metadata to save your own data on participants and rewards.
- [ActiveCampaign](https://docs.growsurf.com/integrations/activecampaign.md): Update ActiveCampaign contacts with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/activecampaign/tutorials.md): Add personalized referral messages to your ActiveCampaign emails.
- [Adjust](https://docs.growsurf.com/integrations/adjust.md): Keep the GrowSurf referral code on Adjust links so installs credit the right referrer.
- [Amplitude](https://docs.growsurf.com/integrations/amplitude.md): Track and analyze referral or affiliate program data alongside product analytics in Amplitude.
- [AppsFlyer](https://docs.growsurf.com/integrations/appsflyer.md): Keep the GrowSurf referral code on AppsFlyer OneLinks so installs credit the right referrer.
- [AWeber](https://docs.growsurf.com/integrations/aweber.md): Update/add AWeber subscribers with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/aweber/tutorials.md): Add personalized referral messages to your AWeber emails.
- [Bask Health](https://docs.growsurf.com/integrations/bask-health.md): Add a customer referral program to your Bask Health Storefront.
- [Bento](https://docs.growsurf.com/integrations/bento.md): Update Bento people with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/bento/tutorials.md): Add personalized referral messages to your Bento emails.
- [Branch](https://docs.growsurf.com/integrations/branch.md): Keep the GrowSurf referral code on Branch links so installs credit the right referrer.
- [Braze](https://docs.growsurf.com/integrations/braze.md): Sync GrowSurf participants and referral data to Braze user profiles.
- [Brevo](https://docs.growsurf.com/integrations/brevo.md): Update Brevo contacts with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/brevo/tutorials.md): Add personalized referral messages to your Brevo emails.
- [Cal.com](https://docs.growsurf.com/integrations/cal.com.md): Add referral tracking to your Cal.com form to automatically recognize new leads that come through referrals.
- [Calendly](https://docs.growsurf.com/integrations/calendly.md): Add referral tracking to your Calendly form to automatically recognize new leads that come through referrals.
- [Campaign Monitor](https://docs.growsurf.com/integrations/campaign-monitor.md): Update/add Campaign Monitor subscribers with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/campaign-monitor/tutorials.md): Add personalized referral messages to your Campaign Monitor emails.
- [Chargebee](https://docs.growsurf.com/integrations/chargebee.md): For referral programs, trigger referrals on new Chargebee payments or automatically apply Chargebee coupons or credits as rewards. For affiliate programs, automatically generate commissions on sales.
- [Constant Contact](https://docs.growsurf.com/integrations/constant-contact.md): Update Constant Contact contacts with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/constant-contact/tutorials.md): Add personalized referral messages to your Constant Contact emails.
- [Customer.io](https://docs.growsurf.com/integrations/customerio.md): Add or update Customer.io profiles with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/customerio/tutorials.md): Add personalized referral messages to your Customer.io emails.
- [Drip](https://docs.growsurf.com/integrations/drip.md): Update/add Drip people with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/drip/tutorials.md): Add personalized referral messages to your Drip emails.
- [EmailOctopus](https://docs.growsurf.com/integrations/emailoctopus.md): Update EmailOctopus contacts with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/emailoctopus/tutorials.md): Add personalized referral messages to your EmailOctopus emails.
- [Embeddables](https://docs.growsurf.com/integrations/embeddables.md): Add referral tracking to your Embeddables flow to automatically recognize new leads that come through referrals.
- [Formsort](https://docs.growsurf.com/integrations/formsort.md): Add referral tracking to your Formsort flow to automatically recognize new leads that come through referrals.
- [Fullstory](https://docs.growsurf.com/integrations/fullstory.md): Track and analyze referral or affiliate program data alongside product analytics in Fullstory.
- [GetResponse](https://docs.growsurf.com/integrations/getresponse.md): Update GetResponse subscribers with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/getresponse/tutorials.md): Add personalized referral messages to your GetResponse emails.
- [Google Ads](https://docs.growsurf.com/integrations/google-ads.md): Retarget referred visitors and track referral events in Google Ads to optimize your ad campaigns.
- [Google Analytics](https://docs.growsurf.com/integrations/google-analytics.md): Track and analyze referral or affiliate program data alongside product analytics in Google Analytics.
- [Heap](https://docs.growsurf.com/integrations/heap.md): Track and analyze referral or affiliate program data alongside product analytics in Heap.
- [Help Scout](https://docs.growsurf.com/integrations/help-scout.md): View Help Scout customers' referral information right within Help Scout.
- [HubSpot](https://docs.growsurf.com/integrations/hubspot.md): Sync GrowSurf participant data to HubSpot contacts and trigger referrals when deals reach a selected stage.
- [Tutorials](https://docs.growsurf.com/integrations/hubspot/tutorials.md): Add personalized referral messages to your HubSpot emails.
- [Intercom](https://docs.growsurf.com/integrations/intercom.md): Update Intercom contacts with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/intercom/tutorials.md): Add personalized referral messages to your Intercom emails.
- [Jotform](https://docs.growsurf.com/integrations/jotform.md): Add referral tracking to your Jotform form to automatically recognize new leads that come through referrals.
- [Kit](https://docs.growsurf.com/integrations/convertkit.md): Update Kit subscribers with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/convertkit/tutorials.md): Add personalized referral messages to your Kit emails.
- [Klaviyo](https://docs.growsurf.com/integrations/klaviyo.md): Update Klaviyo contacts with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/klaviyo/tutorials.md): Add personalized referral messages to your Klaviyo emails.
- [LinkedIn Ads](https://docs.growsurf.com/integrations/linkedin-ads.md): Retarget referred visitors and track referral events in LinkedIn Ads to optimize your ad campaigns.
- [Loops](https://docs.growsurf.com/integrations/loops.md): Sync GrowSurf participants and referral data to a Loops mailing list.
- [Tutorials](https://docs.growsurf.com/integrations/loops/tutorials.md): Add GrowSurf referral links and progress data to Loops emails.
- [Mailchimp](https://docs.growsurf.com/integrations/mailchimp.md): Update Mailchimp contacts with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/mailchimp/tutorials.md): Add personalized referral messages to your Mailchimp emails.
- [MailerLite](https://docs.growsurf.com/integrations/mailerlite.md): Update MailerLite subscribers with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/mailerlite/tutorials.md): Add personalized referral messages to your MailerLite emails.
- [Mailjet](https://docs.growsurf.com/integrations/mailjet.md): Update Mailjet contacts with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/mailjet/tutorials.md): Add personalized referral messages to your Mailjet emails.
- [Make](https://docs.growsurf.com/integrations/integromat.md): Make is a code-free tool that lets you connect to thousands of apps to automate rewards or sync data.
- [Tutorials](https://docs.growsurf.com/integrations/integromat/tutorials.md): We'll walk you through creating Make Scenarios.
- [Marketo](https://docs.growsurf.com/integrations/marketo.md): Update/Add Marketo people with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/marketo/tutorials.md): Add personalized referral messages to your Marketo emails.
- [Meta (Facebook) Ads](https://docs.growsurf.com/integrations/meta-ads.md): Retarget referred visitors and track referral events in Meta (Facebook) Ads to optimize your ad campaigns.
- [Mixpanel](https://docs.growsurf.com/integrations/mixpanel.md): Track and analyze referral or affiliate program data alongside product analytics in Mixpanel.
- [Pabbly Connect](https://docs.growsurf.com/integrations/pabbly-connect.md): Pabbly Connect is a code-free tool that lets you connect to 2,000+ apps to automate rewards or sync data.
- [Tutorials](https://docs.growsurf.com/integrations/pabbly-connect/tutorials.md): We'll walk you through creating Pabbly Connect workflows.
- [Paperform](https://docs.growsurf.com/integrations/paperform.md): Add referral tracking to your Paperform form to automatically recognize new leads that come through referrals.
- [PayPal](https://docs.growsurf.com/integrations/paypal.md): For referral programs, trigger referrals on new PayPal payments and automatically send one-time payouts as rewards. For affiliate programs, automate recurring payouts to affiliates.
- [Pendo](https://docs.growsurf.com/integrations/pendo.md): Track and analyze referral or affiliate program data alongside product analytics in Pendo.
- [PostHog](https://docs.growsurf.com/integrations/posthog.md): Track and analyze referral or affiliate program data alongside product analytics in PostHog.
- [Recurly](https://docs.growsurf.com/integrations/recurly.md): For referral programs, trigger referrals on new Recurly payments or automatically apply Recurly coupons or credits as rewards. For affiliate programs, automatically generate commissions on sales.
- [Resend](https://docs.growsurf.com/integrations/resend.md): Sync GrowSurf participants and referral data to a Resend Segment.
- [Tutorials](https://docs.growsurf.com/integrations/resend/tutorials.md): Add GrowSurf referral links and progress data to Resend Broadcasts.
- [Salesforce](https://docs.growsurf.com/integrations/salesforce.md): Trigger referrals when Salesforce records match the conditions you choose and update/add Salesforce contact field labels with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/salesforce/tutorials.md): Add personalized referral messages to your Salesforce emails.
- [Segment](https://docs.growsurf.com/integrations/segment.md): Track and analyze referral or affiliate program data alongside product analytics in Segment.
- [SendGrid](https://docs.growsurf.com/integrations/sendgrid.md): Update/add SendGrid contacts with their unique share link and referrer information.
- [Tutorials](https://docs.growsurf.com/integrations/sendgrid/tutorials.md): Add personalized referral messages to your SendGrid emails.
- [Singular](https://docs.growsurf.com/integrations/singular.md): Keep the GrowSurf referral code on Singular links so installs credit the right referrer.
- [Slack](https://docs.growsurf.com/integrations/slack.md): Get notified in Slack when a referral event happens.
- [Stripe](https://docs.growsurf.com/integrations/stripe.md): For referral programs, trigger referrals on new Stripe charges or automatically apply Stripe coupons or credits as rewards. For affiliate programs, automatically generate commissions on sales.
- [Stripe Marketplace app](https://docs.growsurf.com/integrations/stripe/stripe-marketplace.md): See referrals, referred revenue, and program activity in your Stripe Dashboard.
- [Tally](https://docs.growsurf.com/integrations/tally.md): Add referral tracking to your Tally form to automatically recognize new leads that come through referrals.
- [Tango Card](https://docs.growsurf.com/integrations/tango-card.md): Automatically send gift card rewards where winners can pick from top retailers (e.g, Amazon, Starbucks) and/or donate to non-profits.
- [Tremendous](https://docs.growsurf.com/integrations/tremendous.md): Send referral rewards automatically with Tremendous. Winners pick their own gift card or prepaid Visa from hundreds of brands.
- [Typeform](https://docs.growsurf.com/integrations/typeform.md): Add referral tracking to your Typeform form to automatically recognize new leads that come through referrals.
- [Wise](https://docs.growsurf.com/integrations/wise.md): Send affiliate payouts worldwide with Wise. Affiliates claim payouts in their Wise account and local currency.
- [X (Twitter) Ads](https://docs.growsurf.com/integrations/x-ads.md): Retarget referred visitors and track referral events in X (Twitter) Ads to optimize your ad campaigns.
- [Zapier](https://docs.growsurf.com/integrations/zapier.md): Zapier is a code-free tool that lets you connect to 5,000+ apps to automate rewards or sync data.
- [Tutorials](https://docs.growsurf.com/integrations/zapier/tutorials.md): We'll walk you through creating Zapier Zaps.
- [Using Filters](https://docs.growsurf.com/integrations/zapier/using-filters.md): Zapier Filters are extra steps that stop a Zap unless the data meets the conditions you set.
- [Troubleshooting](https://docs.growsurf.com/integrations/zapier/troubleshooting.md): If you are experiencing issues with your Zapier setup, you can use Zapier's Zap History feature to help.
- [Tax Forms and 1099 Filing](https://docs.growsurf.com/compliance/tax-forms-and-1099-filing.md): For US companies: collect W-9 and W-8 forms, pause rewards when tax info is due, and file 1099-NEC and 1099-MISC forms.


---

# 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
This site has an agentic ask interface you may use to 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/index.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 `automate deployments from our CI pipeline` 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.