The "Receive Message" Node Trigger
Triggers when receiving a Twitch message.
Receive Message
- Message
- Message Text
Outputs
- Message − An object with data about the message. Contains the following attributes.
- id − The Twitch-assigned id of the message.
- date − Date-time object representing the time the message was sent.
- message − The message text. Same as
Message Text. - chatter − An object with data about the sender account (see Account Object).
- color − The color of the sender in the current channel as an RGB hex code.
- broadcaster − An object with data about the current channel account (see Account Object).
- badges − List of objects with data about the senders currently selected badges. Includes subscriber, VIP, artist, and moderator badges and so on. (See Badge Object)
- isFirstMessage − Sent by Twitch.
trueif this is the first message from that account in the current channel. - isReturningChatter − Also sent by Twitch, sparsely documented. According to them "New viewers who have chatted at least twice in the last 30 days". Seemingly, this is
falsefor returning chatters who are not "new viewers".
- Message Text − The message text.
Account Object
- id − The Twitch-assigned id of the account. This is a text type, even though it contains digit characters only.
- name − All-lowercase login name of the account.
- displayName − Preferred capitalization of the login name.
Badge Object
Refer to the stream database for a list of all available badges on Twitch.
- setId − The Twitch-assigned id of the event this badge is from. Almost always, a "train-case" formatted, readable text.
- id − The id of the badge, only unique within the set. Usually "1".
- info − Additional data about the badge. For subscriber badges this is the amount of total months the account has been a subscriber as a text containing digit characters. Otherwise, an empty text.
TIP
See the Check User Role node to check if a sender has a specific role, like VIP or moderator.
See also: https://dev.twitch.tv/docs/eventsub/eventsub-reference/#channel-chat-message-event

