Overview
VMSC can connect to both Streamlabs and StreamElements as event sources. These services aggregate alerts from multiple platforms (Twitch, YouTube, etc.) and also provide their own donation/tip systems. VMSC receives events over real-time socket connections and normalizes them into the standard StreamEvent format.
⚠️
Duplicate events
If you connect to a native platform (e.g., Twitch via EventSub) and Streamlabs or StreamElements at the same time, you may receive the same event from both sources. Use the deduplication settings or platform source filters on your rules to prevent double-firing.
Authentication
| Service |
Auth Method |
Where to Find It |
| Streamlabs |
Socket API Token |
Streamlabs Dashboard > Settings > API Settings > API Tokens. Copy the Socket API Token. |
| StreamElements |
JWT Token |
StreamElements Dashboard > Account > Channels > Show Secrets. Copy the JWT Token. |
Paste the token into the corresponding field in VMSC > Dashboard on the platform connection panel.
Streamlabs Socket API Events
VMSC connects to sockets.streamlabs.com using the Socket API token. Events are received as Socket.IO messages with a type field.
| Streamlabs Event |
VMSC Event Type |
Description |
donation |
donation |
A viewer sends a Streamlabs tip/donation. |
follow |
follow |
A user follows the channel (Twitch/YouTube). |
subscription |
subscribe |
A user subscribes or resubscribes (Twitch). |
host |
host |
Another channel hosts the broadcaster (Twitch legacy). |
bits |
cheer |
A user cheers with Bits (Twitch). |
raid |
raid |
Another channel raids the broadcaster (Twitch). |
merch |
merch |
A viewer purchases merchandise via Streamlabs Merch. |
superchat |
superchat |
A YouTube Super Chat received via Streamlabs. |
membershipGift |
membership_gift |
A YouTube membership gift received via Streamlabs. |
charityDonation |
charity_donate |
A Twitch charity donation received via Streamlabs. |
Streamlabs Data Fields
donation
| Field | Type | Description |
|---|
amount | number | Donation amount as a decimal (e.g., 5.00). |
currency | string | ISO 4217 currency code. |
message | string | Donation message text. |
from | string | Donor's display name. |
subscription
| Field | Type | Description |
|---|
subPlan | string | Subscription plan: "1000", "2000", "3000", or "Prime". |
months | number | Cumulative subscription months. |
message | string | Resub message (if any). |
gifter | string | Gifter's display name (if gifted). |
bits
| Field | Type | Description |
|---|
amount | number | Number of Bits cheered. |
message | string | Cheer message text. |
raid
| Field | Type | Description |
|---|
raiders | number | Number of viewers in the raid. |
merch
| Field | Type | Description |
|---|
product | string | Name of the purchased product. |
message | string | Message attached to the purchase. |
StreamElements Socket.IO Events
VMSC connects to realtime.streamelements.com using the JWT token. Events arrive as Socket.IO messages with an event name of "event" and a nested type field.
| StreamElements Event |
VMSC Event Type |
Description |
tip |
donation |
A viewer sends a StreamElements tip. |
follow |
follow |
A user follows the channel. |
subscriber |
subscribe |
A user subscribes or resubscribes. |
cheer |
cheer |
A user cheers with Bits. |
raid |
raid |
Another channel raids the broadcaster. |
host |
host |
Another channel hosts the broadcaster. |
merch |
merch |
A viewer purchases merchandise via StreamElements Merch. |
redemption |
redemption |
A viewer redeems a StreamElements store item. |
superchat |
superchat |
A YouTube Super Chat received via StreamElements. |
communityGiftPurchase |
gift_sub |
A viewer gifts community subscriptions. |
StreamElements Data Fields
tip (donation)
| Field | Type | Description |
|---|
amount | number | Tip amount as a decimal. |
currency | string | ISO 4217 currency code. |
message | string | Tip message text. |
subscriber
| Field | Type | Description |
|---|
tier | string | Subscription tier: "1000", "2000", "3000", or "prime". |
amount | number | Cumulative months subscribed. |
message | string | Resub message (if any). |
gifted | boolean | Whether this sub was gifted. |
sender | string | Gifter's name (if gifted). |
cheer
| Field | Type | Description |
|---|
amount | number | Number of Bits cheered. |
message | string | Cheer message text. |
raid
| Field | Type | Description |
|---|
amount | number | Number of viewers in the raid. |
redemption
| Field | Type | Description |
|---|
itemId | string | ID of the redeemed store item. |
itemName | string | Name of the redeemed store item. |
itemCost | number | Loyalty point cost of the item. |
message | string | User input message (if required). |
communityGiftPurchase
| Field | Type | Description |
|---|
amount | number | Number of gift subs purchased. |
tier | string | Subscription tier gifted. |