diff --git a/doc_posts/_triggers/twitch.md b/doc_posts/_triggers/twitch.md index 9563501..5182ed4 100644 --- a/doc_posts/_triggers/twitch.md +++ b/doc_posts/_triggers/twitch.md @@ -46,11 +46,36 @@ Message | Chat message to listen to. Must be an exact match. Can include **[Wild | Display Name | Viewer's display name (can contain uppercase characters). | | User ID | Viewer's user ID. | | Message | Viewer's message. | +| Message ID | ID of the viewer's message | | Emote List | Viewer's available emotes.
Basic format: `FirstEmoteID:FirstIndex-LastIndex/ SecondEmoteID:FirstIndex-LastIndex`
Message containing multiple emotes will be formatted such as: `FirstEmoteID:FirstIndex(1)-LastIndex(1),FirstIndex(2)-LastIndex(2),FirstIndex(3)-LastIndex(3)`
{% include image_collapse_table.html name="chat_emotes" src="chat_emotes.png" alt="Chat Emotes List" btn="Emotes Example" %}| | Badge List | Basic format: `FirstBadgeName/version,SecondBadgeName/version`
For example: `broadcaster/1, subscriber/0`
[Global Badges List](https://badges.twitch.tv/v1/badges/global/display), [Channel Badges List](https://badges.twitch.tv/v1/badges/channels/CHANNEL_ID/display)
To find the badge ID in the JSON, look for BadgeList.badge_sets[`BADGENAME`].versions[`VERSION`].image_url_1x. The last part 1x can be changed to 2x, 3x or 4x for bigger size. | | Channel | Channel Name where the message originated from. Will return `w` if it's a whisper. | | Name Color | Chat name color in hexadecimal format. | +| Bits | The amount of bits cheered. (Does not include PowerUps)| +| Custom Reward ID | ID of the Reward that was redeemed. | + +| Reply Parent User Login | User login of the sender of the parent message. | +| Reply Parent Display Name | User name of the sender of the parent message. | +| Reply Parent User ID | User ID of the sender of the parent message. | +| Reply Parent Message Body | The message body of the parent message. | +| Reply Parent Message Id | An ID that uniquely identifies the parent message that this message is replying to. | +| Reply Thread Parent Message ID | An ID that identifies the parent message of the reply thread. | +| Reply Thread Parent User Login | User ID of the sender of the thread’s parent message. | + +| Room ID | An ID that identifies the chat room (channel). | +| Source ID | A UUID that identifies the source message from the channel the message was sent from. | +| Source Room ID | An ID that identifies the chat room (channel) the message was sent from. | +| Source Badges | Comma-seperated list of chat badges for the chatter in the room the message was sent from. This uses the same format as the badges list. | +| Source Badge Info | Contains metadata related to the chat badges in the source-badges tag. | + +| Is Broadcaster | Whether the chatter is the broadcaster. 0 = not broadcaster, 1 = broadcaster | +| Is Mod | Whether the chatter is a mod. 0 = not mod, 1 = mod | +| Is VIP | Whether the chatter is a vip. 0 = not vip, 1 = vip | +| Is Founder | Whether the chatter is a Founder. 0 = not founder, 1 = founder | +| Is Subscriber | Whether the chatter is a subscriber. 0 = not subscriber, 1 = subscriber | +| Is Turbo | Whether the chatter is a turbo user. 0 = no turbo, 1 = has turbo | | First Time | Whether it's user's first chat message. 0 = not first, 1 = first | +| Unix Timestamp | The timestamp when the message was sent, in Unix format. | | From Channel ID | Which channel the trigger came from. | {:class='table table-secondary table-hover' } @@ -326,3 +351,30 @@ Triggers when the /shoutout command is used. The channel must be live and stream |Recent Categories|Recent categories streamed by the person being shouted out. |From Channel ID|Channel ID of the channel making the shoutout. {:class='table table-secondary table-hover' } + +
+ +##### Twitch Automatic Reward Redemption +Triggers when any automatic reward is redeemed, for example "Gigantify an Emote" or "Unlock a Random Sub Emote". + +{% include alert.html text="Cost does not show Bit cost. It only shows the amount of channel points something cost." type="warning" %} +{% include alert.html text="If user redeems Gigantify Emote the emote the user Gigantified will be the last index in the array." type="info" %} + +| Pull Data Value | Explanation | +|-------|--------| +|User Name|Viewers username. +|Display Name|Viewer's display name. +|User ID|Viewer's user ID. +|Cost|Reward cost. +|Message|Viewer's message if required. +|Emotes|Array of objects with the Emote IDs within the message. +|Type|Redemption Type. Returns message_effect, gigantify_an_emote, celebration, send_highlighted_message, random_sub_emote_unlock, single_message_bypass_sub_mode, chosen_sub_emote_unlock or chosen_modified_sub_emote_unlock +|Unlocked Emote|Returns an Object with the ID and Name of the unlocked emote +|Redeemed At|The time in twitch format, that the item was redeemed +|Reward ID|Reward's general ID. +|Redeem ID|Redeem's specific ID. +|Channel ID|Which channel the trigger came from. +|From Channel ID|Which channel the trigger came from. +{:class='table table-secondary table-hover' } + +