Projects
Create a Project, use its Sandbox and Live twins, find its credentials, and set its referral events, custom units, and integrations.
A Project is one app or store that you connect to RefRef. Participants, Programs, Events, referrals, and Rewards belong to one Project and never cross to another one. Use one Project for each product that has its own users.
Create a Project
Owners and admins create Projects:
- First Project. After sign-up, the Console asks for the Project name and the Website URL, and a few questions about your use case, app type, and payment provider. The answers to those questions only help us; they change no setting.
- More Projects. Open the Projects page and select Create Project. Enter the Project name and the Project URL.
The Project URL is where RefRef sends a visitor whose referral link does not count, for example when the referrer's enrollment ended.
Sandbox and Live
Each Project is created as a pair:
| Project | Use |
|---|---|
| Live | Real customers, real Rewards, and real deliveries |
| Sandbox | Tests. Billing deliveries and payouts go through a simulated provider and move no money. |
Switch between them with the Live | Sandbox toggle in the Console header. Each Project of the pair has its own ID, slug, client ID, client secret, participants, Programs, custom units, referral events, integrations, and data. Nothing copies from Sandbox to Live: when your tests pass, create the same configuration in the Live Project.
A Sandbox API key reaches only Sandbox Projects, and a Live key only Live Projects.
Credentials
| Credential | Where in the Console | Used for |
|---|---|---|
| Project ID | A Program's Install tab, under Is it connected? | Every API call and the Widget |
| Client secret | Developers → Secrets, or Settings → Secrets (owners and admins) | Signing Widget tokens on your backend |
| API key | Developers → API keys (owners and admins) | Your backend's API calls, in X-Api-Key |
Keep the client secret and API keys on your server. Never put them in browser code.
Rotate the client secret
If the client secret leaks, an owner or admin can replace it: open Developers → Secrets or Settings → Secrets and click Rotate secret. The Console shows the new secret; copy it to your backend. The client ID does not change.
The old secret stops working at once. RefRef refuses the Widget tokens that your backend signed with it, and the Widget shows no referral data until your backend signs with the new secret. A referral click that is on its way from the referral link to your landing page at that moment is not captured. Rotate one Project at a time: the Live and Sandbox Projects have separate secrets.
Settings
Open the Project's Settings:
| Tab | What you set |
|---|---|
| General | The Project name and URL, and the Referral events: the event types that can create a referral |
| Secrets | The client ID and client secret |
| Custom units | The things that your product grants as custom Rewards, such as "MB of storage" or "Pro month" |
| Integrations | Billing connections (Stripe, Dodo Payments, Paddle, Polar, RevenueCat), the Sandbox simulator, and store connections |
| Data requests | Customer data requests from a connected store (owners only) |
Referral events
The referral events are the Project's qualifying event types. Check signup, purchase, or both, or add a custom event type that starts with custom_. At least one is required. A change applies to Events that arrive after it. See Events.
Custom units
Select Add unit, enter a Name and an optional Plural. RefRef makes the Key from the name, for example storage_mb; you can change it under Advanced before you save, but never after. Your product maps the key to what it grants. All Programs of the Project share the units. You can rename, archive, or restore a unit, and delete one that no rule uses.
Integrations
A Project can connect several billing providers, one account of each, for example RevenueCat for app store purchases and Stripe for web payments. RefRef delivers each billing Reward at the provider where the customer pays: the provider of the customer's active subscription, else of their latest purchase. When it cannot tell, the Reward waits on the Rewards page, where you choose the connection or mark it granted. A Sandbox Project takes test-mode keys, and can use the simulator instead of a provider account until you connect one. See the page of each integration.
Attribution settings
Each Project has an attribution policy: a click counts when it happened at most 90 days before the identification, and the latest eligible click wins. By default, a referee does not need to be a new customer. A Shopify or WooCommerce connection sets the Project to accept only new customers. The Console has no control for this policy.
Workspaces
Your company account in RefRef - members and roles, what owners and admins can do, API keys, and switching between Workspaces.
Programs and settings
Create a referral, affiliate, or loyalty Program from a template, write its reward rules and terms, design its Widget, and choose its delivery, payout, referee offer, and partner settings.