twitch / trigger / schema v1
Chat Message
Fires when a chat message is received
Prerequisites
- Add the twitch plugin inside this workflow.
- Connect and authorize a twitch account before running this node.
Parameters
| Parameter | Type | Description |
|---|---|---|
Channelchannel | twitch_self Required | Triggers only on your connected Twitch channel. |
Prefix Filterprefix | tags Optional | Only trigger if message starts with any of these |
Keyword Filterkeyword | tags Optional | Only trigger if message contains any of these keywords |
First Message OnlyfirstMessageOnly | boolean Optional | Fire only the FIRST time a viewer ever chats in your channel. Perfect for welcome messages |
Moderators OnlymodsOnly | boolean Optional | Only trigger for messages from moderators |
Subscribers OnlysubsOnly | boolean Optional | Only trigger for messages from subscribers |
VIPs OnlyvipsOnly | boolean Optional | Only trigger for messages from VIPs |
From UserfromUser | tags Optional | Only trigger for messages from any of these usernames |
Inputs and outputs
Inputs
No ports declared.
Outputs
on_event- On Chat Message (output)message_id- Message ID (output)content- Message Content (output)user_id- User ID (output)username- Username (output)display_name- Display Name (output)channel- Channel Name (output)color- Chat Color (output)is_mod- Is Moderator (output)is_subscriber- Is Subscriber (output)is_vip- Is VIP (output)is_broadcaster- Is Broadcaster (output)badges- Badge List (output)bits- Bits Cheered (output)
Output data schema
[
{
"key": "message_id",
"type": "string",
"description": "Message ID",
"label": "Message ID",
"bindingRole": "event_subject"
},
{
"key": "content",
"type": "string",
"description": "Message Content",
"label": "Message Content"
},
{
"key": "user_id",
"type": "string",
"description": "User ID",
"label": "User ID",
"bindingRole": "actor"
},
{
"key": "username",
"type": "string",
"description": "Username",
"label": "Username",
"bindingRole": "actor"
},
{
"key": "display_name",
"type": "string",
"description": "Display Name",
"label": "Display Name",
"bindingRole": "actor"
},
{
"key": "channel",
"type": "string",
"description": "Channel Name",
"label": "Channel Name",
"bindingRole": "current_context"
},
{
"key": "color",
"type": "string",
"description": "Chat Color",
"label": "Chat Color",
"optional": true
},
{
"key": "is_mod",
"type": "boolean",
"description": "Is Moderator",
"label": "Is Moderator"
},
{
"key": "is_subscriber",
"type": "boolean",
"description": "Is Subscriber",
"label": "Is Subscriber"
},
{
"key": "is_vip",
"type": "boolean",
"description": "Is VIP",
"label": "Is VIP"
},
{
"key": "is_broadcaster",
"type": "boolean",
"description": "Is Broadcaster",
"label": "Is Broadcaster"
},
{
"key": "badges",
"type": "array",
"description": "Badge List",
"label": "Badge List",
"items": {
"key": "item",
"type": "string"
}
},
{
"key": "bits",
"type": "number",
"description": "Bits Cheered",
"label": "Bits Cheered",
"optional": true
}
]Examples and troubleshooting have not yet been reviewed for this contract.
Version and compatibility
This reference follows the current authoring contract. Existing workflows retain their saved node revisions.
Contract identifier
345e0db8a80cf3661657e17f90fe2a16cabb8fca42465affe7ad194fc623420e