Introduction
Learn how to integrate Referral Engine and start growing your user base through referrals.
Referral Engine is a complete platform for building referral programs. Whether you're building a mobile app, web application, or both, we handle the complex parts—tracking, attribution, fraud detection, and analytics—so you can focus on growing your business.
New to referral programs?
Check out our How It Works page for a high-level overview of how referral programs drive growth.
Why Referral Engine?
- Mobile attribution that works — We handle deferred deep links, cross-device tracking, and app-not-installed flows automatically.
- 5-minute integration — Drop in our SDK, configure your rewards, and you're live.
- Built-in fraud detection — Protect your program from fake referrals and abuse.
- Real-time analytics — See your referral funnel, top referrers, and conversion rates as they happen.
Quick Start
Get up and running in three steps:
1. Create a campaign
Log into your dashboard and create a new campaign. Define your reward trigger (signup, purchase, etc.) and reward amounts.
2. Install the SDK
npm install @referral-engine/sdk3. Generate referral links
app.tstypescript
import { ReferralEngine } from '@referral-engine/sdk'
const referral = new ReferralEngine({
apiKey: 'your-api-key',
campaignId: 'your-campaign-id'
})
// Generate a unique link for your user
const link = await referral.createLink({
userId: 'user-123',
metadata: { plan: 'pro' }
})
console.log(link.url) // https://refer.yourapp.com/abc123The SDK handles caching automatically. Calling
createLink with the same userId will return the existing link rather than creating a new one.