Stream Kit Docs
API ReferenceYouTube

Super Chat

YouTube trigger: youtube:youtube:chat:super-chat

Super Chat

Trigger IDyoutube:youtube:chat:super-chat
PluginYouTube
CategoryChat

Variables

Copy variables into handler fields using {variableName} syntax.

{user}{userId}{message}{role}{amount}{amountMicros}{currency}{tier}{raw}{channelId}{channel}{liveChatId}{broadcastId}
NameTypeDescription
{user}
string

Display name of the user who triggered the event.

Example: TestUser

{userId}
string

Platform user ID of the chatter or actor.

Example: test-author-id

{message}
string

Full message text from the event.

Example: Test super chat

{role}
string

Role of the user (for example everyone, mod, broadcaster, vip, subscriber).

Example: everyone

{amount}
string

Numeric amount for the event (bits, points awarded, Super Chat value, etc.).

Example: $5.00

{amountMicros}
number

Super Chat amount in micro-units of the currency.

{currency}
string

ISO currency code for a Super Chat (for example USD, EUR).

Example: USD

{tier}
number

Subscription or Super Chat tier level.

Example: 1

{raw}
object

Raw platform chat message object (JSON).

{channelId}
string

YouTube channel ID for the connected account.

{channel}
string

Channel login or display name where the event occurred.

{liveChatId}
string

YouTube live chat ID for the active broadcast.

{broadcastId}
string

YouTube broadcast (stream) ID.

Conditions

ConditionDescription
MessageMatch message text (starts with, ends with, contains, equals). Leave empty to always match.
UsernameMatch chatter username (equals, contains, starts with, ends with). Leave empty to always match.
Minimum TierMinimum Super Sticker tier.
Minimum Amount (micros)Minimum numeric value for Minimum Amount (micros). Leave empty to disable.

On this page