Due to limitations imposed by the Twitch API, Fossabot is only able to return metadata for rewards created through the Fossabot dashboard. Create them through Fossabot’s
Channel Points page.$(twitchreward)
Fossabot only counts up to 250 unfulfilled redemptions. Rewards with more than 250 unfulfilled redemptions will return
250+.$(twitchreward.queue_depth), the number of unfulfilled redemptions for the reward.
Parameters
This variable takes one required parameter that is the name of the Twitch Channel Point Reward to fetch the metadata of.Example Output
-
$(twitchreward Play a game of VALORANT with me!) -
$(twitchreward 251 people have redeemed this reward...)
Error Output
-
In case the reward was not found:
-
In case the reward was not created through the Fossabot dashboard:
$(twitchreward.queue_depth)
Fossabot only counts up to 250 unfulfilled redemptions. Rewards with more than 250 unfulfilled redemptions will return
250+.Parameters
This variable takes one required parameter that is the name of the Twitch Channel Point Reward to fetch the metadata of.Example Output
-
$(twitchreward.queue_depth Play a game of VALORANT with me!) -
$(twitchreward.queue_depth 251 people have redeemed this reward...)
Error Output
-
In case the reward was not found:
-
In case the reward was not created through the Fossabot dashboard:
$(twitchreward.redeemer_position)
Returns the position for the message sender in the redemption queue.Parameters
This variable takes one required parameter that is the name of the Twitch Channel Point Reward to fetch the metadata of.Example Output
-
$(twitchreward.redeemer_position Play a game of VALORANT with me!)
Error Output
-
In case the reward was not found:
-
In case the reward was not created through the Fossabot dashboard:
-
In case the user does not have a pending redemption in the rewards queue:
$(twitchreward.redeemer_position.USERNAME_OR_ID)
Returns the position for a specific user in the redemption queue. ReplaceUSERNAME_OR_ID with another variable, such as $(user), or a hardcoded value. You may specifiy either a user ID, or username.
Parameters
This variable takes one required parameter that is the name of the Twitch Channel Point Reward to fetch the metadata of.Example Output
-
$(twitchreward.redeemer_position.aiden Play a game of VALORANT with me!) -
$(twitchreward.redeemer_position.87763385 Play a game of VALORANT with me!)
Error Output
-
In case the reward was not found:
-
In case the reward was not created through the Fossabot dashboard:
-
In case the user does not have a pending redemption in the rewards queue:
$(twitchreward.redeemers)
Returns the 5 oldest redeemers in the queue, sorted by oldest redemption first.Parameters
This variable takes one required parameter that is the name of the Twitch Channel Point Reward to fetch the metadata of.Example Output
-
$(twitchreward.redeemers Play a game of VALORANT with me!)
Error Output
-
In case the reward was not found:
-
In case the reward was not created through the Fossabot dashboard:
$(twitchreward.redeemers.COUNT)
Allows you to return a custom number of redeemers in the queue, sorted by oldest redemption first. You may specify a count between1 and 25. A value outside of these bounds will return 5.
Parameters
This variable takes one required parameter that is the name of the Twitch Channel Point Reward to fetch the metadata of.Example Output
-
$(twitchreward.redeemers.3 Play a game of VALORANT with me!) -
$(twitchreward.redeemers.4 Play a game of VALORANT with me!) -
$(twitchreward.redeemers.4 Play a game of VALORANT with me!)
Error Output
-
In case the reward was not found:
-
In case the reward was not created through the Fossabot dashboard: