Integration overview

RetentionPlay adds branded retention mechanics (streaks, quizzes, scratch cards, wheels, score games) to your product and, optionally, pays out rewards through signed server-side callbacks. This track is for teams integrating RetentionPlay into an external product.

How it fits together

• The browser only renders a thin widget. It never decides rewards.
• Anonymous free-play needs only the loader script and project id.
• Your backend issues identified-user session tokens through POST /v1/server/session-token with a session:issue API key.
• Reward-bearing flows are confirmed server-to-server and delivered as HMAC-signed webhooks.

Integration levels

Level	What you get	What you implement
L0 — Free play	Streak/quiz widget, anonymous play, analytics	Embed snippet
L1 — Identified	Per-user progress, A/B exposure	Session token from /v1/server/session-token
L2 — Promo rewards	Reward eligibility + signed webhooks	Server events + webhook verify

Where to go next

• Core concepts — sessions, progression, events, rewards.
• Quickstart — from zero to a working streak in minutes.
• Widget embed — the loader and its data attributes.
• Lobby — display mode, next level and unfinished run.
• Game runs — starts, commands, progression and reward status.
• API reference — the canonical /v1 OpenAPI document.