# 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. - [Google Tag Manager](https://docs.growsurf.com/getting-started/google-tag-manager.md): These instructions will show you step-by-step how to install GrowSurf onto Google Tag Manager. - [Participant Auto Authentication](https://docs.growsurf.com/getting-started/participant-auto-authentication.md): If your program is configured to have participants login/authenticate, 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): Use AI agents to create, configure, and verify GrowSurf referral and affiliate programs. - [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): Refer to the below response code glossary to help you troubleshoot any errors when using the JavaScript SDK or Embeddable Elements. - [iOS SDK (Beta)](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 (Beta)](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 Response Codes](https://docs.growsurf.com/developer-tools/rest-api/api-response-codes.md): Refer to the below response code glossary to help you troubleshoot any 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 automatically fulfill rewards or update users in your database. - [Securing Your Webhooks (optional)](https://docs.growsurf.com/developer-tools/webhooks/securing-your-webhooks.md): This is an optional step. For security purposes, you can add a webhook secret to limit requests sent to your webhook endpoint to those only coming 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 any custom data to Participants and Rewards to make your referral program even more dynamic. - [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): We'll walk you through adding personalized referral program messaging to your ActiveCampaign emails. - [Adjust](https://docs.growsurf.com/integrations/adjust.md): Preserve GrowSurf referral attribution in Adjust links for native mobile app referrals. - [Amplitude](https://docs.growsurf.com/integrations/amplitude.md): Track and analyze referral program data alongside product analytics in Amplitude. - [AppsFlyer](https://docs.growsurf.com/integrations/appsflyer.md): Preserve GrowSurf referral attribution in AppsFlyer OneLink campaigns for native mobile app referrals. - [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): We'll walk you through adding personalized referral program messaging to your AWeber emails. - [Bask Health](https://docs.growsurf.com/integrations/bask-health.md): Bask Health customers can integrate a customer referral program with minimal effort. - [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): We'll walk you through adding personalized referral program messaging to your Bento emails. - [Branch](https://docs.growsurf.com/integrations/branch.md): Preserve GrowSurf referral attribution in Branch links for native mobile app referrals. - [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): We'll walk you through adding personalized referral program messaging 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): We'll walk you through adding personalized referral program messaging to your Campaign Monitor emails. - [Chargebee](https://docs.growsurf.com/integrations/chargebee.md): Trigger referrals on new Chargebee charges or automatically apply Chargebee coupons or credits as rewards. - [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): We'll walk you through adding personalized referral program messaging to your Constant Contact emails. - [ConvertKit](https://docs.growsurf.com/integrations/convertkit.md): Update ConvertKit subscribers with their unique share link and referrer information. - [Tutorials](https://docs.growsurf.com/integrations/convertkit/tutorials.md): We'll walk you through adding personalized referral program messaging to your ConvertKit emails. - [Customer.io](https://docs.growsurf.com/integrations/customerio.md): Add/update Customer.io people with their unique share link and referrer information. - [Tutorials](https://docs.growsurf.com/integrations/customerio/tutorials.md): We'll walk you through adding personalized referral program messaging 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): We'll walk you through adding personalized referral program messaging 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): We'll walk you through adding personalized referral program messaging to your EmailOctopus emails. - [Fullstory](https://docs.growsurf.com/integrations/fullstory.md): Track and analyze referral 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): We'll walk you through adding personalized referral program messaging 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 program data alongside product analytics in Google Analytics. - [Heap](https://docs.growsurf.com/integrations/heap.md): Track and analyze referral 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): Trigger referrals on HubSpot deal stage changes and update/add HubSpot contacts with their unique share link and referrer information. - [Tutorials](https://docs.growsurf.com/integrations/hubspot/tutorials.md): We'll walk you through adding personalized referral program messaging 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): We'll walk you through adding personalized referral program messaging to your Intercom 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): We'll walk you through adding personalized referral program messaging 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): We'll walk you through adding personalized referral program messaging 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): We'll walk you through adding personalized referral program messaging 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): We'll walk you through adding personalized referral program messaging 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): We'll walk you through adding personalized referral program messaging 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 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 650+ 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. - [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 program data alongside product analytics in Pendo. - [PostHog](https://docs.growsurf.com/integrations/posthog.md): Track and analyze referral program data alongside product analytics in PostHog. - [Recurly](https://docs.growsurf.com/integrations/recurly.md): Trigger referrals on new Recurly charges or automatically apply Recurly coupons or credits as rewards. - [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): We'll walk you through adding personalized referral program messaging to your Salesforce emails. - [Segment](https://docs.growsurf.com/integrations/segment.md): Track and analyze referral 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): We'll walk you through adding personalized referral program messaging to your SendGrid emails. - [Singular](https://docs.growsurf.com/integrations/singular.md): Preserve GrowSurf referral attribution in Singular links for native mobile app referrals. - [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. - [Tango Card](https://docs.growsurf.com/integrations/tango-card.md): Automatically fulfill gift card rewards where winners can pick from top retailers (e.g, Amazon, Starbucks) and/or donate to non-profits. - [Typeform](https://docs.growsurf.com/integrations/typeform.md): Add referral tracking to your Typeform form to automatically recognize new leads that come through referrals. - [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 3,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 act as traffic cops for your data. Zaps stop immediately when the requirements of a Filter are not met. - [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): Collect W-9 and W-8 tax forms from your participants, hold rewards and payouts until they're cleared, and file 1099 forms — all inside GrowSurf. --- # 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, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.growsurf.com/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.