Gameplay event reference
Inspect every currently published event and payload schema for a game's active release.
Downloads for this guide
Sample registry definitionsStaff-reviewed proposal for starter projects; not a self-installing manifest.There is no universal auto-registered event list
The server requires a published event definition for the game and, if scoped, the release. Names use a lowercase letter followed by up to 63 lowercase letters, digits or underscores. Platform-owned prefixes such as account_, payment_, purchase_, wallet_, reward_, staff_, auth_ and platform_ are rejected. Built-in mechanics (for example game-specific counters) belong to those games only. Use the live inspector below to view each supported event, required fields, types, numeric bounds or string lengths, and minimum interval. Draft/paused definitions and unpublished games are excluded. For a new unpublished game, staff must review its registry; its schema is not publicly listed here yet.
Envelope sent by the SDK
{
"kind": "play-island:event",
"version": 2,
"protocolVersion": 2,
"eventId": "36d581f7-7d7e-42e5-b87d-61b4cd74c139",
"sequence": 1,
"name": "started",
"data": {}
}eventId is a UUID; sequence is an integer 1–1000 and must equal the last accepted sequence + 1. The SDK sets these fields. name selects a registered definition. data is a JSON object; its serialized length must be at most 8192 characters in the current validator (the error calls it 8 KB). V2 rejects unregistered payload keys, and required fields and exact types are enforced. Numeric values must be finite and within bounds; strings respect their declared length limits. Reported activeSeconds cannot exceed server elapsed time by more than three seconds.
Lifecycle articles
These names are seeded for bundled games. No generic validator universally requires started/paused/progress. A terminal event closes the session; a specific game validator or configured objective may impose more rules. Use the lifecycle intentionally rather than sending all events automatically.
Expected behavior and common errors
Accepted reports are persisted and acknowledged. Reusing an accepted event ID with identical input is idempotent; changed input or a different session is rejected. Signed-in score/completed/failed update personal best and eligible score entries, while terminal events end sessions. Signed-in gameplay can feed server-owned missions, achievements and rewards through the worker; neither an event name nor acknowledgement guarantees a payout. Common errors include unregistered event, unregistered field, missing/invalid field, unsupported release, ended/expired session, out-of-order sequence, implausible frequency, duration too high, early completion and restricted account. A custom built-in validator may impose additional constraints (mode, seed, monotonic counters, score derivation). The field table alone is not a claim that an arbitrary value combination will pass those specialized checks.
Best practice
Send meaningful transitions and bounded milestones, never frame-by-frame events. Wait for acknowledgement and distinguish event acceptance from reward status. Stop after a rejection: the SDK has already incremented its local sequence and does not automatically repair or retry. Reload after correcting the cause.
Inspect a published game
This reads the current published registry for its active release. A bundled game's custom events are not automatically available to your game.