Introduction

Phoenix Gamification Ingestion Gateway

The Phoenix Gamification Platform enables organizations to enhance user engagement by integrating competitive and rewarding experiences directly into their products. Designed for a wide range of applications including games, learning platforms, fitness apps, and consumer services Phoenix handles scoring, ranking, rewards, and real‑time updates so your team can focus on delivering exceptional user experiences.

This guide provides a clear, high-level overview of how Phoenix fits into your product, what capabilities it offers, and what you can expect as you begin integrating its features.

What This Guide Includes

This documentation set covers the full journey from initial setup to powering live leaderboard experiences:

• Getting Started – How to create credentials, set up your environment, and verify connectivity.
• Event and Integration – How to structure events and send them to Phoenix reliably.
• Leaderboards Overview– Understanding scoring models, timeframes, ranking logic, and reward tiers.
• Creating Leaderboards – How to configure leaderboards using the Admin API.
• Real-time Updates – Using WebSocket feeds to power live UI components.
• Querying Results – Fetching rankings, user positions, snapshots, and historical reports.

Who This Overview Is For

This guide is intended for:

• Product teams evaluating Phoenix for engagement features.
• Client engineers integrating leaderboard or rewards views into apps.
• Teams looking for a general understanding of how Phoenix fits into their platform.

No deep backend experience is required just familiarity with basic API concepts and JSON.

Next Steps

When you're ready to begin, start with the Getting Started guide to set up credentials, environments, and basic tests. From there, each document will walk you through the next stage of your integration, step by step.