Events API

import { io } from 'socket.io-client';

const socket = io('wss://api.velora.tv/ws/events', {
  auth: {
    token: 'YOUR_ACCESS_TOKEN'
  },
  // Or pass token as query parameter:
  // query: { token: 'YOUR_ACCESS_TOKEN' }
});

// Connection established. With a valid token you are AUTO-SUBSCRIBED to your
// own channel — no extra subscribe call is needed; your events start flowing.
socket.on('connected', (data) => {
  console.log('Connected to Events API');
  console.log('Channel:', data.channelUsername);   // your channel's username
  console.log('Authenticated:', data.authenticated); // true when a valid token was sent
  console.log('Auto-subscribed:', data.autoSubscribed);
});

// Three ways to receive events — use whichever fits:

// 1) A single generic handler for ALL events ({ event, timestamp, data } envelope):
socket.on('event', ({ event, data, timestamp }) => {
  console.log('Event:', event, data, timestamp);
});

// 2) socket.onAny — also catches every event, by name:
socket.onAny((eventName, payload) => {
  console.log('Event:', eventName, payload);
});

// 3) Listen for specific events by name (payload is the raw event data):
socket.on('channel.follow', (payload) => {
  console.log('New follower:', payload);
});
socket.on('channel.subscribe', (payload) => {
  console.log('New subscriber:', payload);
});

// Handle disconnection
socket.on('disconnect', (reason) => {
  console.log('Disconnected:', reason);
});

using SocketIOClient;

var socket = new SocketIO("wss://api.velora.tv/ws/events", new SocketIOOptions
{
    Auth = new { token = "YOUR_ACCESS_TOKEN" }
});

socket.On("connected", response =>
{
    var data = response.GetValue<ConnectedData>();
    Console.WriteLine($"Connected as {data.ChannelUsername}");
});

socket.On("event", response =>
{
    var payload = response.GetValue<EventPayload>();
    Console.WriteLine($"Event: {payload.Event}");
    // Handle the event...
});

await socket.ConnectAsync();

const eventSource = new EventSource(
  'https://api.velora.tv/api/events/stream',
  {
    headers: {
      'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
    }
  }
);

// Connection established
eventSource.addEventListener('connected', (e) => {
  const data = JSON.parse(e.data);
  console.log('Connected:', data.channelUsername);
});

// Listen for specific event types
eventSource.addEventListener('channel.follow', (e) => {
  const payload = JSON.parse(e.data);
  console.log('New follower:', payload.data.username);
});

eventSource.addEventListener('channel.subscribe', (e) => {
  const payload = JSON.parse(e.data);
  console.log('New sub:', payload.data.username);
});

// Or listen for all events
eventSource.onmessage = (e) => {
  const payload = JSON.parse(e.data);
  console.log('Event:', payload.event, payload.data);
};

eventSource.onerror = (e) => {
  console.error('SSE error:', e);
};

curl -N -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Accept: text/event-stream" \
     "https://api.velora.tv/api/events/stream"

{
  "event": "channel.follow",
  "timestamp": "2026-02-10T12:00:00.000Z",
  "data": {
    "userId": "user_abc123",
    "username": "newviewer",
    "displayName": "NewViewer",
    "followedAt": "2026-02-10T12:00:00.000Z"
  }
}

{
  "user": "cosmicdragon357",
  "userId": "e08602f5-92f1-4231-8453-2737ecf1718a",
  "displayName": "CosmicDragon357",
  "message": "!so captainfrostbeak",
  "msgId": "a1b2c3d4-...",
  "badges": ["subscriber", "moderator"],
  "isMod": true,
  "isVip": false,
  "isSub": true,
  "subTier": 1,
  "isFirstMessage": false,
  "color": "#7B2FF7",
  "isCommand": true,
  "command": "so",
  "rawInput": "captainfrostbeak"
}

{
  "username": "cosmicdragon357",
  "displayName": "CosmicDragon357",
  "avatarUrl": "https://assets.velora.tv/avatars/..."
}

{
  "userId": "e08602f5-92f1-4231-8453-2737ecf1718a",
  "username": "cosmicdragon357",
  "displayName": "CosmicDragon357",
  "tier": "1",
  "months": 3
}

{
  "userId": "recipient-uuid-or-null",
  "gifterUserId": "gifter-uuid",
  "gifterUsername": "cosmicdragon357",
  "gifterDisplayName": "CosmicDragon357",
  "recipientUserId": "recipient-uuid-or-null",
  "recipientUsername": "captainfrostbeak",
  "recipientDisplayName": "CaptainFrostbeak",
  "quantity": 1,
  "tier": "1"
}

{
  "username": "cosmicdragon357",
  "displayName": "CosmicDragon357",
  "amount": 500,
  "message": "take my volts!"
}

{
  "fromUserId": "e08602f5-92f1-4231-8453-2737ecf1718a",
  "fromUsername": "cosmicdragon357",
  "fromDisplayName": "CosmicDragon357",
  "viewerCount": 42
}

{
  "id": "b7c1e2f0-...",
  "question": "Which boss next?",
  "status": "closed",
  "allowMultiple": false,
  "openedAt": "2026-08-01T22:14:03.000Z",
  "closesAt": "2026-08-01T22:16:03.000Z",
  "closedAt": "2026-08-01T22:16:03.000Z",
  "totalVotes": 42,
  "options": [
    { "id": "opt-1", "label": "Malenia",  "voteCount": 25, "percentage": 60 },
    { "id": "opt-2", "label": "Radahn",   "voteCount": 17, "percentage": 40 }
  ],
  "trigger": "closed"
}

{
  "id": "3f9a44e1-...",
  "title": "Steam key drop",
  "description": "One key, followers only",
  "status": "closed",
  "eligibility": "followers",
  "entryMode": "button",
  "openedAt": "2026-08-01T22:30:00.000Z",
  "closesAt": "2026-08-01T22:40:00.000Z",
  "closedAt": "2026-08-01T22:40:00.000Z",
  "totalEntries": 213,
  "drawState": "complete",
  "winnerCount": 1,
  "winnersDrawn": 1,
  "winners": [
    {
      "id": "e08602f5-...",
      "username": "cosmicdragon357",
      "displayName": "CosmicDragon357",
      "avatarUrl": "https://assets.velora.tv/avatars/...",
      "drawOrder": 1,
      "drawnAt": "2026-08-01T22:40:01.000Z"
    }
  ],
  "winner": {
    "id": "e08602f5-...",
    "username": "cosmicdragon357",
    "displayName": "CosmicDragon357",
    "avatarUrl": "https://assets.velora.tv/avatars/...",
    "drawOrder": 1,
    "drawnAt": "2026-08-01T22:40:01.000Z"
  },
  "autoDraw": true,
  "trigger": "closed"
}

{
  "id": "6c1b5a90-...",
  "channelId": "9a1f0c2e-...",
  "title": "Do we beat the boss first try?",
  "status": "resolved",
  "lockAt": "2026-09-30T20:05:00.000Z",
  "lockedAt": "2026-09-30T20:05:00.000Z",
  "settledAt": "2026-09-30T20:21:40.000Z",
  "winningOutcomeId": "b2d0...",
  "settlement": "resolved",
  "maxStake": 250000,
  "totalPoints": 48250,
  "totalBettors": 37,
  "outcomes": [
    { "id": "b2d0...", "label": "Yes", "position": 0, "totalPoints": 30100, "bettorCount": 22 },
    { "id": "f71c...", "label": "No",  "position": 1, "totalPoints": 18150, "bettorCount": 15 }
  ]
}

{
  "widgetId": "a41e...",
  "name": "Sub goal",
  "occurredAt": "2026-09-30T20:40:02.000Z",
  "value": 50,
  "target": 50,
  "progress": 1,
  "completed": true,
  "periodStartedAt": "2026-09-30T00:00:00.000Z"
}

{
  "widgetId": "c93d...",
  "name": "Subathon",
  "occurredAt": "2026-09-30T21:02:11.000Z",
  "change": "time_added",
  "mode": "subathon",
  "status": "running",
  "remainingSeconds": 10421,
  "endsAt": "2026-10-01T00:05:52.000Z",
  "elapsedSeconds": 3000,
  "addedSeconds": 1800,
  "totalSeconds": 13421,
  "cappedSeconds": 0,
  "endedAt": null,
  "secondsChanged": 300
}

{
  "items": [
    {
      "id": "reward_abc123",
      "name": "Highlight My Message",
      "cost": 500,
      "description": "Make your message stand out!",
      "iconUrl": "https://...",
      "builtInType": null,  // null = custom reward
      "enabled": true,
      "requiresModeratorApproval": false,
      "maxPerStream": null,
      "maxPerUserPerStream": 3
    },
    {
      "id": "reward_xyz789",
      "name": "First",
      "cost": 1,
      "description": "Be the first to claim this each stream!",
      "builtInType": "first",  // Built-in reward type
      "enabled": true
    }
  ]
}

// Request rewards over WebSocket. Pass your channelId (from the 'connected'
// payload) — without it the request returns an empty list.
socket.emit('channel:getRewards', { channelId: myChannelId });

// Listen for the response. The payload is an OBJECT with a 'rewards' array;
// each item matches the REST shape: { id, name, cost, description, iconUrl,
// enabled, builtInType }.
socket.on('channel:rewards', ({ rewards }) => {
  console.log('Channel rewards:', rewards);
  // [
  //   { id: '...', name: 'Highlight My Message', cost: 500, enabled: true, builtInType: null },
  //   { id: '...', name: 'First', cost: 1, enabled: true, builtInType: 'first' }
  // ]
});

// Handle errors
socket.on('error', (err) => {
  if (err.code === 'SERVICE_UNAVAILABLE') {
    // Channel points service not available
  }
});

{
  "rewards": [
    {
      "id": "reward_abc123",
      "name": "Highlight My Message",
      "cost": 500,
      "description": "Make your message stand out!",
      "iconUrl": "https://...",
      "enabled": true,
      "builtInType": null
    },
    {
      "id": "reward_xyz789",
      "name": "First",
      "cost": 1,
      "description": "Be the first to claim this each stream!",
      "iconUrl": null,
      "enabled": true,
      "builtInType": "first"
    }
  ]
}

// Redemption event payload
{
  "event": "channel.channel_points_redemption",
  "timestamp": "2026-02-10T12:00:00Z",
  "data": {
    "redemptionId": "red_abc123",
    "rewardId": "reward_abc123",     // Match this to your rewards list
    "rewardTitle": "Highlight My Message",
    "rewardCost": 500,
    "userId": "user_xyz",
    "username": "viewer123",
    "displayName": "Viewer123",
    "userInput": "Check out my message!",  // If reward accepts input
    "status": "unfulfilled",
    "redeemedAt": "2026-02-10T12:00:00Z"
  }
}