Skip to content

Connecting Node.JS To StreamElements WebSocket

If you're planning on using the Streamelements Websockets service to receive realtime notifications of things like tips, merch purchases and stream store redemptions (it can also do follows, cheers, raids, hosts and subs for Twitch), you may find information is a bit thin on the ground, so here's a quick guide to getting connected using TypeScript and Node.js.

Note

I'm reviewing this post as I'm migrating it into my new website and it's worth pointing out that as with many of these providers it seems the API is quite fluid. So this code may not work anymore. It's also worth pointing out that you should check the latest StreamElements documentation for the latest API information (although to be fair, I'm not hopeful it will be any good).

First things first, the library required to connect to the realtime service. The examples provided by Streamelements are based on the socket.io-client library, but what may not be obvious with a cursory glance is the version requirement (I skipped the HTML example and went straight to npm to install the client). The socket.io library server and client have to operate on the same version and Streamelements use version 2 on the server, so you have to run the version 2 client.

socket.io-client Library Installation

npm install socket.io-client@2 --save

With the correct client installed, you're good to go, so lets look at some sample code. NOTE:- This code is a butchered version of the class within my bot that links to Streamelements, as such there may be minor issues, but it should give you the general idea.

Sample Code

Sample TypeScript Code
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
import io, { Socket } from "socket.io-client";

var jwttoken: string = '<YOUR JWT TOKEN>';
var socket: Socket;
var channelid: string = '';
var clientid: string = '';
const passthroughtestevents: boolean = false;

socket = io('https://realtime.streamelements.com', {transports: ['websocket']});

socket.on('connect', () => { socketConnect(); });
socket.on('connect_error', (data) => { socketConnectError(data); });
socket.on('disconnect', () => { socketDisconnect(); });
socket.on('authenticated', (data) => { socketAuthenticated(data); });
socket.on('unauthorized', (data) => { socketUnauthorized(data); });
socket.on('event:test', (data) => { socketEventTest(data); });
socket.on('event', (data) => { socketEvent(data); });
socket.on('event:update', (data) => { socketEventUpdate(data); });
socket.on('event:reset', (data) => { socketEventReset(data); });

function socketConnect() {
    console.log(`Connected, authenticating`);
    socket.emit('authenticate', { method: 'jwt', token: jwttoken });
}

function socketDisconnect() {
    // You don't need to worry about reconnecting, unless you have turned off automatic reconnect (enabled by default)
    console.log(`Disconnected`);
}

function socketAuthenticated(data) {
    /* Sample data
    {"clientId":"<YOUR CLIENT ID>","channelId":"<YOUR CHANNEL ID>","project":"realtime","message":"You are in a maze of dank memes, all alike."}
    */

    channelid = data.channelId;
    clientid = data.clientId;

    console.log(`Connected to ${channelid}`);
}

function socketUnauthorized(data) {
    console.log(`Authentication failed - ${JSON.stringify(data)}`);
}

function socketEventTest(data) {
    // Events raised with the 'Emulate' feature of the overlay editor will arrive as this handler
    // During development, you may with to pass them through to the main handler to test out the rest of your code

    if (passthroughtestevents) {
        socketEvent(data);
    }
}

function socketEvent(data) {
    var listener: string = data.listener;
    var event = data.event;

    switch (listener) {
        case 'redemption-latest':
            console.log(`Stream store redemption - ${JSON.stringify(event)}`);
            break;
        case 'tip-latest':
            console.log(`Tip - ${JSON.stringify(event)}`);
            break;
        case 'merch-latest':
            console.log(`Merch store purchase - ${JSON.stringify(event)}`);
            break;
        default:
            break;
    }
}

function socketEventUpdate(data) {
    console.log(`Session data update event - ${JSON.stringify(data)}`);
}

function socketEventReset(data) {
    console.log(`Session data reset event - ${JSON.stringify(data)}`);
}

This sample code, is only looking for the latest redemptions, tips and merch purchases.