InstructBot Logo InstructBot
Login
Getting Started
Third Party Integrations
Overview StreamElements StreamLabs TipeeeStream Twitch
Applications
Commands
Overview
Command Types Creating Commands Downloading Commands Active Command Set Cooldowns Queues
Disable Profile Command Enable Profile Command External Command Help Command Input Command Mute Sound Command Parallel Command Play Sound Command Random Command Sequential Command Swap Left and Right Mouse Button Command Text Command Timeout Command Toggle Profile Command
Execute Command Nothing Command Use Command
Options
Environment
General Backup and Restore Console Key Bindings Sound Warnings
Notifications
Overview Connection
Commands
General Random Timeout Use
StreamElements StreamLabs TipeeeStream Twitch Users
Profiles
Rewards
Overview
Accumulator Discounts Follower Gifted Subscription Subscription
Editing Rewards Types of Rewards
Users Variables YouTube

Gifted Subscription

  1. Support
  2. Rewards
  3. Gifted Subscription

See: Enabled, General ( Only Active Viewers, Only Active Commands or Reward Sets ) or Notifications ( Enabled, Introduction, User Template, User Separator, Command Template or Command Separator )

The gifted subscription rewards control what commands, if any, are reward to users when they gift subscriptions to your channel.

Enabled

To enable gifted subscription rewards you must toggle them on.

InstructBot rewards screen showing an example of how to enable gifted subscription rewards.

You can see if gifted subscription rewards are currently enabled by the overlay icons in the navigation menu and window title bar. When enabled the Overlay icon showing that the subscriber rewards are currently enabled in InstructBot. overlay icon is shown, e.g.

Show an example of the enabled indicator for gifted subscription rewards in InstructBot.

When disabled, the Overlay icon showing that subscriber rewards are currently disabled in InstructBot. icon will be used instead.

General

See: Only Active Viewers, Only Active Commands or Reward Sets ( Adding a Reward Set, Removing a Reward Set or Editing a Reward Set )

The general tab of the gifted subscription reward screen controls what if anything is rewarded when a user gift one or more subscriptions to other users.

Only Active Viewers

When toggled on, only viewers which are active will be rewarded.

Example showing the only active viewers setting for the gifted subscription reward in InstructBot.

Only Active Commands

When toggled on, only commands which are enabled of those that are configured will be rewarded.

Example showing the only active commands setting for the gifted subscription reward in InstructBot.

Reward Sets

See: Adding a Reward Set, Removing a Reward Set or Editing a Reward Set ( Tier, Amount, Gifting Viewer, Other Viewers or Rewards )

Each gifted subscription reward set defined gives there rewards based upon the tier of the subscription and the amount of subscriptions gifted.

Adding a Reward Set

To add a reward set press the add button.

InstructBot showing how to add a gifted subscription reward set.

Removing a Reward Set

To remove a reward set you must select the reward set and then press the remove button.

InstructBot showing how to remove a gifted subscription reward set.

Editing a Reward Set

See: Tier, Amount, Gifting Viewer, Other Viewers or Rewards

To edit a reward set you select it.

InstructBot showing how to edit a gifted subscription reward set.

Tier

The tier setting of a gifted subscription reward set causes will match any gifted subscription based upon the tier given.

Example showing the tier setting for the gifted subscription reward set in InstructBot.

In the example above this reward set would be matched for a tier 2 subscription only.

Reward Set Resolution

When deciding which reward set to perform, the tier setting if matched first and then the amount settings are used.

Amount

The amount setting of a gifted subscription reward set causes it to function in four different ways.

The gifted subscription rewards editor showing the amount setting in InstructBot.

Exactly: Will match when the number of gifted subscriptions is equal to the specified amount.

Between: Will match when the number of gifted subscriptions is equal or more than the minimum amount and is equal or less than the maximum amount.

At Least: Will match when the number of gifted subscriptions is equal or more than the specified amount.

Up to: Will match when the number of gifted subscriptions is equal or less than the specified amount.

Reward Set Resolution

When deciding which reward set to perform, the tier setting if matched first and then the amount settings are matched from most restrictive to least restrictive, e.g. in the following order: Exactly, Between, At Least then At Most. If there are then multiple reward sets matched within the grouping they are matched from highest to lowest amount.

Gifting Viewer

The number of times to gift the rewards to the gifting viewer, if at all.

Example showing the gifting viewer setting for the gifted subscription reward in InstructBot.

Other Viewers

The number of times to gift the rewards to other viewers, e.g. viewers other than the gifting viewer, if at all.

Example showing the other viewer setting for the gifted subscription reward in InstructBot.

Rewards

The rewards to be gifted to the gifting and / or other viewers.

Example showing the configured rewards for the gifted subscription in InstructBot.

In the example above one use of the shoot command would be rewarded to the gifting viewer and no commands would be rewarded for other viewers.

For a more detailed explanation of how to add, remove and edit rewards see Editing Rewards. For an explanation of each reward type please see Types of Rewards.

Notifications

See: Enabled, Introduction, User Template, User Separator, Command Template or Command Separator

The notification tab of the gifted subscription reward screen controls what if anything is sent to chat when you get a gifted subscription.

Enabled

When toggled on a notification will be output into chat of the reward granted for the gifted subscription.

Example showing the gifted subscription reward notification enabled toggle button.

Note: If toggle off, no notification will sent when a user subscribers but the reward, if any, will still be added.

Introduction

The text used at the beginning of the message sent.

Example showing the notification introduction text for the gifted subscription reward in InstructBot.

Variables

AccountName: The name of the account logged into InstructBot.

ApplicationName: InstructBot's name.

TriggeringUser: The user which subscribed, see here for a full list of variables.

User Template

The template used to generate a piece of text per user.

Example showing the notification user template for the gifted subscription reward in InstructBot.

Variables

AccountName: The name of the account logged into InstructBot.

ApplicationName: InstructBot's name.

Command: The list of commands the user is being rewarded.

RewardedUser: The user which will receive the command, see here for a full list of variables.

User Separator

The text to place between each piece of text generated from the user template.

Example showing the notification user separator for the gifted subscription reward in InstructBot.

Command Template

The template used to generate a piece of text per command.

Example showing the notification command template for the gifted subscription reward in InstructBot.

Variables

Count: The number of uses rewarded.

RewardedCommand: The command being rewarded, see here for a full list of variables.

Command Separator

The text to place between each piece of text generated from the command template.

Example showing the notification command separator for the gifted subscription reward in InstructBot.

This website uses cookies to improve your experience. We'll assume you're ok with this, but you can opt-out if you wish.AcceptReject