32 results found

1. Revise the `channel.subscription` topics

   Request

   Organize channel.subscription topics to allow for alert like notifications to properly be provided. What displays in chat should be able to be mimicked via EventSub topics without having active tracking or additional api calls; Provide missing data where needed; Create new topics to fill in the gaps.

   ---

   Current Scenarios

   Brand New Subscriber: If a user subscribes for the first time in the channel, we get an alert as soon as they sub. This is incidental that it works properly for stream based alerts, as we are actually receiving the payment transaction rather than the in chat event.

   Prime Gaming Resubscriber: If someone resubscribes with Prime Gaming, we get not only the channel.subscription.message when they decide to share the message in chat, but also the channel.subscribe event as they are technically a NEW subscriber when they first click the button to resubscribe. As it was explained to me, this is because the subscription lapses usually before they are able to share the renew event in chat. So we get the event for subscription start, as well as the message event when they do decide to share it. Without active tracking up to days before the event looking for channel.subscription.end there is no way to properly react to the subscription alerts in a stateless manner.

   User Gifts a Sub: We receive a channel.subscription.gift event which is expected, but have no way to link to who gave which sub nor which channel.subscription.gift event was its pair. Explained more thoroughly here: https://twitch.uservoice.com/forums/310213-developers/suggestions/43813413-provide-a-gift-event-id-in-the-channel-subscribe

   User updates/upgrades their subscription: Currently in the case of PubSub no notification is sent for someone continuing their subscription from a gift or at times changing their tier to higher/lower. Data inconclusive of what happens in EventSub. https://twitch.uservoice.com/forums/310213-developers/suggestions/42454273-subscriber-upgrades

   User resubscribes automatically, but never shares: It is perfectly fine for a user to not share their resubscription event in chat as often times it is automatic when they do renew; however, for metrics such as goals or otherwise this data is crucial for accurate tracking. Explained more by Barry: https://twitch.uservoice.com/forums/310213-developers/suggestions/42008110-please-provide-an-event-sub-that-emits-resub-paym

   ---

   Important Notes

   The events should be "stateless", meaning that active tracking of subs that expire should not be needed to ensure correct event usage. Otherwise, this requires a server like runtime which defeats the future "transport agnostic" approach and would require a server. Chat like notifications should be able to be built from eventsub without long term tracking, or other API calls; such as listening for subs, cheers, point redeems etc. Out of this list of proposals below, the only events that are intended to be used in an alert/stateless like environment are channel.subscription.message, channel.subscription.gift, and channel.subscription.update. While the others can be used, the data would not be as transparent as to where it came from as it isn't provided in chat which may confuse viewers if used in that fashion.

   ---

   Proposal

   channel.subscribe Changes

   • channel.subscribe would become channel.subscription.begin (or.start) to fall inline with other EventSub topics as well as to give a more granular expression of what it reacts to.
   • Subscriptions starting up, that either are new or have lapsed in the channel, would be signaled here. In theory this would present no change to the current implementation, but should be documented that this should be used for metrics rather than alerts.
   • duration_months for multi month subs could be useful here to determine if a "long" term sub ended.
   • Gifter info to provide better metric data (more than just is_gift), would allow better understanding of retention.

   channel.subscription.message Changes

   • channel.subscription.message provide a mimicked data stream of what would appear in chat, meaning re-subscriptions or new subscriptions. The documentation would be also need to be changed to reflect this.
   • New Subscriptions
     • A "default" message object would be provided, meaning that the message.text would be an empty string (not null) and the message.emote array would be an Array.empty
     • cumulative_months as well as streak_months would be 0.
   • Gifting info would also be needed
     • is_gift:boolean - Indicates if the subscription was a gift. Default: false
     • is_anonmyous:boolean - Indicates if the gifter was anonymous. Default: false
     • gifter_user_id:string - User id of the gifter. Default: string.empty
     • gifter_user_login:string - User login of the gifter. Default: string.empty
     • gifter_user_name:string - User name of the gifter. Default: string.empty
     • gift_subscription_id:string/Guid - Id associated with the channel.subscription.gift event. Default: string.empty

   channel.subcription.end | Changes

   • channel.subscription.end is for expiring subscriptions. This in theory should provide no change per se in use, but data such as what was documented in the "channel.subscription.begin changes" would be beneficial here as well.

   channel.subscription.gift | Changes

   • When referencing the change mentioned earlier providing the gift info, there was mention of a gift_subscription_id. This id would either be the event id or a new field in the channel.subscription.gift event called gift_id. Ideally a new field should not be needed as the id should be the event itself, but it depends on the infrastructure packing this together. Also explained in https://twitch.uservoice.com/forums/310213-developers/suggestions/43813413-provide-a-gift-event-id-in-the-channel-subscribe

   channel.subscription.update | New Topic

   • New topic for subscription changes such as tiers or gift continuations who don't drop from a previous tenure. https://twitch.uservoice.com/forums/310213-developers/suggestions/42454273-subscriber-upgrades
     

   channel.subscription.progress | New Topic

   • New topic for subscription tenure metrics. This is mentioned in Barry's User Voice (link provided) which would be useful for metrics along side channel.subscription.begin and channel.subscription.end for users who don't share their resub in chat. https://twitch.uservoice.com/forums/310213-developers/suggestions/42008110-please-provide-an-event-sub-that-emits-resub-paym

   channel.subscription.{all}

   • Transaction method to allow understanding how a sub was acquired and react appropriately. In the past Prime was utilized as a tier of sub in places such as PubSub, but this has been pointed out to not necessarily be the case. is_prime is too rigid and ignores other acquisitions such as iOS tokens. Instead a data point of transcation_type may be more idealistic. https://twitch.uservoice.com/forums/310213-developers/suggestions/42012043-add-is-prime-to-subscription-events

   ---

   Relevant User Voice Topics

   • https://twitch.uservoice.com/forums/310213-developers/suggestions/43813413-provide-a-gift-event-id-in-the-channel-subscribe
   • https://twitch.uservoice.com/forums/310213-developers/suggestions/43241439-channel-subscriptions-to-include-who-gave-the-gift
   • https://twitch.uservoice.com/forums/310213-developers/suggestions/42454273-subscriber-upgrades
   • https://twitch.uservoice.com/forums/310213-developers/suggestions/42008110-please-provide-an-event-sub-that-emits-resub-paym
   • https://twitch.uservoice.com/forums/310213-developers/suggestions/42012043-add-is-prime-to-subscription-events

   Request

   Organize channel.subscription topics to allow for alert like notifications to properly be provided. What displays in chat should be able to be mimicked via EventSub topics without having active tracking or additional api calls; Provide missing data where needed; Create new topics to fill in the gaps.

   ---

   Current Scenarios

   Brand New Subscriber: If a user subscribes for the first time in the channel, we get an alert as soon as they sub. This is incidental that it works properly for stream based alerts, as we are actually receiving the payment transaction rather than the in chat event.

   Prime Gaming… more

   116 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   2 comments  ·  EventSub  ·  Delete…  ·  Admin →
   Completed  ·  AdminMarc Szanto (Admin, Twitch) responded

   Some of these features were added in the channel.chat.notification EventSub event. All others are not planned at this time.

2. Please provide an event sub that emits "resub payments"

   Subscribe topic only broadcasts "new subscriptions"

   So when a subscription "expires" we don't get a "payment notification" for a Resub

   This is NOT a eventsub for the "chat notification" see https://twitch.uservoice.com/forums/310213-developers/suggestions/42008104-please-provide-an-event-sub-that-emits-sub-notifi for that

   90 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   14 comments  ·  EventSub  ·  Delete…  ·  Admin →
   Completed  ·  AdminMarc Szanto (Admin, Twitch) responded

   This feature was introduced in the channel.chat.notification EventSub event, which allows you to see "resub" notifications.

3. channel subscriptions to include who gave the gift if it's a gift

   Extend EventSub subscriptions topic to include information about who gave the gift if it was a gift subscription.

   71 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   7 comments  ·  EventSub  ·  Delete…  ·  Admin →
   Completed  ·  AdminMarc Szanto (Admin, Twitch) responded

   This feature was introduced in the channel.chat.notification EventSub event

4. Please provide an eventsub around advert/commercial informationm

   A number of streamers have re signed with Twitch with new Contracts.
   Those new contracts often include a requirement to run adverts

   A request for tooling general occurs from the Streamer to a developer for tools relating to running commericals

   Please provide eventsub topics that provide the following information

   • An advert started, including
     • which user/editor started those ads
     • duration of those ads
     • did it do picture in picture or full screen (if possible and if it's the same for everyone whom saw an ad)
     • how long prerolls are disabled for
   • An advert completed it's duration
   • Adverts are cleared to run again (theres no status endpoint to get this information, see other UV's)

   A number of streamers have re signed with Twitch with new Contracts.
   Those new contracts often include a requirement to run adverts

   A request for tooling general occurs from the Streamer to a developer for tools relating to running commericals

   Please provide eventsub topics that provide the following information

   • An advert started, including
     • which user/editor started those ads
     • duration of those ads
     • did it do picture in picture or full screen (if possible and if it's the same for everyone whom saw an ad)
     • how long prerolls are disabled for
   • An advert completed it's duration
   • Adverts are cleared to run… more
   46 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   3 comments  ·  EventSub  ·  Delete…  ·  Admin →
   Completed  ·  AdminMarc Szanto (Admin, Twitch) responded

   These requested features were added between the channel.ad_break.begin EventSub event, and the Get Ad Schedule API.

5. Provide an eventsub for when a Shoutout occurs

   Please provide a topic for shoutouts occuring on a channel.

   This allows bots and/or overlays to provide additional/supplementry messaging

   43 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   2 comments  ·  EventSub  ·  Delete…  ·  Admin →
   Completed  ·  AdminEric Cressey (Admin, Twitch) responded

   We released two new subscription types in open beta this week for when a channel gives or receives a shoutout. 

6. Please provide an event sub that emits "sub notifications"

   Please provide an eventsub notification topic for sub notifications

   Which would be a "clone" of messages appearing in chat for sub/resub notifications

   For resubs the chat message and emote placement would be included

   41 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   6 comments  ·  EventSub  ·  Delete…  ·  Admin →
   Completed  ·  AdminJon Bulava (Developer Relations, Twitch) responded

   Messages for new subscriptions and resubscriptions are available via the “Channel Subscribe” and “Channel Subscription Message” EventSub subscription types. https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channel-subscriptions

7. On EventSub create if 409 return ID of the conflicting Subscription

   Extend

   {
   "error": "Conflict",
   "status": 409,
   "message": "subscription already exists"
   }

   to

   {
   "error": "Conflict",
   "status": 409,
   "message": "subscription already exists",
   "id": "id of the eventsub subscription that conflicts"
   }

   36 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   6 comments  ·  EventSub  ·  Delete…  ·  Admin →
   Completed  ·  AdminJon Bulava (Developer Relations, Twitch) responded

   The ID of the conflicting subscription is now included in the error response. Documentation will be updated to explicitly mention this addition for error handling.

8. Please provide EventSub for Charity donations

   https://blog.twitch.tv/en/2022/07/19/twitch-charity-making-charity-streams-easier-and-more-charitable/

   Please provide an EventSub topic for Donations

   Primarily for creating our own overlays and/or piping it into our exsiting systems that already are tied into existing donation/charity systems

   30 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   0 comments  ·  EventSub  ·  Delete…  ·  Admin →
   Completed  ·  AdminEric Cressey (Admin, Twitch) responded

   The Charity Donate subscription type is in open beta now. We may add more Charity subscription types in the future.

9. Please provide an eventsub that emits unsubscribe/subscription end events

   Using event sub it should be possible to ONLY use event sub to maintain a list of people subscribed to a channel. (after an initial paint from Helix)

   Using the current topics it's not possible to do that.

   I currently have to fetch once using helix, then use eventsub to get new subs.
   Then fetch again later using helix to account for unsubs.

   26 votes

   Vote Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   2 comments  ·  EventSub  ·  Delete…  ·  Admin →
   Completed  ·  AdminJon Bulava (Developer Relations, Twitch) responded

   “Channel Subscription End” has been added to EventSub. https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelsubscriptionend

10. Add Stream ID to stream.offline

    Premise: stream.online encodes an id of the stream. stream.offline does not have such an id. Being able to pair this specific id with an online and offline state would be beneficial.

    Objective: Add the matching id to stream.offline that pairs with stream.online

    Notes: While it could be argued that a single broadcaster can only be live with a single id, it is still data oriented wise, more beneficial to have a symmetrical up and down payload, allowing quick queries on a state of a stream. Imagine a scenario where an online and offline event fire roughly at the same time. This creates a race condition that should not happen, but in theory still could at the current state.

    Premise: stream.online encodes an id of the stream. stream.offline does not have such an id. Being able to pair this specific id with an online and offline state would be beneficial.

    Objective: Add the matching id to stream.offline that pairs with stream.online

    Notes: While it could be argued that a single broadcaster can only be live with a single id, it is still data oriented wise, more beneficial to have a symmetrical up and down payload, allowing quick queries on a state of a stream. Imagine a scenario where an online and offline event fire roughly at the same time.… more

    25 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    1 comment  ·  EventSub  ·  Delete…  ·  Admin →
    Completed  ·  AdminMarc Szanto (Admin, Twitch) responded

    The id parameter is now available in stream.offline, representing the stream ID

11. Add Broadcaster ID query option to GET https://api.twitch.tv/helix/eventsub/subscriptions

    Add Broadcaster ID query option to GET https://api.twitch.tv/helix/eventsub/subscriptions so you can query on just broadcaster ID, so I can make sure all their subs are setup, instead of having to paginate through all my subs to check just a handful

    23 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    0 comments  ·  EventSub  ·  Delete…  ·  Admin →
    Completed  ·  AdminEric Cressey (Admin, Twitch) responded

    Get EventSub Subscriptions now takes an optional user_id parameter.

12. Add channels.raid Webhook Type

    Trigger: Triggers whenever a broadcaster hosts on a broadcaster's channel.

    Motivation: We get this information from the IRC. Such an event in the EventSub would save us an continuous IRC connection in the chat. Therefore we only need to rely on webhooks.

    16 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    5 comments  ·  EventSub  ·  Delete…  ·  Admin →
    Completed  ·  AdminJon Bulava (Developer Relations, Twitch) responded

    Channel Raid is now available. See the EventSub subscriptions page for more information: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types

13. Predictions in eventsub

    Please add Prediction start/progress/end events to eventsub

    14 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    1 comment  ·  EventSub  ·  Delete…  ·  Admin →
    Completed  ·  AdminJon Bulava (Developer Relations, Twitch) responded

    https://discuss.dev.twitch.tv/t/announcing-apis-and-eventsub-for-polls-and-predictions/31539

14. Add a channels.adverts topic for advert running

    Twitch requires streamers to run more ads

    We are building tools to help facilitate this

    There is noting in the API to let us know when ads run

    Please provide a topic for adverts running

    14 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    2 comments  ·  EventSub  ·  Delete…  ·  Admin →
    Completed  ·  AdminMarc Szanto (Admin, Twitch) responded

    This feature is now available using the channel.ad_break.begin EventSub event.

15. Provide Hype Train Begin level

    This is more of a uncertainty of necessity, as the hype train documentation is still fairly new to me. As a broadcaster there have been scenarios where a level 5 hype train was the starting level.

    Providing the level at the start could alleviate some confusion for progress and end as well as provide some consistency for the other two event types.

    Reasoning:
    The hype train on the end user side could start at a completed level 5. Depending on when the event is actually sent, this could provide odd results.

    Related events:
    - channel.hype_train.begin
    - channel.hype_train.progress
    - channel.hype_train.end

    11 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  0 comments  ·  EventSub  ·  Delete…  ·  Admin →

16. Add Display names to live reactionary chat data

    Any topic, that deals with reactionary events from chat such as cheers or subscriptions (new/resub/etc.) it would be beneficial to have a display name for all parties involved, the user who subbed, cheered, but also gifted, and broadcaster.

    Reasoning:
    - Various names have a certain capitalization that identifies that user. Without that there are cases that make the name very difficult to decipher for the viewer if the name appears on screen, due to all the letters being lower case or upper case.
    - If the name was already displayed in chat, then this data should also propagate to the event for consistency.

    Related events:
    - channel.follow
    - channel.subscribe
    - channel.cheer
    - channel.hype_train.begin
    - channel.hype_train.progress
    - channel.hype_train.end

    Any topic, that deals with reactionary events from chat such as cheers or subscriptions (new/resub/etc.) it would be beneficial to have a display name for all parties involved, the user who subbed, cheered, but also gifted, and broadcaster.

    Reasoning:
    - Various names have a certain capitalization that identifies that user. Without that there are cases that make the name very difficult to decipher for the viewer if the name appears on screen, due to all the letters being lower case or upper case.
    - If the name was already displayed in chat, then this data should also propagate to the… more

    10 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  2 comments  ·  EventSub  ·  Delete…  ·  Admin →

17. Bans: who did the action

    Hydrate the bans topic to include the user_id, login of the user that performed the ban action

    So add

    moderator_user_id
moderator_user_login
moderator_user_name

    to the event

    9 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  2 comments  ·  EventSub  ·  Delete…  ·  Admin →

18. Add a type filter to the status endpoint

    It would be nice if you could filter the response of the subscription status endpoint with a type filter.

    E.g. you want to only list subscriptions of the type "channels.update" so you would add an optional query param of "?type=channels.update" or something like that.

    This greatly improves the capability to only check the status of a subscription type you care of at that time instead of having to paginate through 20,30.40 or more pages of subscriptions.

    8 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  2 comments  ·  EventSub  ·  Delete…  ·  Admin →

19. EventSub for announcements

    Please provide a topic for when an announcement occurs on a channel.

    This could be for showing them in overlays as well, or for third party chat applications to display the announcement

    6 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  0 comments  ·  EventSub  ·  Delete…  ·  Admin →

20. Add a Hypetrain ID

    Premise: Currently there is no way to identify a hype train from start to finish fully. Adding an id (Guid) would help alleviate tracking the train as it progresses as well as after it has finished.

    Expected: hypetrain_id be added to the begin, progress, and end payloads. Given a particular hypetrain, these events would have the same Id per hype train.

    Usecase: Being able to cache and query a hypetrain via id to infer if the train is still continuing. Using time, winds up as an oddity due to the elongation of time behavior when the goal is reached. This would also allow queries by id of how well a particular train did.

    Premise: Currently there is no way to identify a hype train from start to finish fully. Adding an id (Guid) would help alleviate tracking the train as it progresses as well as after it has finished.

    Expected: hypetrain_id be added to the begin, progress, and end payloads. Given a particular hypetrain, these events would have the same Id per hype train.

    Usecase: Being able to cache and query a hypetrain via id to infer if the train is still continuing. Using time, winds up as an oddity due to the elongation of time behavior when the goal is reached. This… more

    6 votes

    Vote Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    1 comment  ·  EventSub  ·  Delete…  ·  Admin →
    Completed  ·  AdminEric Cressey (Admin, Twitch) responded

    The Hype Train Begin, Progress, and End payloads include an id field.