Change to light theme (or icon here)

StreamlabsAPI

Streamlabs API

Contents

Outgoing channel : "STREAMLABS_ALERT"

Authorization fields

Field 1

  • Name: "SL_SOCKET_TOKEN"
  • Value: Socket token

These can be found on your streamlabs.com dashboard at Account > settings > Api settings"

About

This extension connects to the streamlabs API to retrieve live alert data so that other extensions can consume it (ie overlays, sharing alerts on discord, twitter etc)

Note: You can also use this api for other streaming platoforms. ie youtube streaming.

The following features are provided

  • creates a "STREAMLABS_ALERT" channel to send out streamlabs messages
  • Provides an SettingsWidgetSmall so that the adminpage can turn on or off the messages
  • Messages sent are of the following format

Triggers/Actions

Triggers and actions below are updated when the automatic document generation system is run and only contain triggers actions relating to this specific extension.

Table last updated: Wed, 12 Mar 2025 05:38:02 GMT

Triggers

name trigger description
StreamlabsDonationAlert trigger_StreamlabsDonationReceived A Streamlabs donation was received
StreamlabsMerchAlert trigger_MerchPurchaseReceived Someone purchased your Merch
StreamlabsLoyaltyStoreRedemptionAlert trigger_StreamlabsLoyaltyStoreRedemptionReceived Someone Reddemed something from your LoyaltyStore
StreamlabTwitchFollowAlert trigger_TwitchFollowReceived A Viewer Followed your twitch stream
StreamlabsTwitchSubscriptionAlert trigger_TwitchSubscriptionReceived Someone Subscribed to your twitch stream
StreamlabsTwitchResubAlert trigger_TwitchResubReceived Someone Resubed to your twitch stream
StreamlabsTwitchHostAlert trigger_TwitchHostReceived Someone Hosted your stream on twitch
StreamlabsTwitchBitsAlert trigger_TwitchBitsReceived Someone Donated bits on Twitch
StreamlabsTwitchRaidAlert trigger_TwitchRaidReceived Someone Raided your stream on Twitch
StreamlabsTwitchCharityDonationAlert trigger_TwitchCharityDonationReceived Someone donated to charity on your Twitch stream
StreamlabsTwitchSubMysteryAlert trigger_TwitchSubMysteryGiftReceived Someone gifted some subs on your Twitch stream
StreamlabsYouTubeSubscriptionAlert trigger_YouTubeSubscriptionReceived Someone Subscribed on YouTube
StreamlabsYouTubeMemberAlert trigger_YouTubeMemberReceived A Member joined on YouTube
StreamlabsYouTubeSuperchatAlert trigger_YouTubeSuperchatReceived Someone Superchated on YouTube
StreamlabsDataDump trigger_StreamlabsDataDump Stream labs data dump, ie subs/month, top10 donators etc etc
StreamlabsDataDumpUnderlying trigger_StreamlabsDataDumpUnderlying Stream labs Underlying data dump, ie subs/month, top10 donators etc etc

Actions

name trigger description

"StreamlabsAPI" Extension Details...

Connects to Streamlabs API and provides alerts for dono's etc.
Source:

Methods

SaveConfigToServer()

Saves our config to the server
Source:

SendCredentialsModal(extensionname)

Send our CredentialsModal to whoever requested it
Parameters:
Name Type Description
extensionname String
Source:

SendSettingsWidgetSmall(toextension)

Send our settings widget code to the given extension
Parameters:
Name Type Description
toextension string
Source:

connectToStreamlabs(creds)

Connect to the streamlabs API
Parameters:
Name Type Description
creds object
Source:

heartBeatCallback()

Sends out heartbeat messages so other extensions can see our status
Source:

initialise(app, host, port, heartbeat)

Starts the extension using the given data.
Parameters:
Name Type Description
app object:Express
host string
port number
heartbeat number
Source:

onDataCenterConnect()

Called on connection to StreamRoller websocket
Source:

onDataCenterDisconnect(reason)

Handles websocket disconnect message from StreamRoller
Parameters:
Name Type Description
reason string
Source:

onDataCenterMessage(server_packet)

Called when we receive a message from StreamRoller
Parameters:
Name Type Description
server_packet object
Source:

onStreamlabsConnect()

Call on Streamlabs API connection
Source:

onStreamlabsDisconnect(reason)

Called when Streamlabs API socket has disconnected
Parameters:
Name Type Description
reason string
Source:

onStreamlabsEvent(data)

Handles messaged from the streamlabs api
Parameters:
Name Type Description
data object
Source:

outputTrigger(data)

Broadcast trigger on our channel
Parameters:
Name Type Description
data object
Source:

parseStreamlabsMessage(data)

Parses messages from StreamLabs events
Parameters:
Name Type Description
data object
Source:

start(host, port, heartbeat)

Starts the extension using the given data.
Parameters:
Name Type Description
host string
port number
heartbeat number
Source: