Subscription Types
| Subscription Type | Name | Version | Description |
|---|---|---|---|
| Channel Update | channel.update |
1 |
A broadcaster updates their channel properties e.g., category, title, mature flag, broadcast, or language. |
| Channel Follow | channel.follow |
1 |
A specified channel receives a follow. |
| Channel Subscribe | channel.subscribe |
1 |
A notification when a specified channel receives a subscriber. This does not include resubscribes. |
| Channel Subscription End | channel.subscription.end |
1 |
A notification when a subscription to the specified channel ends. |
| Channel Subscription Gift | channel.subscription.gift |
1 |
A notification when a viewer gives a gift subscription to one or more users in the specified channel. |
| Channel Subscription Message | channel.subscription.message |
1 |
A notification when a user sends a resubscription chat message in a specific channel. |
| Channel Cheer | channel.cheer |
1 |
A user cheers on the specified channel. |
| Channel Raid | channel.raid |
1 |
A broadcaster raids another broadcaster’s channel. |
| Channel Ban | channel.ban |
1 |
A viewer is banned from the specified channel. |
| Channel Unban | channel.unban |
1 |
A viewer is unbanned from the specified channel. |
| Channel Moderator Add | channel.moderator.add |
1 |
Moderator privileges were added to a user on a specified channel. |
| Channel Moderator Remove | channel.moderator.remove |
1 |
Moderator privileges were removed from a user on a specified channel. |
| Channel Points Custom Reward Add | channel.channel_points_custom_reward.add |
1 |
A custom channel points reward has been created for the specified channel. |
| Channel Points Custom Reward Update | channel.channel_points_custom_reward.update |
1 |
A custom channel points reward has been updated for the specified channel. |
| Channel Points Custom Reward Remove | channel.channel_points_custom_reward.remove |
1 |
A custom channel points reward has been removed from the specified channel. |
| Channel Points Custom Reward Redemption Add | channel.channel_points_custom_reward_redemption.add |
1 |
A viewer has redeemed a custom channel points reward on the specified channel. |
| Channel Points Custom Reward Redemption Update | channel.channel_points_custom_reward_redemption.update |
1 |
A redemption of a channel points custom reward has been updated for the specified channel. |
| Channel Poll Begin | channel.poll.begin |
1 |
A poll started on a specified channel. |
| Channel Poll Progress | channel.poll.progress |
1 |
Users respond to a poll on a specified channel. |
| Channel Poll End | channel.poll.end |
1 |
A poll ended on a specified channel. |
| Channel Prediction Begin | channel.prediction.begin |
1 |
A Prediction started on a specified channel. |
| Channel Prediction Progress | channel.prediction.progress |
1 |
Users participated in a Prediction on a specified channel. |
| Channel Prediction Lock | channel.prediction.lock |
1 |
A Prediction was locked on a specified channel. |
| Channel Prediction End | channel.prediction.end |
1 |
A Prediction ended on a specified channel. |
| BETA Charity Donation | channel.charity_campaign.donate |
beta |
Sends an event notification when a user donates to the broadcaster’s charity campaign. |
| Drop Entitlement Grant | drop.entitlement.grant |
1 |
An entitlement for a Drop is granted to a user. |
| Extension Bits Transaction Create | extension.bits_transaction.create |
1 |
A Bits transaction occurred for a specified Twitch Extension. |
| Goal Begin | channel.goal.begin |
1 |
Get notified when a broadcaster begins a goal. |
| Goal Progress | channel.goal.progress |
1 |
Get notified when progress (either positive or negative) is made towards a broadcaster’s goal. |
| Goal End | channel.goal.end |
1 |
Get notified when a broadcaster ends a goal. |
| Hype Train Begin | channel.hype_train.begin |
1 |
A Hype Train begins on the specified channel. |
| Hype Train Progress | channel.hype_train.progress |
1 |
A Hype Train makes progress on the specified channel. |
| Hype Train End | channel.hype_train.end |
1 |
A Hype Train ends on the specified channel. |
| Stream Online | stream.online |
1 |
The specified broadcaster starts a stream. |
| Stream Offline | stream.offline |
1 |
The specified broadcaster stops a stream. |
| User Authorization Grant | user.authorization.grant |
1 |
A user’s authorization has been granted to your client id. |
| User Authorization Revoke | user.authorization.revoke |
1 |
A user’s authorization has been revoked for your client id. |
| User Update | user.update |
1 |
A user has updated their account. |
Public Beta Program
When new subscription types are added to EventSub, they are occasionally released as a public beta and denoted with the BETA tag. This provides the community an opportunity to provide feedback via UserVoice to make sure it meets expectations before a more established version is committed.
Unless otherwise noted, EventSub subscriptions that were released as a public beta will be available for 30 days after their v1 version is released. Subscriptions should be updated to v1 during this timeframe to continue its functionality. Any active beta subscriptions beyond 30 days will be automatically deleted.
Channel Subscriptions
channel.update
The channel.update subscription type sends notifications when a broadcaster updates the category, title, mature flag, or broadcast language for their channel.
Authorization
No authorization required.
Channel Update Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.update. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Pass in the broadcaster_user_id for the channel you want updates for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Update Webhook Example
{
"type": "channel.update",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Update Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | Returns the user ID, user name, title, language, category ID, category name, and mature flag setting for the given broadcaster. |
Channel Update Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.update",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"title": "Best Stream Ever",
"language": "en",
"category_id": "21779",
"category_name": "Fortnite",
"is_mature": false
}
}
channel.follow
The channel.follow subscription type sends a notification when a specified channel receives a follow.
Authorization
No authorization required.
Channel Follow Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.follow. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. |
transport |
transport | yes | Transport-specific parameters. |
Channel Follow Webhook Example
{
"type": "channel.follow",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Follow Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. Contains the user ID and user name of the follower and the broadcaster user ID and broadcaster user name. |
Channel Follow Webhook Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.follow",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"user_id": "1234",
"user_login": "cool_user",
"user_name": "Cool_User",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cooler_user",
"broadcaster_user_name": "Cooler_User",
"followed_at": "2020-07-15T18:16:11.17106713Z"
}
}
channel.subscribe
The channel.subscribe subscription type sends a notification when a specified channel receives a subscriber. This does not include resubscribes.
Authorization
Must have channel:read:subscriptions scope.
Channel Subscribe Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.subscribe. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. |
transport |
transport | yes | Transport-specific parameters. |
Channel Subscribe Webhook Example
{
"type": "channel.subscribe",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Subscribe Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. Contains the user ID and user name of the subscriber, the broadcaster user ID and broadcaster user name, and whether the subscription is a gift. |
Channel Subscribe Webhook Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.subscribe",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"user_id": "1234",
"user_login": "cool_user",
"user_name": "Cool_User",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cooler_user",
"broadcaster_user_name": "Cooler_User",
"tier": "1000",
"is_gift": false
}
}
channel.subscription.end
The channel.subscription.end subscription type sends a notification when a subscription to the specified channel expires.
Authorization
Must have channel:read:subscriptions scope.
Channel Subscription End Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.subscription.end. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. |
transport |
transport | yes | Transport-specific parameters. |
Channel Subscription End Webhook Example
{
"type": "channel.subscription.end",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Subscription End Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the EventSub subscription. |
event |
event | The event information. Contains the user ID, user login, and user display name of the user whose subscription has expired, as well as the broadcaster user ID, broadcaster login, and broadcaster display name. |
Channel Subscription End Webhook Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.subscription.end",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"user_id": "1234",
"user_login": "cool_user",
"user_name": "Cool_User",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cooler_user",
"broadcaster_user_name": "Cooler_User",
"tier": "1000",
"is_gift": false
}
}
channel.subscription.gift
The channel.subscription.gift subscription type sends a notification when a user gives one or more gifted subscriptions in a channel.
Authorization
Must have channel:read:subscriptions scope.
Channel Subscription Gift Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.subscription.gift. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. |
transport |
transport | yes | Transport-specific parameters. |
Channel Subscription Gift Webhook Example
{
"type": "channel.subscription.gift",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Subscription Gift Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the EventSub subscription. |
event |
event | The event information. Contains information about the user who gave the gift subscriptions, and the number and tier of subscriptions included in the gift. |
Channel Subscription Gift Webhook Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.subscription.gift",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"user_id": "1234",
"user_login": "cool_user",
"user_name": "Cool_User",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cooler_user",
"broadcaster_user_name": "Cooler_User",
"total": 2,
"tier": "1000",
"cumulative_total": 284, //null if anonymous or not shared by the user
"is_anonymous": false
}
}
channel.subscription.message
The channel.subscription.message subscription type sends a notification when a user sends a resubscription chat message in a specific channel.
Authorization
Must have channel:read:subscriptions scope.
Channel Subscription Message Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.subscription.message. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. |
transport |
transport | yes | Transport-specific parameters. |
Channel Subscription Message Webhook Example
{
"type": "channel.subscription.message",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Subscription Message Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the EventSub subscription. |
event |
event | The event information. Contains information about the user who resubscribed and their resubscription chat message. |
Channel Subscription Message Webhook Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.subscription.message",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"user_id": "1234",
"user_login": "cool_user",
"user_name": "Cool_User",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cooler_user",
"broadcaster_user_name": "Cooler_User",
"tier": "1000",
"message": {
"text": "Love the stream! FevziGG",
"emotes": [
{
"begin": 23,
"end": 30,
"id": "302976485"
}
]
},
"cumulative_months": 15,
"streak_months": 1, // null if not shared
"duration_months": 6
}
}
channel.cheer
The channel.cheer subscription type sends a notification when a user cheers on the specified channel.
Authorization
Must have bits:read scope.
Channel Cheer Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.cheer. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive cheer notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Cheer Webhook Example
{
"type": "channel.cheer",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Cheer Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. Contains the user ID and user name of the cheering user along with the broadcaster user id and broadcaster user name. |
Channel Cheer Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.cheer",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"is_anonymous": false,
"user_id": "1234", // null if is_anonymous=true
"user_login": "cool_user", // null if is_anonymous=true
"user_name": "Cool_User", // null if is_anonymous=true
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cooler_user",
"broadcaster_user_name": "Cooler_User",
"message": "pogchamp",
"bits": 1000
}
}
channel.raid
The channel.raid subscription type sends a notification when a broadcaster raids another broadcaster’s channel.
Authorization
No authorization required.
Channel Raid Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.raid. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in either from_broadcaster_user_id or to_broadcaster_user_id. If you pass in both parameters you will receive an error. |
transport |
transport | yes | Transport-specific parameters. |
Channel Raid Webhook Example
{
"type": "channel.raid",
"version": "1",
"condition": {
"to_broadcaster_user_id": "1337" // could provide from_broadcaster_user_id instead
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Raid Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. Contains the from and to broadcaster information along with the number of viewers in the raid. Will only notify for raids that appear in chat. |
Channel Raid Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.raid",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"to_broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"from_broadcaster_user_id": "1234",
"from_broadcaster_user_login": "cool_user",
"from_broadcaster_user_name": "Cool_User",
"to_broadcaster_user_id": "1337",
"to_broadcaster_user_login": "cooler_user",
"to_broadcaster_user_name": "Cooler_User",
"viewers": 9001
}
}
channel.ban
The channel.ban subscription type sends a notification when a viewer is timed out or banned from the specified channel.
Authorization
Must have channel:moderate scope.
Channel Ban Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.ban. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive ban notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Ban Webhook Example
{
"type": "channel.ban",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Ban Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. Will notify on timeouts as well as bans. Contains the user ID and user name of the banned user, the broadcaster user ID and broadcaster user name, the user ID and user name of the moderator who issued the ban/timeout, the reason, and expiration time if it is a timeout. |
Channel Ban Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.ban",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"user_id": "1234",
"user_login": "cool_user",
"user_name": "Cool_User",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cooler_user",
"broadcaster_user_name": "Cooler_User",
"moderator_user_id": "1339",
"moderator_user_login": "mod_user",
"moderator_user_name": "Mod_User",
"reason": "Offensive language",
"banned_at": "2020-07-15T18:15:11.17106713Z",
"ends_at": "2020-07-15T18:16:11.17106713Z",
"is_permanent": false
}
}
channel.unban
The channel.unban subscription type sends a notification when a viewer is unbanned from the specified channel.
Authorization
Must have channel:moderate scope.
Channel Unban Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.unban. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive unban notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Unban Webhook Example
{
"type": "channel.unban",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Unban Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. Contains the user ID and user name of the unbanned user, the broadcaster user id and broadcaster user name, as well as the user ID and user name of the moderator who issued the unban. |
Channel Unban Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.unban",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"user_id": "1234",
"user_login": "cool_user",
"user_name": "Cool_User",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cooler_user",
"broadcaster_user_name": "Cooler_User",
"moderator_user_id": "1339",
"moderator_user_login": "mod_user",
"moderator_user_name": "Mod_User"
}
}
channel.moderator.add
The channel.moderator.add subscription type sends a notification when a user is given moderator privileges on a specified channel.
Authorization
Must have moderation:read scope.
Channel Moderator Add Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.moderator.add. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive moderator addition notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Moderator Add Example
{
"type": "channel.moderator.add",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Moderator Add Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. Contains user information of the new moderator as well as broadcaster information of the channel the event occurred on. |
Channel Moderator Add Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.moderator.add",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"user_id": "1234",
"user_login": "mod_user",
"user_name": "Mod_User",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cooler_user",
"broadcaster_user_name": "Cooler_User"
}
}
channel.moderator.remove
The channel.moderator.remove subscription type sends a notification when a user has moderator privileges removed on a specified channel.
Authorization
Must have moderation:read scope.
Channel Moderator Remove Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.moderator.remove. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive moderator removal notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Moderator Remove Example
{
"type": "channel.moderator.remove",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Moderator Remove Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. Contains user information of the old moderator as well as broadcaster information of the channel the event occurred on. |
Channel Moderator Remove Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.moderator.remove",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"user_id": "1234",
"user_login": "not_mod_user",
"user_name": "Not_Mod_User",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cooler_user",
"broadcaster_user_name": "Cooler_User"
}
}
channel.channel_points_custom_reward.add
The channel.channel_points_custom_reward.add subscription type sends a notification when a custom channel points reward has been created for the specified channel.
Authorization
Must have channel:read:redemptions or channel:manage:redemptions scope.
Channel Points Custom Reward Add Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.channel_points_custom_reward.add. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive channel points customer reward add notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Points Custom Reward Add Webhook Example
{
"type": "channel.channel_points_custom_reward.add",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Points Custom Reward Add Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. Contains data about the custom reward added to the broadcaster’s channel. |
Channel Points Custom Reward Add Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.channel_points_custom_reward.add",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "9001",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"is_enabled": true,
"is_paused": false,
"is_in_stock": true,
"title": "Cool Reward",
"cost": 100,
"prompt": "reward prompt",
"is_user_input_required": true,
"should_redemptions_skip_request_queue": false,
"cooldown_expires_at": null,
"redemptions_redeemed_current_stream": null,
"max_per_stream": {
"is_enabled": true,
"value": 1000
},
"max_per_user_per_stream": {
"is_enabled": true,
"value": 1000
},
"global_cooldown": {
"is_enabled": true,
"seconds": 1000
},
"background_color": "#FA1ED2",
"image": {
"url_1x": "https://static-cdn.jtvnw.net/image-1.png",
"url_2x": "https://static-cdn.jtvnw.net/image-2.png",
"url_4x": "https://static-cdn.jtvnw.net/image-4.png"
},
"default_image": {
"url_1x": "https://static-cdn.jtvnw.net/default-1.png",
"url_2x": "https://static-cdn.jtvnw.net/default-2.png",
"url_4x": "https://static-cdn.jtvnw.net/default-4.png"
}
}
}
channel.channel_points_custom_reward.update
The channel.channel_points_custom_reward.update subscription type sends a notification when a custom channel points reward has been updated for the specified channel.
Authorization
Must have channel:read:redemptions or channel:manage:redemptions scope.
Channel Points Custom Reward Update Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.channel_points_custom_reward.update. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive channel points custom reward update notifications for. You can optionally pass in a reward id to only receive notifications for a specific reward. |
transport |
transport | yes | Transport-specific parameters. |
Channel Points Custom Reward Update Webhook Example
{
"type": "channel.channel_points_custom_reward.update",
"version": "1",
"condition": {
"broadcaster_user_id": "1337",
"reward_id": "9001" // optional to only get notifications for a specific reward
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Points Custom Reward Update Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. Contains data about the custom reward updated on the broadcaster’s channel. |
Channel Points Custom Reward Update Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.channel_points_custom_reward.update",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "9001",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"is_enabled": true,
"is_paused": false,
"is_in_stock": true,
"title": "Cool Reward",
"cost": 100,
"prompt": "reward prompt",
"is_user_input_required": true,
"should_redemptions_skip_request_queue": false,
"cooldown_expires_at": "2019-11-16T10:11:12.123Z",
"redemptions_redeemed_current_stream": 123,
"max_per_stream": {
"is_enabled": true,
"value": 1000
},
"max_per_user_per_stream": {
"is_enabled": true,
"value": 1000
},
"global_cooldown": {
"is_enabled": true,
"seconds": 1000
},
"background_color": "#FA1ED2",
"image": {
"url_1x": "https://static-cdn.jtvnw.net/image-1.png",
"url_2x": "https://static-cdn.jtvnw.net/image-2.png",
"url_4x": "https://static-cdn.jtvnw.net/image-4.png"
},
"default_image": {
"url_1x": "https://static-cdn.jtvnw.net/default-1.png",
"url_2x": "https://static-cdn.jtvnw.net/default-2.png",
"url_4x": "https://static-cdn.jtvnw.net/default-4.png"
}
}
}
channel.channel_points_custom_reward.remove
The channel.channel_points_custom_reward.remove subscription type sends a notification when a custom channel points reward has been removed from the specified channel.
Authorization
Must have channel:read:redemptions or channel:manage:redemptions scope.
Channel Points Custom Reward Remove Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.channel_points_custom_reward.remove. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive channel points custom reward remove notifications for. You can optionally pass in a reward ID to only receive notifications for a specific reward. |
transport |
transport | yes | Transport-specific parameters. |
Channel Points Custom Reward Remove Webhook Example
{
"type": "channel.channel_points_custom_reward.remove",
"version": "1",
"condition": {
"broadcaster_user_id": "1337",
"reward_id": "9001" // optional to only get notifications for a specific reward
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Points Custom Reward Remove Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | The event information. Contains data about the custom reward removed from the broadcaster’s channel. |
Channel Points Custom Reward Remove Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.channel_points_custom_reward.remove",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337",
"reward_id": 12345
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "9001",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"is_enabled": true,
"is_paused": false,
"is_in_stock": true,
"title": "Cool Reward",
"cost": 100,
"prompt": "reward prompt",
"is_user_input_required": true,
"should_redemptions_skip_request_queue": false,
"cooldown_expires_at": "2019-11-16T10:11:12.123Z",
"redemptions_redeemed_current_stream": 123,
"max_per_stream": {
"is_enabled": true,
"value": 1000
},
"max_per_user_per_stream": {
"is_enabled": true,
"value": 1000
},
"global_cooldown": {
"is_enabled": true,
"seconds": 1000
},
"background_color": "#FA1ED2",
"image": {
"url_1x": "https://static-cdn.jtvnw.net/image-1.png",
"url_2x": "https://static-cdn.jtvnw.net/image-2.png",
"url_4x": "https://static-cdn.jtvnw.net/image-4.png"
},
"default_image": {
"url_1x": "https://static-cdn.jtvnw.net/default-1.png",
"url_2x": "https://static-cdn.jtvnw.net/default-2.png",
"url_4x": "https://static-cdn.jtvnw.net/default-4.png"
}
}
}
channel.channel_points_custom_reward_redemption.add
The channel.channel_points_custom_reward_redemption.add subscription type sends a notification when a viewer has redeemed a custom channel points reward on the specified channel.
Authorization
Must have channel:read:redemptions or channel:manage:redemptions scope.
Channel Points Custom Reward Redemption Add Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.channel_points_custom_reward_redemption.add. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive channel points custom reward redemption notifications for. You can optionally pass in a reward id to only receive notifications for a specific reward. |
transport |
transport | yes | Transport-specific parameters. |
Channel Points Custom Reward Redemption Add Webhook Example
{
"type": "channel.channel_points_custom_reward_redemption.add",
"version": "1",
"condition": {
"broadcaster_user_id": "1337",
"reward_id": "9001" // optional to only get notifications for a specific reward
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Points Custom Reward Redemption Add Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | The event information. Contains data about the redemption of the custom reward on the broadcaster’s channel. |
Channel Points Custom Reward Redemption Add Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.channel_points_custom_reward_redemption.add",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1234",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"user_id": "9001",
"user_login": "cooler_user",
"user_name": "Cooler_User",
"user_input": "pogchamp",
"status": "unfulfilled",
"reward": {
"id": "9001",
"title": "title",
"cost": 100,
"prompt": "reward prompt"
},
"redeemed_at": "2020-07-15T17:16:03.17106713Z"
}
}
channel.channel_points_custom_reward_redemption.update
The channel.channel_points_custom_reward_redemption.update subscription type sends a notification when a redemption of a channel points custom reward has been updated for the specified channel.
Authorization
Must have channel:read:redemptions or channel:manage:redemptions scope.
Channel Points Custom Reward Redemption Update Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.channel_points_custom_reward_redemption.update. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive channel points custom reward redemption update notifications for. You can optionally pass in a reward id to only receive notifications for a specific reward. |
transport |
transport | yes | Transport-specific parameters. |
Channel Points Custom Reward Redemption Update Webhook Example
{
"type": "channel.channel_points_custom_reward_redemption.update",
"version": "1",
"condition": {
"broadcaster_user_id": "1337",
"reward_id": "9001" // optional to only get notifications for a specific reward
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Points Custom Reward Redemption Update Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | The event information. Contains data about the custom reward redemption update from the broadcaster’s channel. |
Channel Points Custom Reward Redemption Update Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.channel_points_custom_reward_redemption.update",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1234",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"user_id": "9001",
"user_login": "cooler_user",
"user_name": "Cooler_User",
"user_input": "pogchamp",
"status": "fulfilled", // Either fulfilled or cancelled
"reward": {
"id": "9001",
"title": "title",
"cost": 100,
"prompt": "reward prompt"
},
"redeemed_at": "2020-07-15T17:16:03.17106713Z"
}
}
channel.poll.begin
The channel.poll.begin subscription type sends a notification when a poll begins on the specified channel.
Authorization
Must have channel:read:polls or channel:manage:polls scope.
Channel Poll Begin Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.poll.begin. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive poll begin notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Poll Begin Example
{
"type": "channel.poll.begin",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Poll Begin Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. |
Channel Poll Begin Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.poll.begin",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1243456",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"title": "Aren’t shoes just really hard socks?",
"choices": [
{"id": "123", "title": "Yeah!"},
{"id": "124", "title": "No!"},
{"id": "125", "title": "Maybe!"}
],
"bits_voting": {
"is_enabled": true,
"amount_per_vote": 10
},
"channel_points_voting": {
"is_enabled": true,
"amount_per_vote": 10
},
"started_at": "2020-07-15T17:16:03.17106713Z",
"ends_at": "2020-07-15T17:16:08.17106713Z"
}
}
channel.poll.progress
The channel.poll.progress subscription type sends a notification when users respond to a poll on the specified channel.
Authorization
Must have channel:read:polls or channel:manage:polls scope.
Channel Poll Progress Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.poll.progress. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive poll progress notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Poll Progress Example
{
"type": "channel.poll.progress",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Poll Progress Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. |
Channel Poll Progress Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.poll.progress",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1243456",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"title": "Aren’t shoes just really hard socks?",
"choices": [
{"id": "123", "title": "Yeah!", "bits_votes": 5, "channel_points_votes": 7, "votes": 12},
{"id": "124", "title": "No!", "bits_votes": 10, "channel_points_votes": 4, "votes": 14},
{"id": "125", "title": "Maybe!", "bits_votes": 0, "channel_points_votes": 7, "votes": 7}
],
"bits_voting": {
"is_enabled": true,
"amount_per_vote": 10
},
"channel_points_voting": {
"is_enabled": true,
"amount_per_vote": 10
},
"started_at": "2020-07-15T17:16:03.17106713Z",
"ends_at": "2020-07-15T17:16:08.17106713Z"
}
}
channel.poll.end
The channel.poll.end subscription type sends a notification when a poll ends on the specified channel.
Authorization
Must have channel:read:polls or channel:manage:polls scope.
Channel Poll End Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.poll.end. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive poll end notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Poll End Example
{
"type": "channel.poll.end",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Poll End Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. |
Channel Poll End Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.poll.end",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1243456",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"title": "Aren’t shoes just really hard socks?",
"choices": [
{"id": "123", "title": "Blue", "bits_votes": 50, "channel_points_votes": 70, "votes": 120},
{"id": "124", "title": "Yellow", "bits_votes": 100, "channel_points_votes": 40, "votes": 140},
{"id": "125", "title": "Green", "bits_votes": 10, "channel_points_votes": 70, "votes": 80}
],
"bits_voting": {
"is_enabled": true,
"amount_per_vote": 10
},
"channel_points_voting": {
"is_enabled": true,
"amount_per_vote": 10
},
"status": "completed",
"started_at": "2020-07-15T17:16:03.17106713Z",
"ended_at": "2020-07-15T17:16:11.17106713Z"
}
}
channel.prediction.begin
The channel.prediction.begin subscription type sends a notification when a Prediction begins on the specified channel.
Authorization
Must have channel:read:predictions or channel:manage:predictions scope.
Channel Prediction Begin Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.prediction.begin. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive prediction begin notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Prediction Begin Example
{
"type": "channel.prediction.begin",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Prediction Begin Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. |
Channel Prediction Begin Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.prediction.begin",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1243456",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"title": "Aren’t shoes just really hard socks?",
"outcomes": [
{"id": "1243456", "title": "Yeah!", "color": "blue"},
{"id": "2243456", "title": "No!", "color": "pink"},
],
"started_at": "2020-07-15T17:16:03.17106713Z",
"locks_at": "2020-07-15T17:21:03.17106713Z"
}
}
channel.prediction.progress
The channel.prediction.progress subscription type sends a notification when users participate in a Prediction on the specified channel.
Authorization
Must have channel:read:predictions or channel:manage:predictions scope.
Channel Prediction Progress Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.prediction.progress. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive prediction progress notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Prediction Progress Example
{
"type": "channel.prediction.progress",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Prediction Progress Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. |
Channel Prediction Progress Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.prediction.progress",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1243456",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"title": "Aren’t shoes just really hard socks?",
"outcomes": [
{
"id": "1243456",
"title": "Yeah!",
"color": "blue",
"users": 10,
"channel_points": 15000,
"top_predictors": [ // contains up to 10 users
{
"user_name": "Cool_User",
"user_login": "cool_user",
"user_id": "1234",
"channel_points_won": null,
"channel_points_used": 500
},
{
"user_name": "Coolest_User",
"user_login": "coolest_user",
"user_id": "1236",
"channel_points_won": null,
"channel_points_used": 200
}
]
},
{
"id": "2243456",
"title": "No!",
"color": "pink",
"top_predictors": [ // contains up to 10 users
{
"user_name": "Cooler_User",
"user_login": "cooler_user",
"user_id": 12345,
"channel_points_won": null,
"channel_points_used": 5000
}
]
},
],
"started_at": "2020-07-15T17:16:03.17106713Z",
"locks_at": "2020-07-15T17:21:03.17106713Z"
}
}
channel.prediction.lock
The channel.prediction.lock subscription type sends a notification when a Prediction is locked on the specified channel.
Authorization
Must have channel:read:predictions or channel:manage:predictions scope.
Channel Prediction Lock Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.prediction.lock. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive prediction lock notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Prediction Lock Example
{
"type": "channel.prediction.lock",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Prediction Lock Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. |
Channel Prediction Lock Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.prediction.lock",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1243456",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"title": "Aren’t shoes just really hard socks?",
"outcomes": [
{
"id": "1243456",
"title": "Yeah!",
"color": "blue",
"users": 10,
"channel_points": 15000,
"top_predictors": [ // contains up to 10 users
{
"user_name": "Cool_User",
"user_login": "cool_user",
"user_id": "1234",
"channel_points_won": null,
"channel_points_used": 500
},
{
"user_name": "Coolest_User",
"user_login": "coolest_user",
"user_id": "1236",
"channel_points_won": null,
"channel_points_used": 200
}
]
},
{
"id": "2243456",
"title": "No!",
"color": "pink",
"top_predictors": [ // contains up to 10 users
{
"user_name": "Cooler_User",
"user_login": "cooler_user",
"user_id": 12345,
"channel_points_won": null,
"channel_points_used": 5000
}
]
},
],
"started_at": "2020-07-15T17:16:03.17106713Z",
"locked_at": "2020-07-15T17:21:03.17106713Z"
}
}
channel.prediction.end
The channel.prediction.end subscription type sends a notification when a Prediction ends on the specified channel.
Authorization
Must have channel:read:predictions or channel:manage:predictions scope.
Channel Prediction End Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.prediction.end. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to receive prediction lock notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Prediction End Example
{
"type": "channel.prediction.end",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Prediction End Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Metadata about the subscription. |
event |
event | The event information. |
Channel Prediction End Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.prediction.end",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1243456",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"title": "Aren’t shoes just really hard socks?",
"winning_outcome_id": "12345",
"outcomes": [
{
"id": "12345",
"title": "Yeah!",
"color": "blue", // can be blue or pink
"users": 2,
"channel_points": 15000,
"top_predictors": [ // contains up to 10 users
{
"user_name": "Cool_User",
"user_login": "cool_user",
"user_id": "1234",
"channel_points_won": 10000,
"channel_points_used": 500
},
{
"user_name": "Coolest_User",
"user_login": "coolest_user",
"user_id": "1236",
"channel_points_won": 5000,
"channel_points_used": 100
},
]
},
{
"id": "22435",
"title": "No!",
"users": 2,
"channel_points": 200,
"color": "pink",
"top_predictors": [
{
"user_name": "Cooler_User",
"user_login": "cooler_user",
"user_id": 12345,
"channel_points_won": null, // null if result is refund or loss
"channel_points_used": 100
},
{
"user_name": "Elite_User",
"user_login": "elite_user",
"user_id": 1337,
"channel_points_won": null, // null if result is refund or loss
"channel_points_used": 100
}
]
}
],
"status": "resolved", // valid values: resolved, canceled
"started_at": "2020-07-15T17:16:03.17106713Z",
"ended_at": "2020-07-15T17:16:11.17106713Z"
}
}
channel.hype_train.begin
The channel.hype_train.begin subscription type sends a notification when a Hype Train begins on the specified channel. In addition to a channel.hype_train.begin event, one channel.hype_train.progress event will be sent for each contribution that caused the Hype Train to begin. EventSub does not make strong assurances about the order of message delivery, so it is possible to receive channel.hype_train.progress notifications before you receive the corresponding channel.hype_train.begin notification.
After the Hype Train begins, any additional cheers or subscriptions on the channel will cause channel.hype_train.progress notifications to be sent. When the Hype Train is over, channel.hype_train.end is emitted.
Authorization
Must have channel:read:hype_train scope.
Channel Hype Train Begin Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.hype_train.begin. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to Hype Train begin notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Hype Train Begin Webhook Example
{
"type": "channel.hype_train.begin",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Hype Train Begin Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | Event information. Contains Hype Train information like the level, goal, top contributors, start time, and expiration time. |
Channel Hype Train Begin Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.hype_train.begin",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1b0AsbInCHZW2SQFQkCzqN07Ib2",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"total": 137,
"progress": 137,
"goal": 500,
"top_contributions": [
{ "user_id": "123", "user_login": "pogchamp", "user_name": "PogChamp", "type": "bits", "total": 50 },
{ "user_id": "456", "user_login": "kappa", "user_name": "Kappa", "type": "subscription", "total": 45 }
],
"last_contribution": { "user_id": "123", "user_login": "pogchamp", "user_name": "PogChamp", "type": "bits", "total": 50 },
"level": 2,
"started_at": "2020-07-15T17:16:03.17106713Z",
"expires_at": "2020-07-15T17:16:11.17106713Z"
}
}
channel.hype_train.progress
The channel.hype_train.progress subscription type sends a notification when a Hype Train makes progress on the specified channel. When a Hype Train starts, one channel.hype_train.progress event will be sent for each contribution that caused the Hype Train to begin (in addition to the channel.hype_train.begin event). EventSub does not make strong assurances about the order of message delivery, so it is possible to receive channel.hype_train.progress before you receive the corresponding channel.hype_train.begin.
After a Hype Train begins, any additional cheers or subscriptions on the channel will cause channel.hype_train.progress notifications to be sent. When the Hype Train is over, channel.hype_train.end is emitted.
Authorization
Must have channel:read:hype_train scope.
Channel Hype Train Progress Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.hype_train.progress. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to Hype Train progress notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Hype Train Progress Webhook Example
{
"type": "channel.hype_train.progress",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Hype Train Progress Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | Event information. Contains Hype Train information like the level, goal, top contributors, last contribution, start time, and expiration time. |
Channel Hype Train Progress Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.hype_train.progress",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1b0AsbInCHZW2SQFQkCzqN07Ib2",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"level": 2,
"total": 700,
"progress": 200,
"goal": 1000,
"top_contributions": [
{ "user_id": "123", "user_login": "pogchamp", "user_name": "PogChamp", "type": "bits", "total": 50 },
{ "user_id": "456", "user_login": "kappa", "user_name": "Kappa", "type": "subscription", "total": 45 }
],
"last_contribution": { "user_id": "123", "user_login": "pogchamp", "user_name": "PogChamp", "type": "bits", "total": 50 },
"started_at": "2020-07-15T17:16:03.17106713Z",
"expires_at": "2020-07-15T17:16:11.17106713Z"
}
}
channel.hype_train.end
The channel.hype_train.end subscription type sends a notification when a Hype Train ends on the specified channel.
Authorization
Must have channel:read:hype_train scope.
Channel Hype Train End Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.hype_train.end. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to Hype Train end notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Channel Hype Train End Webhook Example
{
"type": "channel.hype_train.end",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Channel Hype Train End Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | Event information. Contains Hype Train information like the level, top contributors, start time, end time, and cooldown end time. |
Channel Hype Train End Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.hype_train.end",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "1b0AsbInCHZW2SQFQkCzqN07Ib2",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"level": 2,
"total": 137,
"top_contributions": [
{ "user_id": "123", "user_login": "pogchamp", "user_name": "PogChamp", "type": "bits", "total": 50 },
{ "user_id": "456", "user_login": "kappa", "user_name": "Kappa", "type": "subscription", "total": 45 }
],
"started_at": "2020-07-15T17:16:03.17106713Z",
"ended_at": "2020-07-15T17:16:11.17106713Z",
"cooldown_ends_at": "2020-07-15T18:16:11.17106713Z"
}
}
channel.charity_campaign.donate
BETA Sends an event notification when a user donates to the broadcaster’s charity campaign.
The event data does not include information about the charity such as its name, description, and logo. To get information about the charity, use the Get Charity Campaign endpoint.
Authorization
Requires the channel:read:charity scope. See Create EventSub Subscription.
Request Body
The following table describes the JSON object that you pass in the body of your request when creating the EventSub subscription.
| Field | Type | Required? | Description |
|---|---|---|---|
| type | String | Yes | The event you want to receive notifications about. Must be set to channel.charity_campaign.donate. |
| version | String | Yes | The definition of the subscription request to use. Must be set to beta. |
| condition | Object | Yes | An object that contains subscription-specific parameters. |
| broadcaster_user_id | String | Yes | The ID of the broadcaster that you want to receive notifications about when users donate to their campaign. |
| transport | Object | Yes | An object that contains transport-specific parameters. |
| method | String | Yes | The transport method. Must be set to webhook. |
| callback | String | Yes | The URI of your event handler where notifications are sent. See Processing an event. |
| secret | String | Yes | The secret that you use to verify the event’s data. See Verifying the event message. |
Webhook Example
{
"type": "channel.charity_campaign.donate",
"version": "beta",
"condition": {
"broadcaster_user_id": "123456"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe78s9fg8"
}
}
Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | Event information. Contains information about a donation. |
Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "channel.charity_campaign.donate",
"version": "beta",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "123456"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2022-07-25T10:11:12.123Z"
},
"event": {
"campaign_id": "123-abc-456-def", // Field will show as `id` until 2022-09-20 at 1pm PDT
"broadcaster_id": "123456",
"broadcaster_name": "SunnySideUp",
"broadcaster_login": "sunnysideup",
"user_id": "654321",
"user_name": "GenerousUser1",
"user_login": "generoususer1",
"amount": {
"value": 10000,
"decimal_places": 2,
"currency": "USD"
}
}
}
drop.entitlement.grant
The drop.entitlement.grant subscription type sends a notification when an entitlement for a Drop is granted to a user.
Authorization
App access token required. The client ID associated with the access token must be owned by a user who is part of the specified organization.
Drop Entitlement Grant Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: drop.entitlement.grant. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the organization_id to subscribe to all drop entitlement grant notifications for that organization. |
transport |
transport | yes | Transport-specific parameters. |
is_batching_enabled |
string | yes | Needs to be true for this subscription type. |
Drop Entitlement Grant Webhook Example
{
"type": "drop.entitlement.grant",
"version": "1",
"condition": {
"organization_id": "9001",
"category_id": "9002", // optional to specify category/game
"campaign_id": "9003" // optional to specify campaign
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
},
"is_batching_enabled": true,
}
Drop Entitlement Grant Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
events |
event | Event information. Contains Drop entitlement information. |
Drop Entitlement Grant Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "drop.entitlement.grant",
"version": "1",
"status": "enabled",
"condition": {
"organization_id": "9001",
"category_id": "9002", // included if specified in subscription
"campaign_id": "9003" // included if specified in subscription
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"events": [
{
"id": "bf7c8577-e3e3-4881-a78a-e9446641d45d",
"data": {
"organization_id": "9001",
"category_id": "9002",
"category_name": "Fortnite",
"campaign_id": "9003",
"user_id": "1234",
"user_name": "Cool_User", // display name
"user_login": "cool_user",
"entitlement_id": "fb78259e-fb81-4d1b-8333-34a06ffc24c0",
"benefit_id": "74c52265-e214-48a6-91b9-23b6014e8041",
"created_at": "2019-01-28T04:17:53.325Z"
}
},
{
"id": "bf7c8577-e3e3-4881-a78a-e9446641d45c",
"data": {
"organization_id": "9001",
"category_id": "9002",
"category_name": "Fortnite",
"campaign_id": "9003",
"user_id": "12345",
"user_name": "Cooler_User", // display name
"user_login": "cooler_user",
"entitlement_id": "fb78259e-fb81-4d1b-8333-34a06ffc24c0",
"benefit_id": "74c52265-e214-48a6-91b9-23b6014e8041",
"created_at": "2019-01-28T04:17:53.325Z"
}
}
]
}
Note that the payload structure is different from other subscription types. Events bound for
drop.entitlement.grantsubscriptions are batched. Developers can expect to receive roughly 0-5 HTTP requests per second. HTTP request bodies will not exceed 250KB.
extension.bits_transaction.create
The extension.bits_transaction.create subscription type sends a notification when a new transaction is created for a Twitch Extension.
Authorization
The OAuth token client ID must match the Extension client ID.
Extension Bits Transaction Create Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: extension.bits_transaction.create. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the Extension client ID you want to receive Bits transaction notifications for. |
transport |
transport | yes | Transport-specific parameters. |
Extension Bits Transaction Create Webhook Example
{
"type": "extension.bits_transaction.create",
"version": "1",
"condition": {
"extension_client_id": "deadbeef"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Extension Bits Transaction Create Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | Event information. Contains Extension Bits transaction information. |
Extension Bits Transaction Create Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "extension.bits_transaction.create",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"extension_client_id": "deadbeef"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "bits-tx-id",
"extension_client_id": "deadbeef",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"user_name": "Coolest_User",
"user_login": "coolest_user",
"user_id": "1236",
"product": {
"name": "great_product",
"sku": "skuskusku",
"bits": 1234,
"in_development": false
}
}
}
Goal Subscriptions
channel.goal.begin
NEW Notifies the subscriber when the specified broadcaster begins a goal.
NOTE: It’s possible to receive the Begin event after receiving Progress events.
Authorization
Requires a user OAuth access token with scope set to channel:read:goals.
Goal Begin Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.goal.begin. |
version |
string | yes | The subscription type version: 1. |
condition |
Condition | yes | Set the Condition object’s broadcaster_user_id field to the ID of the broadcaster whose goals you want to get notified about. |
transport |
Transport | yes | Transport-specific parameters. |
Goal Begin Webhook Example
{
"type": "channel.goal.begin",
"version": "1",
"condition": {
"broadcaster_user_id": "141981764"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Goal Begin Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
Subscription | Identifies the event you subscribed to. |
event |
Event | Contains the event’s data (see Goals Event). |
Goal Begin Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"status": "enabled",
"type": "channel.goal.begin",
"version": "1",
"cost": 0,
"condition": {
"broadcaster_user_id": "141981764"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2021-07-15T10:11:12.123Z"
},
"event": {
"id": "12345-cool-event",
"broadcaster_user_id": "141981764",
"broadcaster_user_name": "TwitchDev",
"broadcaster_user_login": "twitchdev",
"type": "subscription",
"description": "Help me get partner!",
"current_amount": 100,
"target_amount": 220,
"started_at": "2021-07-15T17:16:03.17106713Z"
}
}
channel.goal.progress
NEW Notifies the subscriber when progress is made towards the specified broadcaster’s goal. Progress could be positive (added followers) or negative (lost followers).
NOTE: It’s possible to receive Progress events before receiving the Begin event.
Authorization
Requires a user OAuth access token with scope set to channel:read:goals.
Goal Progress Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.goal.progress. |
version |
string | yes | The subscription type version: 1. |
condition |
Condition | yes | Set the Condition object’s broadcaster_user_id field to the ID of the broadcaster whose goals you want to get notified about. |
transport |
Transport | yes | Transport-specific parameters. |
Goal Progress Webhook Example
{
"type": "channel.goal.progress",
"version": "1",
"condition": {
"broadcaster_user_id": "141981764"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Goal Progress Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
Subscription | Identifies the event you subscribed to. |
event |
Event | Contains the event’s data (see Goals Event). |
Goal Progress Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"status": "enabled",
"type": "channel.goal.progress",
"version": "1",
"cost": 0,
"condition": {
"broadcaster_user_id": "141981764"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2021-07-15T10:11:12.123Z"
},
"event": {
"id": "12345-cool-event",
"broadcaster_user_id": "141981764",
"broadcaster_user_name": "TwitchDev",
"broadcaster_user_login": "twitchdev",
"type": "subscription",
"description": "Help me get partner!",
"current_amount": 120,
"target_amount": 220,
"started_at": "2021-07-15T17:16:03.17106713Z"
}
}
channel.goal.end
NEW Notifies the subscriber when the specified broadcaster ends a goal.
Authorization
Requires a user OAuth access token with scope set to channel:read:goals.
Goal End Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: channel.goal.end. |
version |
string | yes | The subscription type version: 1. |
condition |
Condition | yes | Set the Condition object’s broadcaster_user_id field to the ID of the broadcaster whose goals you want to get notified about. |
transport |
Transport | yes | Transport-specific parameters. |
Goal End Webhook Example
{
"type": "channel.goal.end",
"version": "1",
"condition": {
"broadcaster_user_id": "141981764"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Goal End Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
Subscription | Identifies the event you subscribed to. |
event |
Event | Contains the event’s data (see Goals Event). |
Goal End Notification Example
Notice that the event object also includes the is_achieved and ended_at fields, which the begin and progress events don’t include.
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"status": "enabled",
"type": "channel.goal.end",
"version": "1",
"cost": 0,
"condition": {
"broadcaster_user_id": "141981764"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2021-07-15T10:11:12.123Z"
},
"event": {
"id": "12345-abc-678-defgh",
"broadcaster_user_id": "141981764",
"broadcaster_user_name": "TwitchDev",
"broadcaster_user_login": "twitchdev",
"type": "subscription",
"description": "Help me get partner!",
"is_achieved": false,
"current_amount": 180,
"target_amount": 220,
"started_at": "2021-07-15T17:16:03.17106713Z",
"ended_at": "2020-07-16T17:16:03.17106713Z"
}
}
Stream Subscriptions
stream.online
The stream.online subscription type sends a notification when the specified broadcaster starts a stream.
Authorization
No authorization required.
Stream Online Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: stream.online. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to get updates for. |
transport |
transport | yes | Transport-specific parameters. |
Stream Online Webhook Example
{
"type": "stream.online",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Stream Online Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | Event information. Contains the stream ID, broadcaster user ID, broadcaster user name, and the stream type. |
Stream Online Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "stream.online",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"id": "9001",
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User",
"type": "live",
"started_at": "2020-10-11T10:11:12.123Z"
}
}
stream.offline
The stream.offline subscription type sends a notification when the specified broadcaster stops a stream.
Authorization
No authorization required.
Stream Offline Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: stream.offline. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the broadcaster user ID for the channel you want to get updates for. |
transport |
transport | yes | Transport-specific parameters. |
Stream Offline Webhook Example
{
"type": "stream.offline",
"version": "1",
"condition": {
"broadcaster_user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
Stream Offline Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | Event information. Contains the broadcaster user ID and broadcaster user name. |
Stream Offline Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "stream.offline",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"broadcaster_user_id": "1337"
},
"created_at": "2019-11-16T10:11:12.123Z",
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
}
},
"event": {
"broadcaster_user_id": "1337",
"broadcaster_user_login": "cool_user",
"broadcaster_user_name": "Cool_User"
}
}
User Subscriptions
user.authorization.grant
The user.authorization.grant subscription type sends a notification when a user’s authorization has been granted to your client id.
Authorization
Provided client_id must match the client id in the application access token.
User Authorization Grant Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: user.authorization.grant. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the client ID of the application you want to get user authorization grant notifications for. |
transport |
transport | yes | Transport-specific parameters. |
User Authorization Grant Webhook Example
{
"type": "user.authorization.grant",
"version": "1",
"condition": {
"client_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
User Authorization Grant Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | Event information. Contains your application’s client ID and the user ID of the user who granted authorization to your application. |
User Authorization Grant Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "user.authorization.grant",
"version": "1",
"status": "enabled",
"cost": 1,
"condition": {
"client_id": "crq72vsaoijkc83xx42hz6i37"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"client_id": "crq72vsaoijkc83xx42hz6i37",
"user_id": "1337",
"user_login": "cool_user",
"user_name": "Cool_User"
}
}
user.authorization.revoke
The user.authorization.revoke subscription type sends a notification when a user’s authorization has been revoked for your client id. Use this webhook to meet government requirements for handling user data, such as GDPR, LGPD, or CCPA.
Authorization
Provided client_id must match the client id in the application access token.
User Authorization Revoke Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: user.authorization.revoke. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the client ID of the application you want to get user authorization revoke notifications for. |
transport |
transport | yes | Transport-specific parameters. |
User Authorization Revoke Webhook Example
{
"type": "user.authorization.revoke",
"version": "1",
"condition": {
"client_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
User Authorization Revoke Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | Event information. Contains your application’s client ID and the user ID of the user who revoked authorization for your application. |
User Authorization Revoke Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "user.authorization.revoke",
"version": "1",
"status": "enabled",
"cost": 1,
"condition": {
"client_id": "crq72vsaoijkc83xx42hz6i37"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"client_id": "crq72vsaoijkc83xx42hz6i37",
"user_id": "1337",
"user_login": "cool_user", // Null if the user no longer exists
"user_name": "Cool_User" // Null if the user no longer exists
}
}
user.update
The user.update subscription type sends a notification when user updates their account.
Authorization
No authorization required. If you have the user:read:email scope, the notification will include email field.
User Update Request Body
| Name | Type | Required? | Description |
|---|---|---|---|
type |
string | yes | The subscription type name: user.update. |
version |
string | yes | The subscription type version: 1. |
condition |
condition | yes | Subscription-specific parameters. Pass in the user ID for the user you want update notifications for. |
transport |
transport | yes | Transport-specific parameters. |
User Update Webhook Example
{
"type": "user.update",
"version": "1",
"condition": {
"user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback",
"secret": "s3cRe7"
}
}
User Update Notification Payload
| Name | Type | Description |
|---|---|---|
subscription |
subscription | Subscription information. |
event |
event | Event information. Contains the user ID, user name, and description. The event includes the user’s email address if the app used to request this event type includes the user:read:email scope for the user. See Create EventSub Subscription. |
User Update Notification Example
{
"subscription": {
"id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
"type": "user.update",
"version": "1",
"status": "enabled",
"cost": 0,
"condition": {
"user_id": "1337"
},
"transport": {
"method": "webhook",
"callback": "https://example.com/webhooks/callback"
},
"created_at": "2019-11-16T10:11:12.123Z"
},
"event": {
"user_id": "1337",
"user_login": "cool_user",
"user_name": "Cool_User",
"email": "user@email.com", // Requires user:read:email scope
"email_verified": true,
"description": "cool description"
}
}