Stream Kit DocsAPI ReferenceYouTube
Chat Message
YouTube trigger: youtube:youtube:chat:chat-message
Chat Message
| Trigger ID | youtube:youtube:chat:chat-message |
| Plugin | YouTube |
| Category | Chat |
Variables
Copy variables into handler fields using {variableName} syntax.
{user}{userId}{message}{role}{raw}{channelId}{channel}{liveChatId}{broadcastId}| Name | Type | Description |
|---|---|---|
{user} | string | Display name of the user who triggered the event. Example: |
{userId} | string | Platform user ID of the chatter or actor. Example: |
{message} | string | Full message text from the event. Example: |
{role} | string | Role of the user (for example everyone, mod, broadcaster, vip, subscriber). Example: |
{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
| Condition | Description |
|---|---|
| Message | Match message text (starts with, ends with, contains, equals). Leave empty to always match. |
| Username | Match chatter username (equals, contains, starts with, ends with). Leave empty to always match. |
| Role | Only fire for users with the selected role (mod, broadcaster, VIP, subscriber, artist, founder). |
| Command | Match chat commands (supports <arg> placeholders). Leave empty to match all messages. |