Beamable · Schema

Beamable Live Events Schemas

JSON Schema definitions for Beamable live events and player event participation

Game BackendLiveOpsPlayer AccountsVirtual CurrencyInventoryLeaderboardsMatchmakingMicroservicesUnityUnrealGame EconomyAnalytics
View JSON Schema on GitHub

JSON Schema

beamable-live-events-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://beamable.com/api/schemas/live-events",
  "title": "Beamable Live Events Schemas",
  "description": "JSON Schema definitions for Beamable live events and player event participation",
  "definitions": {
    "EventInventoryRewardItem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "properties": {
          "type": "object"
        }
      },
      "additionalProperties": false
    },
    "ItemCreateRequest": {
      "type": "object",
      "properties": {
        "contentId": {
          "type": "string"
        },
        "properties": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ItemProperty"
          }
        }
      },
      "additionalProperties": false
    },
    "EventClaimResponse": {
      "title": "Event Claim Response",
      "type": "object",
      "properties": {
        "view": {
          "$ref": "#/components/schemas/EventPlayerStateView"
        },
        "gameRspJson": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "EventPlayerView": {
      "title": "Event Player View",
      "type": "object",
      "properties": {
        "running": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/EventPlayerStateView"
          }
        },
        "done": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/EventPlayerStateView"
          }
        }
      },
      "additionalProperties": false
    }
  }
}