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

If would be very useful for chat clients or chat overlays to be able to show live updates on these features. Currently they are only available for the broadcaster (redemptions) or not at all through websockets (polls/predictions).

Ideally this would be available for all users to receive, just like chat is (which allows more simple integration into all kinds of tools), but even just mods using third-party moderation tools would already benefit greatly from this.

I included all three of those features, since they all seem to follow the same idea of only allowing the broadcaster access to that information which is otherwise publicly available in chat. If you want me to separate the features into different posts I'd be happy to do it.

When viewers cheer, they use cheermotes and commonly emotes in their cheer messages. Unfortunately, the payload received from EventSub's channel.cheer callbacks only have the raw text as entered by the user, with no indiciation of which portions of that text are cheermotes nor emotes. Thus, I propose the following update to the callback payload, similar to the channel.subscription.message event, that passes along the data for both so that a consumer of EventSub can reconstruct the message:

{
    "subscription": {
        ...
    },
    "event": {
        ...
        "message": {
            "text": "Rah Rah Cheer! cheerwhal1 Cheer100 notACheer101 finite6ThrowBall",
            "cheermotes": [
                {
                    "begin": 16,
                    "end": 26,
                    "prefix": "cheerwhal"
                    "id": "1"
                },
                {
                    "begin": 27,
                    "end": 34,
                    "prefix": "Cheer"
                    "id": "100"
                }
            ],
            "emotes": [
                {
                    "begin": 48,
                    "end": 64,
                    "id": "emotesv2_4133039724974aa59589549eae677d03"
                }
            ]
        },
        ...
    }
}

Currently EventSub allows subscriptions for Subscriptions, Gifted Subscriptions, Raids, Follows, and Cheers - All things that streamers like getting alerts for and calling out. However, it appears to be missing the ability to subscribe to being Hosted, another even that streamers thank their viewers for.

I know that in theory, Hosts are handled by Notice messages, but as they are only sent to the broadcaster, chat bots are unable to act on the alerts. Obviously the data is available somewhere, since all the major bot services can trigger alerts, but for those of us that are trying to make our own custom bot, it would be great to have a consistent system for all alert types.