Add the Challenge overlay from the Overlays gallery to put this on stream.

What the next qualifying gift is worth.

Every livestream event arrives as {"event": "...", "data": {...}}. The shape only ever changes additively, so a plugin written today keeps working.

const socket = new WebSocket('ws://127.0.0.1:21213/?service=MyMod&version=1.0');

socket.onmessage = ({ data }) => {
  const { event, data: payload } = JSON.parse(data);

  if (event === 'gift') {
    console.log(payload.uniqueId, payload.giftName, payload.repeatCount);
  }
};

// Optional: only receive what you care about.
socket.onopen = () => socket.send(JSON.stringify({
  action: 'subscribe',
  events: ['gift', 'chat']
}));

A tool that answers these four endpoints on port 8832 shows up directly in the action editor, so creators can pick your actions without any extra setup.

GET  http://127.0.0.1:8832/api/app/info
GET  http://127.0.0.1:8832/api/features/categories
GET  http://127.0.0.1:8832/api/features/actions?categoryId=...
POST http://127.0.0.1:8832/api/features/actions/exec

The exec call carries a triggerTypeId telling you what fired it:

Read-only status is open to any local process on http://127.0.0.1:21212/ — useful for asking whether the creator is live. Anything that changes state needs the session token, so a random web page cannot drive the app.