API Playground
Test API endpoints directly in your browser.
Base URL
Bridge endpoint /api/v1
POST
/api/v1/hytale/bridge
The same thing your plugin does on every poll interval: reports player state, whitelist and the results of previously sent actions, and receives up to 20 waiting actions plus the current live status in return.
Request Body
version
string
paused
boolean
game
string
Response
POST
/api/v1/hytale/bridge/test-action
Queues an action for your own server, exactly as if a viewer had triggered it. The plugin picks it up on its next poll and executes it. This lets you check the whole chain: the panel accepts it, the plugin picks it up, the game executes it, the result comes back.
Request Body
action
string
*
player
string
*
params
object
viewer
string
Response
GET
/api/v1/hytale/bridge/test-action/{id}
Shows what became of a test action: "pending" (waiting), "sent" (picked up by the plugin), "done" (executed), "failed" (failed, reason in "result", for example "player_offline" or "no_space") or "expired" (not picked up in time).
Parameters
id
integer
*
Response