Bridge endpoint

Base: /api/v1

The single endpoint your plugin talks to the panel through: sends the current state and receives waiting actions.

Handler: MinecraftBridgeController

POST /api/v1/hytale/bridge

Send status & fetch actions

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

Field	Type	Required	Description
`version`	string	No	Plugin-Version, z. B. "1.3.0"
`paused`	boolean	No	"true" oder "false"
`game`	string	No	"minecraft" oder "hytale"

Response Example

{
  "actions": [
    {
      "group": "sabotage",
      "id": 914,
      "action": "freeze",
      "player": "Steve",
      "params": { "seconds": 10 },
      "viewer": "ChatterName",
      "label": null,
      "show_title": true
    }
  ],
  "display": {
    "live": true,
    "streamer": "ExampleStreamer",
    "platform": "tiktok",
    "url": "https://tiktok.com/@examplestreamer/live",
    "viewers": 342
  }
}

cURL

curl -X POST 'https://your-panel.example/api/v1/hytale/bridge' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"version":"1.4.0","paused":false,"game":"hytale"}'

Important to understand: this call cannot be used to directly trigger "action X for player Y", the plugin only reports its status here, and the panel independently decides which actions are already waiting (triggered by a channel point redemption, a TikTok gift, an automation, or the test button in the panel itself) and delivers them on the next poll; in demo mode the button therefore only shows an example of what a response with a waiting action looks like (depending on the "game" field). Under "Your server URL" enter the address of the panel your plugin connects to (the same one as in your config.json), and under "Authorization" your token in the format "Bearer your-token". This call then behaves exactly like a normal poll from your plugin: any waiting actions are marked as "sent" and delivered in this response. Only test live when your server is not currently expecting an action, otherwise your actual plugin will not see that action on its next poll. Note: this test tool always sends the request unencrypted (http) first and does not follow redirects, so against a panel that only accepts encrypted connections (https) you may see just a redirect response here instead of the real data. In that case, use the curl example below.

Internal Behavior

Identical to the Minecraft variant (different endpoint path: /api/v1/hytale/bridge instead of /api/v1/minecraft/bridge, so nothing says "minecraft" anywhere in a Hytale install), plus every returned action includes a "group" field ("sabotage" or empty), which StreamBridge-Hytale uses to color the title display (red/green).

Possible values for "action" in the returned actions (full table with parameters in the "Actions reference" guide):

freeze: freezes the player
root: roots the player to the ground
slow: slows the player
stun: stuns the player
poison: poisons the player
burn: burning effect
stamina_drain: drains stamina
mana_drain: drains mana
regeneration: heals the player over time
stoneskin: grants protection (stoneskin)
immune: temporarily immune to effects
morph: turns the player into an animal
launch: launches the player upward
knockback: knocks the player in a random direction
scale_giant: makes the player giant
scale_tiny: makes the player tiny
random_warp: teleports to a random warp
teleport_back: teleports to the last saved location
random_instance: teleports into a random instance
leave_instance: leaves the current instance
spawn_mob: spawns enemies at the player
animal_rain: rains animals from the sky
night: sets the game time to midnight
day_clear: sets the game time to noon, removes forced weather
weather: forces a specific weather
drop_hand: drops the item from the hotbar
shuffle_hotbar: shuffles the hotbar
half_health: halves the health
heal: fully heals
stamina_refill: refills stamina
antidote: removes all status effects
give_item: gives an item
portal_time_add: increases the remaining portal time
portal_time_remove: decreases the remaining portal time
vulnerable: makes vulnerable
electric_shock: electric shock, briefly stuns
fall_immunity: no fall damage
fire_immunity: no fire damage
dimension_teleport: random safe spot in the same world or dimension
world_spawn: to the spawn point of the current world
teleport_to_player: to another player in the same world
swap_places: swap position with another player
portal_timer_pause: stop the portal timer, resumes afterward
void_hold: hold back the void invasion
camera_topdown: top-down camera
camera_sidescroller: side view, 2D movement only
hide_debug: block the coordinates display
fake_sound: scare sound for the player only