Skip to main content

Entry points

The referral centre is one experience with three doors into it. Which doors you open determines what you have to build.

1. Mobile app — Cheggout SDK​

The customer is already authenticated in your app, so the referral centre opens signed in. This is the smoothest path and the one to prefer when you have an app.

Your app launches a deep link that Cheggout provides at onboarding:

https://click.cheggout.com?type=pwa&id=https://<your-referral-host>/?token={token}/customerId={customerId}/customerName={customerName}
ParameterDescription
typeLaunch type. pwa for the hosted referral experience
idThe destination the launcher opens, including your token
tokenShort-lived session token identifying the customer — see getAuthToken
customerIdYour identifier for the customer
customerNameDisplay name, used to personalise the share message
Do not copy this URL into your build

TBD The host, path and exact parameter set are provisioned per publisher and are shared with you when your channel is onboarded. The shape above is the contract, not a working endpoint. Confirm your own deep link with Cheggout before you wire it up.

Authentication on this path is SSO — your app has already established who the customer is, and the token carries that into the referral centre. There is no second login. See Session SSO for how the session handoff works generally, and Launch URLs for the parameter conventions.

2. Microsite — hosted web​

For customers without your app, or channels without an SDK integration, Cheggout hosts a referral microsite. There is no SDK to install and nothing to ship in an app release.

Because there is no app session to inherit, the customer must log in before they can view or claim rewards. That login is mobile number plus OTP — and the OTP is sent by you, not by Cheggout.

You host the sendSMS endpoint. Cheggout calls it; you own delivery, because you own the customer's verified mobile number and your own SMS sender identity. The full contract, including the failure reasons and the security caveats, is on sendSMS webhook.

SMS delivery is configured by you

Cheggout does not send SMS on your behalf on this path. Sender ID, DLT templates, throttling and retry are all your side. Plan for this — it is usually the longest lead-time item in a microsite referral launch.

3. CRM campaign​

The third door starts outside both surfaces. Your CRM sends a WhatsApp message, SMS or email to an existing customer, inviting them to refer friends — with their referral code already in the link.

For that you need the code before the message is sent. Fetch it with getReferralCodeForUser:

DirectionFields
RequestvirtualId, channelName, programmeName
ResponsereferralCode

Pull codes as part of building the campaign audience, and cache them against the customer record — a customer's code for a given programme is stable, so you do not need to fetch it per send.

A referral link in a message is a shareable credential

Anyone who receives a forwarded CRM message gets the referrer's code. That is the point — but it means the landing experience still has to authenticate before it shows referral history or lets anyone claim a reward. Sharing a code is open; viewing and claiming is not.

Choosing​

If you haveStart withAlso consider
A mobile app with the SDKThe deep linkCRM, to drive customers into it
No app, or a web-first channelThe micrositeCRM, to seed the first wave
An app but no SDK integration yetThe micrositeMigrate to the deep link later

The referral centre, the codes and the reward ledger are the same behind all three. Adding a second entry point later does not invalidate referrals made through the first.

Next​