# Growth Rail Docs

> Growth Rail is a referral and rewards platform. These docs cover the guides, first-party SDKs (JavaScript, React, React Native, iOS, Android), auth and purchase integrations, and the REST API for building referral programs into your web and mobile applications.

## Welcome

- [Overview](https://docs.growthrail.dev/llms/overview.md): Platform capabilities and the four-step referral lifecycle.

## Guides

- [Quick Start](https://docs.growthrail.dev/llms/quickstart.md): Install the SDK, initialize users, track rewards, and configure webhooks in under 15 minutes.
- [Project Setup](https://docs.growthrail.dev/llms/project-setup.md): Create, configure, and secure a project: secrets, allowed origins, and SDK setup.
- [Referral Flow](https://docs.growthrail.dev/llms/referral-flow.md): The referral lifecycle: links, click tracking, reward events, status states, banners, and deep linking.
- [Reward Logic](https://docs.growthrail.dev/llms/reward-logic.md): How reward trigger events, eligibility checks, tracking, and webhook delivery work.
- [Webhooks](https://docs.growthrail.dev/llms/webhooks.md): Set up, secure, and handle reward webhooks: payloads, retries, idempotency, and logs.
- [Campaign Setup](https://docs.growthrail.dev/llms/campaign-setup.md): Configure a campaign's referrer UI, new-user banner, branding, SDK controls, and webhooks.

## SDKs

- [JavaScript (Core)](https://docs.growthrail.dev/llms/sdk-javascript.md): The @growth-rail/core SDK: install, init, user management, referral tracking, UI, cookies.
- [React](https://docs.growthrail.dev/llms/sdk-react.md): GrowthRailProvider setup, the useGrowthRail hook, referral UI components, and error handling.
- [React Native](https://docs.growthrail.dev/llms/sdk-react-native.md): Setup, hooks, native UI components, deep linking, storage, and troubleshooting.
- [iOS (Swift)](https://docs.growthrail.dev/llms/sdk-ios.md): SwiftPM binary SDK: configure, growthRailHost, initAppUser, deep links, modal/drawer UI, and troubleshooting.
- [Android (Kotlin)](https://docs.growthrail.dev/llms/sdk-android.md): Maven Central SDK: initialize, GrowthRailOverlay, initAppUser, deep links, modal/drawer UI, and troubleshooting.

## Integrations — Auth

- [Clerk](https://docs.growthrail.dev/llms/integration-clerk.md): Use Clerk user.created as signed signup proof joined to SDK attribution.
- [Stytch](https://docs.growthrail.dev/llms/integration-stytch.md): Verify Consumer user or B2B member creation using Stytch and Svix signatures.
- [WorkOS AuthKit](https://docs.growthrail.dev/llms/integration-workos.md): Use signed WorkOS AuthKit user.created events as signup proof.
- [Logto](https://docs.growthrail.dev/llms/integration-logto.md): Use the signed PostRegister event after an Experience API signup.
- [Kinde](https://docs.growthrail.dev/llms/integration-kinde.md): Verify signed user.created JWTs against the tenant JWKS.
- [FusionAuth](https://docs.growthrail.dev/llms/integration-fusionauth.md): Verify signed application registration-complete events.
- [Frontegg](https://docs.growthrail.dev/llms/integration-frontegg.md): Verify signed interactive signup and explicit user-created events.
- [Okta](https://docs.growthrail.dev/llms/integration-okta.md): Handle verified and batched user.lifecycle.create Event Hook deliveries.

## Integrations — Purchases

- [Stripe](https://docs.growthrail.dev/llms/integration-stripe.md): Attribute referrals to Stripe billing via webhooks and customer metadata — no conversion code required.
- [RevenueCat](https://docs.growthrail.dev/llms/integration-revenuecat.md): Attribute mobile subscription revenue to referrals via RevenueCat webhooks and the gr_ucc attribute.
- [Lemon Squeezy](https://docs.growthrail.dev/llms/integration-lemon-squeezy.md): Attribute paid orders using signed webhooks and checkout custom data.
- [Paddle](https://docs.growthrail.dev/llms/integration-paddle.md): Attribute completed Paddle Billing transactions using customData.
- [Adapty](https://docs.growthrail.dev/llms/integration-adapty.md): Attribute mobile purchase starts and trial conversions from Adapty.
- [PayPal](https://docs.growthrail.dev/llms/integration-paypal.md): Attribute completed PayPal captures with certificate-based webhook verification.
- [Polar](https://docs.growthrail.dev/llms/integration-polar.md): Attribute paid Polar orders using Standard Webhooks and checkout metadata.

## REST API

- [Authentication](https://docs.growthrail.dev/llms/authentication.md): Project Secret authentication for both client SDK and REST API server-to-server calls.
- [v1 REST API](https://docs.growthrail.dev/llms/rest-api.md): Server-to-server REST API described by an OpenAPI spec; authenticated with the Project Secret.

## Resources

- [OpenAPI specification](https://api.growthrail.dev/openapi/public.json): Machine-readable spec for the full REST API endpoint catalogue.
- [Full documentation](https://docs.growthrail.dev/llms-full.txt): Every page above concatenated into one file for one-shot ingestion.