Script Reference

Server REST API - Overview

Script Reference

Overview

The "Beamable REST API" allows game makers to add social, commerce and content to games.

API

This Server REST API script reference is organized by Endpoint and Feature.

REST APIManualDetail
A/B TestingA/B TestingAllow game makers to deploy new functionality to subset of players
AccountsAccountsAllow player account management
AnalyticsAllow game maker to track player behavior
AnnouncementsAnnouncementsAllow player to manage announcements
AuthenticationAccountsAllow player login/logout management
CalendarsAllow game makers to offer rewards on a calendar schedule
ChatChatAllow players to communicate in-game
Cloud SavingCloud SaveAllow player to store progress
CommerceStoreAllow player to shop
ContentContentAllow game maker to store project-specific data
EventsEventsAllow game maker to set up a one-time competition
Game RelayMultiplayerAllow game makers to create multi-user experiences
GroupsGroupsAllow players to create groups and interact in real-time
InventoryInventoryAllow player to manage inventory
LeaderboardsLeaderboardsAllow player to manage inventory
MailMailAllows players to manage in-game mail
MatchmakingMultiplayerAllow game makers to create multi-user experiences
PaymentsPaymentsAllow player to complete pay transactions
Push NotificationsNotificationsAllow game makers to message players, regardless if game is running
Realm AdministrationAllow game makers to administer realms
Server NotificationsNotificationsAllow game makers to message players, regardless if game is running
SessionAllow game maker to manage the play session
StatsStatsAllow game maker to store player-specific data
TournamentsTournamentsAllow game maker to set up a recurring tournament