Contests

Topic

channel.contests

Description

This topic provides real-time contest and prediction events published to Astro for WebSocket delivery. It covers contest state changes, vote/bet updates, and winner announcements.

Usage

Subscribe to this topic to receive notifications about contest activities, allowing you to build real-time prediction displays, betting interfaces, or sync contest state across multiple clients.

Message Structure

{
    "id": "01KC4840ZZ1BAMK5R2V9QX9BNA",
    "ts": "2025-01-15T14:30:00Z",
    "type": "message",
    "topic": "channel.contests",
    "room": "577c0455f9a31ea72a36b2b3",
    "data": {
        "event": "state",
        "payload": {}
    }
}

Parameters

Parameter	Type	Description
room	string	Channel ID
data.event	string	Event type: update, state, or winner
data.payload	object	Event-specific payload data

Events

Event	Description
update	Vote/bet placed
state	Contest state changed
winner	Winner selected

update

Sent when a user places a vote or bet on a contest option.

{
    "event": "update",
    "payload": {
        "optionId": "507f1f77bcf86cd799439011",
        "amount": 100,
        "userId": "12345678"
    }
}

Parameter	Type	Description
optionId	string	ID of the option voted for
amount	number	Amount bet
userId	string	ID of the user who placed the bet

state

Sent when the contest state changes.

{
    "event": "state",
    "payload": {
        "state": "running",
        "contestId": "507f1f77bcf86cd799439011"
    }
}

Parameter	Type	Description
state	string	New state: created, running, ended, completed, refunded, or closed
contestId	string	Contest ID (only present on start)

winner

Sent when a winner is selected.

{
    "event": "winner",
    "payload": {
        "winnerId": "507f1f77bcf86cd799439011"
    }
}

Parameter	Type	Description
winnerId	string	ID of the winning option

State Transitions

created → running → closed → completed
                  ↘ refunded

State	Description
created	Contest created but not started
running	Accepting bets
closed	Voting stopped, awaiting winner selection
completed	Winner selected, rewards distributed
refunded	Contest cancelled, bets returned

Data Types

Contest

Field	Type	Description
channel	string	Channel ID
title	string	Contest title
description	string	Contest description
minBet	number	Minimum bet amount
maxBet	number	Maximum bet amount
botResponses	boolean	Whether bot responses are enabled
options	array	Array of contest options
totalAmount	number	Total amount bet across all options
totalUsers	number	Total number of users who bet
duration	number	Contest duration
startedAt	string	ISO 8601 timestamp when contest started
endedAt	string	ISO 8601 timestamp when contest ended
active	boolean	Whether contest is active
state	string	Current state: created, running, ended, completed, refunded, or closed

ContestOption

Field	Type	Description
_id	string	Option ID
command	string	Command to vote for this option
title	string	Option title
totalAmount	number	Total amount bet on this option
totalUsers	number	Number of users who bet on this option
winner	boolean	Whether this option won

Related Topics

• Channel Activities - General channel activity events
• Websockets - General information about the Astro WebSocket Gateway