Path › Custom games › API and webhooks

API and webhooks: connect your game to the panel

Your game sends events to the panel and gets orders back. You decide what to send, what to show and who has the right to what.

The code examples are illustrative: the exact formats are defined with your project.
Create my panelSee details
InboundSigned webhooks
OutboundRequests to your game
RightsPer key
API and webhooks: connect your game to the panel
Access keys3 active
Events receivedExample
Games
FiveMFiveMRedMRedMMinecraftMinecraftGTA VGTA San AndreasGarry's ModHytaleRobloxDayZHabboSCUMGTA 6 soonCustom games
Technologies
{ }REST API↯WebhooksdbMySQLdbMariaDBdbPostgreSQL{}MongoDB · NoSQLdbRedis#Discord↗Game-rank.com⇄Game bridge

What you manage · API and webhooks

Inbound

Events that you name yourself

An event has a name, fields and a destination in the panel: player profile, log, public site or Discord.

Event model
custom.quest.doneplayer, quest, reward
Defined
player.joinplayer, server
Defined
{
  "event": "custom.quest.done",
  "player": "nolan_l",
  "quest": "livraison-port",
  "reward": 1500
}
Events that you name yourself
Outbound

The panel can also call your game

Approving an application, sanctioning or granting a rank can trigger a request to your server.

Outgoing calls
whitelist.acceptPOST /api/whitelist
Configured
sanction.banPOST /api/ban
Configured
POST /api/ban
{
  "player": "joueur_0877",
  "days": 7,
  "by": "Admin Marc"
}
The panel can also call your game
Security

One key per use, revocable

Each integration has its own key, rights and log. You revoke one key without touching the others.

Keys
Production serverRead and write
Active
Partner siteRead only
Active
One key per use, revocable

Setup

In four steps

01

Create a key

With its rights.

02

Declare your events

Names and fields.

03

Send a test

From your server.

04

Connect the screens

Profile, log, site.

Style

In the style of your game

Illustrative examples: the exact formats depend on your game and your project.

Illustrative examples: the exact formats depend on your game and your project.

Other topics

API and webhooksAPI and webhooks SyncDatabase sync Game bridgeGame bridge Roles and modelRoles, permissions and data model specific to your game← Custom gamesAll topics

See also

Integrate a panel into your game: game bridge and APIGive every player a panel: optional game bridge, API, sync…Sync a MySQL or PostgreSQL database with the panelLink your game database to the panel: table mapping, read…RP panel featuresAll features: whitelist, sanctions, ranks, jobs, sites…

FAQ

Frequently asked questions

Hover over a question.

01Is the API documented?+

Documentation is linked in the footer; the exact format is to be confirmed with you.

02Which language on the game side?+

Any language that can send an HTTP request.

03Are the events signed?+

That is the goal, to be validated before going to production.

Move on to setup.

Create my panelSee all paths

Free to start.