Skip to main content
Corvus Connection

On Channel Point Redeem

Twitch
Trigger
entry.onChannelPointRedeemFires when a viewer redeems a custom channel-point reward. Binds the redeemer, the reward, any typed input, and the ids needed to approve or refund this redemption.Triggers on a channel-point reward redemption.
MonetizationEngagement

Outputs

Name
Kind
Type
Flags
out
Exec
exec
None
userId
Data
System.String
multiplexed
displayName
Data
System.String
multiplexed
rewardTitle
Data
System.String
multiplexed
rewardCost
Data
System.Int32
multiplexed
userInput
Data
System.String
multiplexed
rewardId
Data
System.String
multiplexed
redemptionId
Data
System.String
multiplexed
isManaged
Data
System.Boolean
multiplexed
  • Name
    out
    Kind
    Exec
    Type
    exec
    Flags
    None
  • Name
    userId
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    displayName
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    rewardTitle
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    rewardCost
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    userInput
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    rewardId
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    redemptionId
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    isManaged
    Kind
    Data
    Type
    System.Boolean
    Flags
    multiplexed

Bindings

Name
Type
Description
userId
System.String
The redeemer's user id.
displayName
System.String
The redeemer's display name.
rewardTitle
System.String
The title of the redeemed reward.
rewardCost
System.Int32
The channel-point cost of the reward.
userInput
System.String
The text the viewer entered, when the reward prompts for input.
rewardId
System.String
The redeemed reward's Twitch id. Wire it into Fulfill Redemption or Refund Redemption.
redemptionId
System.String
This redemption's Twitch id: the one that fired the trigger.
isManaged
System.Boolean
True when Corvus created this reward and can therefore approve or refund the redemption. False for rewards made in the Twitch dashboard.
  • Name
    userId
    Type
    System.String
    Description
    The redeemer's user id.
  • Name
    displayName
    Type
    System.String
    Description
    The redeemer's display name.
  • Name
    rewardTitle
    Type
    System.String
    Description
    The title of the redeemed reward.
  • Name
    rewardCost
    Type
    System.Int32
    Description
    The channel-point cost of the reward.
  • Name
    userInput
    Type
    System.String
    Description
    The text the viewer entered, when the reward prompts for input.
  • Name
    rewardId
    Type
    System.String
    Description
    The redeemed reward's Twitch id. Wire it into Fulfill Redemption or Refund Redemption.
  • Name
    redemptionId
    Type
    System.String
    Description
    This redemption's Twitch id: the one that fired the trigger.
  • Name
    isManaged
    Type
    System.Boolean
    Description
    True when Corvus created this reward and can therefore approve or refund the redemption. False for rewards made in the Twitch dashboard.

Parameters

Name
Type
Required
Default
Choices
cooldownSeconds
System.Int32
no
0
None
perUserCooldownSeconds
System.Int32
no
0
None
debounceMs
System.Int32
no
0
None
dedupeKey
System.String
no
""
None
maxConcurrency
System.Int32
no
0
None
  • Name
    cooldownSeconds
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    perUserCooldownSeconds
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    debounceMs
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    dedupeKey
    Type
    System.String
    Required
    no
    Default
    ""
    Choices
    None
  • Name
    maxConcurrency
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None

Lowers to C#

[OnChannelPointRedeem] Handle(ctx, ChannelPointRedeemContext e)

Used in