Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nudj.cx/llms.txt

Use this file to discover all available pages before exploring further.

Nudj has a first-class referral system where each community has its own referralConfig. When Member A’s referral link brings in Member B, both earn rewards based on that config — all scoped to the community.

How it works

Community gets a referral config

Each community has a referralConfig with two distribution events — one for the referrer reward, one for the referee reward. Rewards are allocated from a backing Referral achievement.

Member A shares a referral link

Nudj generates a community-scoped referral link tied to Member A. When Member B clicks and joins, they’re linked to Member A as their referrer.

Rewards fire

Both Member A (referrer) and Member B (referee) earn the configured rewards. Achievements and analytics get updated.

Referral achievements are isolated

Referral achievements are tagged with a special AchievementType and filtered out of standard achievement APIs so they don’t appear in normal “list achievements” results. They’re treated as infrastructure-level objects, managed only through the referral config.

Configuring the program

Go to Gamification -> Referrals to set:
  • Referrer reward (points/XP/asset/entry)
  • Referee reward (same options)
  • Active / disabled toggle
  • Community-scope — each community’s referrals are separate

Status

The referral admin page was reverted in #2111 while underlying mechanics were stabilised — check your admin panel to confirm the current flow matches this document before promoting referrals externally.

Further reading

See docs/analysis/referral-reward-distribution-analysis.md in the repo for the internal data-model deep-dive on how referral events propagate through the achievement system.