Introduction

Welcome, developers!

  • This documentation explains how to integrate your game or services with the Playfull platform. Use the sidebar to navigate topic-specific guides and reference material.

The Playfull platform enables you to send in-game events, track player activity, evaluate mission progress, and deliver rewards. The API follows REST principles, uses JSON payloads, and signs requests to protect data integrity.

Site overview

Platform Integration

  • REST API — Reference and examples for sending custom game events, managing user accounts, and batching events. Includes signature generation and verification, and common use-case examples.
  • Missions — Conceptual and implementation guides for Playfull's mission engine, including flow diagrams and how mission rules trigger rewards.
  • Limits & Best Practices — Rate limits, payload constraints, and recommendations for reliable integration.

Publisher Integration

  • Publisher — Onboarding and publisher-specific configuration and best practices.

Start with the REST API section to learn how to send events and review the provided use cases for implementation patterns.