The event information. The fields inside this object differ by subscription type.
Objects
Conditions
Channel Ban Condition
Name
Type
Required?
Description
broadcaster_user_id
string
yes
The broadcaster user ID for the channel you want to get ban notifications for.
Channel Subscribe Condition
Name
Type
Required?
Description
broadcaster_user_id
string
yes
The broadcaster user ID for the channel you want to get subscribe notifications for.
Channel Cheer Condition
Name
Type
Required?
Description
broadcaster_user_id
string
yes
The broadcaster user ID for the channel you want to get cheer notifications for.
Channel Update Condition
Name
Type
Required?
Description
broadcaster_user_id
string
yes
The broadcaster user ID for the channel you want to get updates for.
Channel Follow Condition
Name
Type
Required?
Description
broadcaster_user_id
string
yes
The broadcaster user ID for the channel you want to get follow notifications for.
Channel Unban Condition
Name
Type
Required?
Description
broadcaster_user_id
string
yes
The broadcaster user ID for the channel you want to get unban notifications for.
Channel Raid Condition
Name
Type
Required?
Description
from_broadcaster_user_id
string
no
The broadcaster user ID that created the channel raid you want to get notifications for. Use this parameter if you want to know when a specific broadcaster raids another broadcaster. The channel raid condition must include either from_broadcaster_user_id or to_broadcaster_user_id.
to_broadcaster_user_id
string
no
The broadcaster user ID that received the channel raid you want to get notifications for. Use this parameter if you want to know when a specific broadcaster is raided by another broadcaster. The channel raid condition must include either from_broadcaster_user_id or to_broadcaster_user_id.
Channel Points Custom Reward Add Condition
Name
Type
Required?
Description
broadcaster_user_id
string
yes
The broadcaster user ID for the channel you want to receive channel points custom reward add notifications for.
Channel Points Custom Reward Update Condition
Name
Type
Required?
Description
broadcaster_user_id
string
yes
The broadcaster user ID for the channel you want to receive channel points custom reward update notifications for.
reward_id
string
no
Optional. Specify a reward id to only receive notifications for a specific reward.
Channel Points Custom Reward Remove Condition
Name
Type
Required?
Description
broadcaster_user_id
string
yes
The broadcaster user ID for the channel you want to receive channel points custom reward remove notifications for.
reward_id
string
no
Optional. Specify a reward id to only receive notifications for a specific reward.
Whether a cooldown is enabled and what the cooldown is in seconds.
cooldown_expires_at
string
Timestamp of the cooldown expiration. null if the reward isn’t on cooldown.
redemptions_redeemed_current_stream
int
The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn’t live or max_per_stream isn’t enabled.
Channel Points Custom Reward Update Event
Name
Type
Description
id
string
The reward identifier.
broadcaster_user_id
string
The requested broadcaster ID.
broadcaster_user_login
string
The requested broadcaster login.
broadcaster_user_name
string
The requested broadcaster display name.
is_enabled
boolean
Is the reward currently enabled. If false, the reward won’t show up to viewers.
is_paused
boolean
Is the reward currently paused. If true, viewers can’t redeem.
is_in_stock
boolean
Is the reward currently in stock. If false, viewers can’t redeem.
title
string
The reward title.
cost
int
The reward cost.
prompt
string
The reward description.
is_user_input_required
boolean
Does the viewer need to enter information when redeeming the reward.
should_redemptions_skip_request_queue
boolean
Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status.
Whether a cooldown is enabled and what the cooldown is in seconds.
cooldown_expires_at
string
Timestamp of the cooldown expiration. null if the reward isn’t on cooldown.
redemptions_redeemed_current_stream
int
The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn’t live or max_per_stream isn’t enabled.
Channel Points Custom Reward Remove Event
Name
Type
Description
id
string
The reward identifier.
broadcaster_user_id
string
The requested broadcaster ID.
broadcaster_user_login
string
The requested broadcaster login.
broadcaster_user_name
string
The requested broadcaster display name.
is_enabled
boolean
Is the reward currently enabled. If false, the reward won’t show up to viewers.
is_paused
boolean
Is the reward currently paused. If true, viewers can’t redeem.
is_in_stock
boolean
Is the reward currently in stock. If false, viewers can’t redeem.
title
string
The reward title.
cost
int
The reward cost.
prompt
string
The reward description.
is_user_input_required
boolean
Does the viewer need to enter information when redeeming the reward.
should_redemptions_skip_request_queue
boolean
Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status.
Whether a cooldown is enabled and what the cooldown is in seconds.
cooldown_expires_at
string
Timestamp of the cooldown expiration. null if the reward isn’t on cooldown.
redemptions_redeemed_current_stream
int
The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn’t live or max_per_stream isn’t enabled.
Channel Points Custom Reward Redemption Add Event
Name
Type
Description
id
string
The redemption identifier.
broadcaster_user_id
string
The requested broadcaster ID.
broadcaster_user_login
string
The requested broadcaster login.
broadcaster_user_name
string
The requested broadcaster display name.
user_id
string
User ID of the user that redeemed the reward.
user_login
string
Login of the user that redeemed the reward.
user_name
string
Display name of the user that redeemed the reward.
user_input
string
The user input provided. Empty string if not provided.
status
string
Defaults to unfulfilled. Possible values are unknown, unfulfilled, fulfilled, and canceled.
An array of objects that describe a user, the type of their hype train contribution, and their total contribution amount. Contains a maximum of two user objects: one for the top bits contributor and one for the top subscriptions contributor (this includes gifted subscriptions).
Name
Type
Description
user_id
string
The ID of the user.
user_login
string
The login of the user.
user_name
string
The display name of the user.
type
string
Type of contribution. Valid values include bits, subscription.
total
int
The total contributed.
Transport
Name
Type
Required?
Description
method
string
yes
The transport method. Supported values: webhook.
callback
string
yes
The callback URL where the notification should be sent.