For AI agents: visit https://beamable2.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Manual
Beamable API
Ask a Question
Contact Us
Manual
Beamable API
Ask a Question
Beamable Classic
Mercury
Manual
Beamable API
Ask a Question
Contact Us
Beamable.com
Manual
Beamable.com
Mercury
Manual
Events - Overview
Events - Overview
Welcome
Beamable Documentation
Installing Beamable (Unity)
Installing Beamable (Unreal)
Support Tiers
Script Reference
Client C# API
Server REST API
Unity SDK Features
Getting Started
Builds & Environments
Beamable Player Centric API
Player Centric API - Overview
Player Centric API - Code
Player Centric API - Lifecycle Functions
Dependency Injection
Dependency Service Lifecycle
Custom Services
Microservices
Autogenerated SDK
Offline Mode
Lightbeam Samples
LightBeam Overview
Account Management
UNREAL SDK FEATURES
Getting Started
Runtime Concepts
Unreal User Guide
Beam CLI
Beam CLI Commands
Project Ps
Project Add-unreal-project
Content Reset
Init
Project Share-code
Services Upload-api
Config Secret
Project Logs
Services Reset
Services Manifests
Config Set
Content Publish
Services Enable
Project Add
Project
Services Service-metrics
Project New Storage
Me
Content
Services Ps
Services Run
Login
Org
Services Service-logs
Project New
Content Open
Oapi
Services Promote
Config
Project Open-mongo
Project Open-swagger
Project Add-unity-project
Services Register
Content Pull
Oapi Download
Services Modify
Content Status
Services Templates
Services Registry
Org New
Version
Project Generate-ignore-file
Version List
Version Install
Services Get-connection-string
Project Update-unity-beam-package
Services Stop
Content Tag
Content Tag Rm
Content Tag Add
Content Bulk-edit
Project Build
Config Realm
Project Dependencies
Listen Server
Project Oapi
Project Regenerate
Listen
Project Version
Project Deps
Listen Player
Project Run
Project New Service
Project Deps Add
Config Realm Remove
Project Deps List
Project New Common-lib
Config Realm Set
Project List
Project Stop
Services Reset Container
Project Generate-properties
Project Deps Remove
Services Reset Image
Federation Disable
Federation
Federation Set
Federation Add
Project Group
Deployment Status
Portal Player
Deployment Plan
Federation Local-key
Deployment Release
Federation Local-settings Get
Project Storage
Temp Clear Logs
Federation Enable
Logout
Federation List
Deployment Get
Deployment List
Temp Clear
Server Ps
Unity Manifest
Deployment
Federation Remove
Token New-guest
Project Storage Erase
Token From-refresh
Project Disable
Temp
Token List
Project Storage Snapshot
Federation Local-settings Set IFederatedGameServer
Token Inspect
Federation Local-settings Get IFederatedGameServer
Portal
Project Group Rm
Services Docker Status
Project Open
Federation Local-settings
Project Enable
Services Docker Start
Project Remove
Unity Restore
Server Clear
Federation Local-settings Set
Services Build
Project Group Add
Project Storage Restore
Services Docker
Federation Local-settings Set IFederatedGameServer
Federation Local-settings Get IFederatedGameServer
Federation Local-settings Set IFederatedGameServer
Federation Local-settings Get IFederatedGameServer
Federation Local-settings Get IFederatedGameServer
Unreal Select-sample
Federation Local-settings Set IFederatedGameServer
Federation Local-settings Set IFederatedGameServer
Federation Local-settings Get IFederatedGameServer
Federation Local-settings Get IFederatedGameServer
Checks Scan
Checks
Federation Local-settings Set IFederatedGameServer
Federation Local-settings Set IFederatedGameServer
Federation Local-settings Get IFederatedGameServer
Grafana Stop
Content Replace-local
Collector Start
Content Sync
Content Save
Grafana Ps
Collector Status
Org Realms
Content Ps
Collector Stop
Collector Get
Collector
Content Resolve
Federation Local-settings Get IFederatedGameServer
Project Generate-client-oapi
Grafana Open
Federation Local-settings Set IFederatedGameServer
Federation Local-settings Set IFederatedGameServer
Federation Local-settings Get IFederatedGameServer
Content Restore
Content Snapshot
Telemetry
Telemetry Logs
Config Routes
Developer-user-manager
Content Snapshot-list
Telemetry Set-config
Content Archive-manifest
Content List-manifests
Project Add-paths
Developer-user-manager Create-user
Content New-manifest
Developer-user-manager Update-info
Developer-user-manager Ps
Telemetry Push
Telemetry Collector Get
Org Games
Project Generate
Telemetry Collector
Telemetry Collector Start
Developer-user-manager Copy-state
Developer-user-manager Remove-user
Telemetry Config
Project Generate Web-client
Telemetry Collector Stop
Federation Local-settings Get IFederatedGameServer
Telemetry Prune
Developer-user-manager Create-user-batch
Federation Local-settings Set IFederatedGameServer
Telemetry Collector Ps
Developer-user-manager Clean-captured-user-buffer
Content Tag Set
Developer-user-manager Save-user
Federation Local-settings Get IFederatedGameServer
Federation Local-settings Set IFederatedGameServer
Guides
Getting Started
Configuration
Upgrading
Notifications
Microservices
Microservice Deployment
Microservice Debugging
Microservice Configuration
Microservice Routing
Microservice Storage
MIcroservice Federation
Microservice CLI Workflows
Microservice UPM
Command Line Outout
Microservice Telemetry
Microservice Logging
Cloud Services
Microservices
Microstorages
Scheduled Jobs
Unity
Getting Started
Calling Microservices from Unity
Publishing
Shared Code
Sharing Microservices between Projects
Identity
Identity
Frictionless Authentication
Frictionless - Overview
Frictionless - Guide
Frictionless - Code
Username / Password
Username / Password - Overview
Username / Password - Code
Facebook Sign-In
Facebook Sign-In - Overview
Facebook Sign-In - Code
Facebook's Data Protection Assessment
Google Sign-In
Google Sign-In - Overview
Google Sign-In - Code
Apple Sign-In
Apple Sign-In - Overview
Apple Sign-In - Code
Apple's App Privacy Questionnaire
Steam Integration
Steam Integration - Overview
Steam Integration - Guide
Extending Identity
Adding HTML Sign-In
Federated Identity
Google Play Game Services Sign-In
Google Play Game Services Sign-In - Overview
Google Play Game Services Sign-In - Code
Profile & Storage
Profile & Storage
Cloud Save
Cloud Save - Overview
Player Cloud Save - Code
Cloud Save - Code
Content
Content - Overview
Content - Guide
Content - Code
Content - Custom Content
Content - Remote Configuration
Content - Validation
Content - Tool Window
Content - Filtering
Stats
Stats - Overview
Stats - Guide
Stats - Code
Game Economy
Inventory
Inventory - Overview
Inventory - Code
Inventory - Extending with Federation
Inventory - Pruning Deprecated Items
Stores
Stores - Overview
Stores - Code
Stores - Custom Purchaser
Stores - Custom Stores
Custom Purchase Reporting
Stores - In-App Purchasing (Android)
Virtual Currency
Virtual Currency - Overview
Virtual Currency - Code
Live Ops
Live Ops
Live Ops Prefabs
Live Ops Prefabs - Overview
Announcements - Prefab
Events
Events - Overview
Events - Guide
Events - Code
Announcements
Announcements - Overview
Announcements - Code
Notifications
Notifications - Overview
Notifications - Code
Mail
Mail - Overview
Mail - Code
Player Stats and Activities
Social & Networking
Social & Networking
Chat
Chat - Overview
Chat - Code
Connectivity
Connectivity - Overview
Connectivity - Code
Connectivity - Code - Reduce NoConnectivityException
Friends
Friends - Overview
Friends - Code
Groups
Groups - Overview
Groups - Code
Leaderboards
Leaderboards - Overview
Leaderboards - Code
Matchmaking
Matchmaking - Overview
Matchmaking - Guide
Matchmaking - Code
Multiplayer
Multiplayer - Overview
Multiplayer - Guide
Multiplayer - Code
Parties
Parties - Overview
Parties - Code
Lobbies
Lobbies - Overview
Lobbies - Code
Tournaments
Tournaments - Overview
Tournaments - Code
Business Intelligence
Business Intelligence
Telemetry
Telemetry - Overview
Telemetry - Code
Analytics
Analytics - Overview
Analytics - Guide
Analytics - Code
Segmentation
Segmentation - Overview
Segmentation - Guide
A/B Testing
A/B Testing - Overview
A/B Testing - Guide
A/B Testing - Code
Developer Tools
Unity
Beam Library
Beam Services
Unity Editor Login
Content Manager
Admin
Admin - Overview
Admin - Prefab
Admin - Code
Integrations
Integrating WebGL
Marketplace
Amplitude Integration
Edgegap
Goplay Integration
Harbor
Hathora Cloud Integration
Idem Multiplayer Matchmaking API
Mixpanel Integration
Photon Fusion
Polygon Integration
Scenario Integration
Solana Integration
SUI Integration
Theta Network Integration
Venly Integration
Zebedee API
Zenject Integration
COMING SOON
Common Sense Machines: Coder
Cardano Blockchain Integration
Halliday Integration
Hero Trainer Integration
Lamina1 Integration
LAOS Network Integration
Thirdwave Wallet Intelligence
Portal
Portal - Overview
Adding Developers
Granting Developer Permissions
Announcements
Campaigns
Cloud Data
Groups
In-App Purchases
Inventory
Leaderboards
Notify All Players
Players
Stats
Tournaments
Game Content Designer
Game Content Designer
Samples
Samples
Chat (GPW)
Chat (GPW) - Overview
Chat (GPW) - Guide
Chat & MicroStorage (GPW2)
Chat & MicroStorage (GPW2) - Overview
Chat & MicroStorage (GPW2) - Guide
Leaderboard (ABC)
Leaderboard (ABC) - Overview
Leaderboard (ABC) - Guide
Microservices (BBB)
Microservices (BBB) - Overview
Microservices (BBB) - Guide
Multiplayer (HATS)
Multiplayer (HATS) - Overview
Multiplayer (HATS) - Guide
Multiplayer (KOR)
Multiplayer (KOR) - Overview
Multiplayer (KOR) - Guide
Multiplayer (TBF)
Multiplayer (TBF) - Overview
Multiplayer (TBF) - Guide
Photon Multiplayer (RLGL)
Photon Multiplayer (RLGL) - Overview
Photon Multiplayer (RLGL) - Guide
SDK Examples
Game Type Matchmaking
Account Deletion
Asynchronous Turn Based Notifications
API Examples
Beamable Web Access Example
Building a Battle Pass
Migration
Migrating Unity from 1.19.23 to 2.0.0
GameSparks Migration
Migrating Unity from 2.x to 3.0
Learning
Learning Fundamentals
Prototyping With Unity
Game Jams With Unity
Appendix
Pricing
Best Practices for Pricing
Use Cases
Glossary
Security Overview
Performance & Scalability Overview
Powered by
Events - Overview
Allow game maker to set up a one-time competition [LIVE-Events-01]
Copy Page
