TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixCreateCustomRewardData

Data to create a new custom reward.

{
Whether the redemption should automatically set its status to fulfilled.
autoFulfill?: boolean
The hex code of the background color of the reward.
The channel points cost of the reward.
cost: number
The cooldown between two redemptions of the reward, in seconds. 0 or `null` means no cooldown.
globalCooldown?: number | null
Whether the reward is enabled (shown to users).
isEnabled?: boolean
The maximum number of redemptions of the reward per stream. 0 or `null` means no limit.
maxRedemptionsPerStream?: number | null
The maximum number of redemptions of the reward per stream for each user. 0 or `null` means no limit.
The prompt shown to users when redeeming the reward.
prompt?: string
The title of the reward.
title: string
Whether the reward requires user input to be redeemed.
}

Properties

autoFulfill

Type: ?boolean

Whether the redemption should automatically set its status to fulfilled.

backgroundColor

Type: ?string

The hex code of the background color of the reward.

cost

Type: number

The channel points cost of the reward.

globalCooldown

Type: number | null

The cooldown between two redemptions of the reward, in seconds. 0 or null means no cooldown.

isEnabled

Type: ?boolean

Whether the reward is enabled (shown to users).

maxRedemptionsPerStream

Type: number | null

The maximum number of redemptions of the reward per stream. 0 or null means no limit.

maxRedemptionsPerUserPerStream

Type: number | null

The maximum number of redemptions of the reward per stream for each user. 0 or null means no limit.

prompt

Type: ?string

The prompt shown to users when redeeming the reward.

title

Type: string

The title of the reward.

userInputRequired

Type: ?boolean

Whether the reward requires user input to be redeemed.