Refer & Earn
The referral module appears in Cheggout's SDK documentation, but the server endpoints its lifecycle
depends on — RegisterEvent and ExitEvent — have no confirmed implementation. Verification
against the platform did not find them.
Do not plan a launch around this module. If referral is important to your roadmap, raise it with Cheggout and ask for a committed specification and delivery date before allocating engineering time.
The intended concept
Refer & Earn is designed to work independently of the other modules — a publisher can integrate referral without the marketplace, scratch cards or advertisement.
The intended lifecycle:
The documented surface area a full module would need:
| Capability | Status |
|---|---|
| Registering a referral event | Not available Endpoint not confirmed |
| Referral tracking and attribution | TBD Not specified |
| Eligibility and reward rules | TBD Not specified |
| Status lookup for a referral | TBD No endpoint documented |
| Conversion or success events | TBD Not specified |
| Referral analytics | TBD Not specified |
| Web integration | TBD Not specified |
Only the first row has any published contract at all, and that contract is for an endpoint whose availability is unconfirmed.
The historical specification
Retained for reference so that, if these endpoints are revived, you can see what was intended. Do not implement against this without confirming availability with Cheggout.
RegisterEvent — historical specification
Documented as a signed-envelope endpoint on the bank API host, logging an event for a user together with the time it was recorded.
BDATA payload fields:
| Field | Description |
|---|---|
virtualId | The user |
channelName | Your channel |
eventType | For example register or referral |
subEventType | For a referral, the referral code |
additionalParams | JSON string, for example {"isNewUser":true} |
SDK methods were documented on both platforms — registerEvent on Android with a
CHEGregisterCampaignEventCallBack, and registerEvent on iOS with a completion handler.
ExitEvent — historical specification
Documented as a signed-envelope endpoint logging an event when a user logs out of the application, and clearing their data.
BDATA payload fields: virtualId, channelName, sessionId, token.
See RegisterEvent / ExitEvent for the full
reference-only detail.
What Cheggout needs to publish
For this module to become buildable:
- Confirmation that the event endpoints exist, or replacements for them.
- A referral lifecycle specification — how a code is issued, how attribution is decided, when a referral converts.
- Eligibility and reward rules — what the referrer and referee receive, and when.
- A status endpoint, so a publisher can show a referrer their pending and completed referrals.
- Analytics or reporting, so the programme can be measured.
These are tracked on Open items.
What you can do today
If your goal is a referral programme that pays out Cheggout rewards, one composition is available now: run the referral logic yourself and use Cheggout as the reward fulfilment layer.
You own the referral mechanics; Cheggout supplies the reward. A converted referral becomes a trigger event on the scratch cards module, using a dedicated trigger code agreed with Cheggout.
This is not the referral module — there is no referral tracking, no referee reward, no status view — but it does let a referral programme pay out real rewards today.
Next
- Scratch cards — the practical alternative above.
- Open items
- Support — ask about the roadmap.