Live events API

MatchZy POSTs a JSON event to your server whenever something happens in a match: the match flow events a Get5 panel needs, plus a live scorebot feed (kills, damage, bomb, grenades, flashes, pauses) so you can build live scoreboards, Discord bots or overlays.

For .admin / .report tickets answered from a website or Discord bot, see Admin tickets.

Setup

Set the URL from a private cfg (exec’d after config.cfg) or the match config’s cvars block. The setting stays active when a match is loaded.

matchzy_remote_log_url "https://example.com/matchzy/events"
matchzy_remote_log_header_key "Authorization"
matchzy_remote_log_header_value "Bearer <token>"

A second header pair (matchzy_remote_log_auth_key / matchzy_remote_log_auth_value) is available for services that need two.

To stop sending events, set the URL to an empty value: matchzy_remote_log_url "". The same works for the header and auth settings. Run a setting without a value (matchzy_remote_log_url) to see what it is set to; header and auth values are shown masked.

Format

Live events follow Get5’s event schema by default: players and weapons are nested objects (player, attacker, weapon), so a receiver built for Get5 can read them directly. matchzy_events_format legacy switches back to the flat format of 0.8.94 and older (killer_name, victim_steamid, …). See the Events reference.

Delivery

• POST, Content-Type: application/json, one event per request.
• 10 second timeout, no retries. Anything other than 2xx is logged on the server.
• The event field names the event.

Receiving events

A minimal receiver in Node.js:

import express from "express";

const app = express();
app.use(express.json());

app.post("/matchzy/events", (req, res) => {
  if (req.get("Authorization") !== "Bearer <token>") return res.sendStatus(401);

  const e = req.body;
  switch (e.event) {
    case "player_kill":
      console.log(`${e.attacker.name} killed ${e.player.name} with ${e.weapon.name}` + (e.headshot ? " (HS)" : ""));
      break;
    case "round_end":
      console.log(`Round ${e.round_number}: ${e.team1.score} - ${e.team2.score}`);
      break;
  }
  res.sendStatus(200);
});

app.listen(3000);

See the full list in the Events reference.