update example from channel.follow to channel.chat.message + add .http file

AoshiW · AoshiW · commit cda93a8cc136 · 2025-08-31T08:20:20.000+02:00
diff --git a/README.md b/README.md
@@ -77,9 +77,10 @@ app.Run();
 Step 5: Create the HostedService and listen for events
 
 ```csharp
+using TwitchLib.EventSub.Core.EventArgs.Channel;
 using TwitchLib.EventSub.Webhooks.Core;
 using TwitchLib.EventSub.Webhooks.Core.EventArgs;
-using TwitchLib.EventSub.Webhooks.Core.EventArgs.Channel;
+using TwitchLib.EventSub.Webhooks.Core.Models;
 
 namespace TwitchLib.EventSub.Webhooks.Example
 {
@@ -97,26 +98,41 @@ namespace TwitchLib.EventSub.Webhooks.Example
         public Task StartAsync(CancellationToken cancellationToken)
         {
             _eventSubWebhooks.OnError += OnError;
-            _eventSubWebhooks.OnChannelFollow += OnChannelFollow;
+            _eventSubWebhooks.UnknownEventSubNotification += OnUnknownEventSubNotification;
+            _eventSubWebhooks.ChannelChatMessage += OnChannelChatMessage;
             return Task.CompletedTask;
         }
 
         public Task StopAsync(CancellationToken cancellationToken)
         {
             _eventSubWebhooks.OnError -= OnError;
-            _eventSubWebhooks.OnChannelFollow -= OnChannelFollow;
+            _eventSubWebhooks.UnknownEventSubNotification -= OnUnknownEventSubNotification;
+            _eventSubWebhooks.ChannelChatMessage -= OnChannelChatMessage;
             return Task.CompletedTask;
         }
 
-        private void OnChannelFollow(object? sender, ChannelFollowArgs e)
+        private async Task OnChannelChatMessage(object? sender, ChannelChatMessageArgs e)
         {
-            _logger.LogInformation($"{e.Notification.Event.UserName} followed {e.Notification.Event.BroadcasterUserName} at {e.Notification.Event.FollowedAt.ToUniversalTime()}");
+            _logger.LogInformation($"@{e.Payload.Event.ChatterUserName} #{e.Payload.Event.BroadcasterUserName}: {e.Payload.Event.Message.Text}");
         }
 
-        private void OnError(object? sender, OnErrorArgs e)
+        private async Task OnError(object? sender, OnErrorArgs e)
         {
             _logger.LogError($"Reason: {e.Reason} - Message: {e.Message}");
         }
+
+        // Handling notifications that are not (yet) implemented
+        private async Task OnUnknownEventSubNotification(object? sender, UnknownEventSubNotificationArgs e)
+        {
+            var metadata = (WebhookEventSubMetadata)e.Metadata;
+            _logger.LogInformation("Received event that has not yet been implemented: type:{type}, version:{version}", metadata.SubscriptionType, metadata.SubscriptionVersion);
+
+            switch ((metadata.SubscriptionType, metadata.SubscriptionVersion))
+            {
+                case ("channel.chat.message", "1"): /*code to handle the event*/ break;
+                default: break;
+            }
+        }
     }
 }
 ```
diff --git a/TwitchLib.EventSub.Webhooks.Example/EventSubHostedService.cs b/TwitchLib.EventSub.Webhooks.Example/EventSubHostedService.cs
@@ -1,6 +1,6 @@
-﻿using TwitchLib.EventSub.Webhooks.Core;
+﻿using TwitchLib.EventSub.Core.EventArgs.Channel;
+using TwitchLib.EventSub.Webhooks.Core;
 using TwitchLib.EventSub.Webhooks.Core.EventArgs;
-using TwitchLib.EventSub.Core.EventArgs.Channel;
 using TwitchLib.EventSub.Webhooks.Core.Models;
 
 namespace TwitchLib.EventSub.Webhooks.Example
@@ -20,21 +20,21 @@ public Task StartAsync(CancellationToken cancellationToken)
         {
             _eventSubWebhooks.Error += OnError;
             _eventSubWebhooks.UnknownEventSubNotification += OnUnknownEventSubNotification;
-            _eventSubWebhooks.ChannelFollow += OnChannelFollow;
+            _eventSubWebhooks.ChannelChatMessage += OnChannelChatMessage;
             return Task.CompletedTask;
         }
 
         public Task StopAsync(CancellationToken cancellationToken)
         {
             _eventSubWebhooks.Error -= OnError;
-            _eventSubWebhooks.UnknownEventSubNotification += OnUnknownEventSubNotification;
-            _eventSubWebhooks.ChannelFollow -= OnChannelFollow;
+            _eventSubWebhooks.UnknownEventSubNotification -= OnUnknownEventSubNotification;
+            _eventSubWebhooks.ChannelChatMessage -= OnChannelChatMessage;
             return Task.CompletedTask;
         }
 
-        private async Task OnChannelFollow(object? sender, ChannelFollowArgs e)
+        private async Task OnChannelChatMessage(object? sender, ChannelChatMessageArgs e)
         {
-            _logger.LogInformation($"{e.Payload.Event.UserName} followed {e.Payload.Event.BroadcasterUserName} at {e.Payload.Event.FollowedAt.ToUniversalTime()}");
+            _logger.LogInformation($"@{e.Payload.Event.ChatterUserName} #{e.Payload.Event.BroadcasterUserName}: {e.Payload.Event.Message.Text}");
         }
 
         private async Task OnError(object? sender, OnErrorArgs e)
@@ -43,7 +43,7 @@ private async Task OnError(object? sender, OnErrorArgs e)
         }
 
         // Handling notifications that are not (yet) implemented
-        private async Task OnUnknownEventSubNotification(object sender, UnknownEventSubNotificationArgs e)
+        private async Task OnUnknownEventSubNotification(object? sender, UnknownEventSubNotificationArgs e)
         {
             var metadata = (WebhookEventSubMetadata)e.Metadata;
             _logger.LogInformation("Received event that has not yet been implemented: type:{type}, version:{version}", metadata.SubscriptionType, metadata.SubscriptionVersion);
diff --git a/TwitchLib.EventSub.Webhooks.Example/TwitchAPI.http b/TwitchLib.EventSub.Webhooks.Example/TwitchAPI.http
@@ -0,0 +1,57 @@
+# For more info on HTTP files go to https://aka.ms/vs/httpfile
+
+# change values!!
+@callbackBase=_example_com_
+@clientId=_Client_Id_
+@token=_App_Access_Token_
+@broadcasterUserId=_Broadcaster_User_Id_
+@userId={{broadcasterUserId}}
+
+@secret=supersecuresecret
+@callbackPath=/eventsub/
+@callbackUrl={{callbackBase}}{{callbackPath}}
+
+# @name getSubscriptions
+GET https://api.twitch.tv/helix/eventsub/subscriptions
+Authorization: Bearer {{token}}
+Client-Id: {{clientId}}
+
+###
+
+DELETE https://api.twitch.tv/helix/eventsub/subscriptions?id={{getSubscriptions.response.body.$.data[0].id}}
+Authorization: Bearer {{token}}
+Client-Id: {{clientId}}
+
+###
+
+POST https://api.twitch.tv/helix/eventsub/subscriptions
+Authorization: Bearer {{token}}
+Client-Id: {{clientId}}
+Content-Type: application/json
+
+{
+  "type": "channel.chat.message",
+  "version": "1",
+  "condition": {
+    "broadcaster_user_id": "{{broadcasterUserId}}",
+    "user_id": "{{userId}}"
+  },
+  "transport": {
+    "method": "webhook",
+    "callback": "{{callbackUrl}}",
+    "secret": "{{secret}}"
+  }
+}
+
+###
+
+POST https://api.twitch.tv/helix/chat/messages
+Authorization: Bearer {{token}}
+Client-Id: {{clientId}}
+Content-Type: application/json
+
+{
+  "broadcaster_id" : "{{broadcasterUserId}}",
+  "sender_id" : "{{userId}}",
+  "message" : "Test message"
+}

Original file line number	Diff line number	Diff line change
`@@ -77,9 +77,10 @@ app.Run();`
`77`	`77`	`Step 5: Create the HostedService and listen for events`
`78`	`78`
`79`	`79`	```csharp
	`80`	`+using TwitchLib.EventSub.Core.EventArgs.Channel;`
`80`	`81`	`using TwitchLib.EventSub.Webhooks.Core;`
`81`	`82`	`using TwitchLib.EventSub.Webhooks.Core.EventArgs;`
`82`		`-using TwitchLib.EventSub.Webhooks.Core.EventArgs.Channel;`
	`83`	`+using TwitchLib.EventSub.Webhooks.Core.Models;`
`83`	`84`
`84`	`85`	`namespace TwitchLib.EventSub.Webhooks.Example`
`85`	`86`	`{`
`@@ -97,26 +98,41 @@ namespace TwitchLib.EventSub.Webhooks.Example`
`97`	`98`	`public Task StartAsync(CancellationToken cancellationToken)`
`98`	`99`	`{`
`99`	`100`	`_eventSubWebhooks.OnError += OnError;`
`100`		`- _eventSubWebhooks.OnChannelFollow += OnChannelFollow;`
	`101`	`+ _eventSubWebhooks.UnknownEventSubNotification += OnUnknownEventSubNotification;`
	`102`	`+ _eventSubWebhooks.ChannelChatMessage += OnChannelChatMessage;`
`101`	`103`	`return Task.CompletedTask;`
`102`	`104`	`}`
`103`	`105`
`104`	`106`	`public Task StopAsync(CancellationToken cancellationToken)`
`105`	`107`	`{`
`106`	`108`	`_eventSubWebhooks.OnError -= OnError;`
`107`		`- _eventSubWebhooks.OnChannelFollow -= OnChannelFollow;`
	`109`	`+ _eventSubWebhooks.UnknownEventSubNotification -= OnUnknownEventSubNotification;`
	`110`	`+ _eventSubWebhooks.ChannelChatMessage -= OnChannelChatMessage;`
`108`	`111`	`return Task.CompletedTask;`
`109`	`112`	`}`
`110`	`113`
`111`		`- private void OnChannelFollow(object? sender, ChannelFollowArgs e)`
	`114`	`+ private async Task OnChannelChatMessage(object? sender, ChannelChatMessageArgs e)`
`112`	`115`	`{`
`113`		`- _logger.LogInformation($"{e.Notification.Event.UserName} followed {e.Notification.Event.BroadcasterUserName} at {e.Notification.Event.FollowedAt.ToUniversalTime()}");`
	`116`	`+ _logger.LogInformation($"@{e.Payload.Event.ChatterUserName} #{e.Payload.Event.BroadcasterUserName}: {e.Payload.Event.Message.Text}");`
`114`	`117`	`}`
`115`	`118`
`116`		`- private void OnError(object? sender, OnErrorArgs e)`
	`119`	`+ private async Task OnError(object? sender, OnErrorArgs e)`
`117`	`120`	`{`
`118`	`121`	`_logger.LogError($"Reason: {e.Reason} - Message: {e.Message}");`
`119`	`122`	`}`
	`123`	`+`
	`124`	`+ // Handling notifications that are not (yet) implemented`
	`125`	`+ private async Task OnUnknownEventSubNotification(object? sender, UnknownEventSubNotificationArgs e)`
	`126`	`+ {`
	`127`	`+ var metadata = (WebhookEventSubMetadata)e.Metadata;`
	`128`	`+ _logger.LogInformation("Received event that has not yet been implemented: type:{type}, version:{version}", metadata.SubscriptionType, metadata.SubscriptionVersion);`
	`129`	`+`
	`130`	`+ switch ((metadata.SubscriptionType, metadata.SubscriptionVersion))`
	`131`	`+ {`
	`132`	`+ case ("channel.chat.message", "1"): /code to handle the event/ break;`
	`133`	`+ default: break;`
	`134`	`+ }`
	`135`	`+ }`
`120`	`136`	`}`
`121`	`137`	`}`
`122`	`138`	```
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`		`-using TwitchLib.EventSub.Webhooks.Core;`
	`1`	`+using TwitchLib.EventSub.Core.EventArgs.Channel;`
	`2`	`+using TwitchLib.EventSub.Webhooks.Core;`
`2`	`3`	`using TwitchLib.EventSub.Webhooks.Core.EventArgs;`
`3`		`-using TwitchLib.EventSub.Core.EventArgs.Channel;`
`4`	`4`	`using TwitchLib.EventSub.Webhooks.Core.Models;`
`5`	`5`
`6`	`6`	`namespace TwitchLib.EventSub.Webhooks.Example`
`@@ -20,21 +20,21 @@ public Task StartAsync(CancellationToken cancellationToken)`
`20`	`20`	`{`
`21`	`21`	`_eventSubWebhooks.Error += OnError;`
`22`	`22`	`_eventSubWebhooks.UnknownEventSubNotification += OnUnknownEventSubNotification;`
`23`		`- _eventSubWebhooks.ChannelFollow += OnChannelFollow;`
	`23`	`+ _eventSubWebhooks.ChannelChatMessage += OnChannelChatMessage;`
`24`	`24`	`return Task.CompletedTask;`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`public Task StopAsync(CancellationToken cancellationToken)`
`28`	`28`	`{`
`29`	`29`	`_eventSubWebhooks.Error -= OnError;`
`30`		`- _eventSubWebhooks.UnknownEventSubNotification += OnUnknownEventSubNotification;`
`31`		`- _eventSubWebhooks.ChannelFollow -= OnChannelFollow;`
	`30`	`+ _eventSubWebhooks.UnknownEventSubNotification -= OnUnknownEventSubNotification;`
	`31`	`+ _eventSubWebhooks.ChannelChatMessage -= OnChannelChatMessage;`
`32`	`32`	`return Task.CompletedTask;`
`33`	`33`	`}`
`34`	`34`
`35`		`- private async Task OnChannelFollow(object? sender, ChannelFollowArgs e)`
	`35`	`+ private async Task OnChannelChatMessage(object? sender, ChannelChatMessageArgs e)`
`36`	`36`	`{`
`37`		`- _logger.LogInformation($"{e.Payload.Event.UserName} followed {e.Payload.Event.BroadcasterUserName} at {e.Payload.Event.FollowedAt.ToUniversalTime()}");`
	`37`	`+ _logger.LogInformation($"@{e.Payload.Event.ChatterUserName} #{e.Payload.Event.BroadcasterUserName}: {e.Payload.Event.Message.Text}");`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`private async Task OnError(object? sender, OnErrorArgs e)`
`@@ -43,7 +43,7 @@ private async Task OnError(object? sender, OnErrorArgs e)`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`// Handling notifications that are not (yet) implemented`
`46`		`- private async Task OnUnknownEventSubNotification(object sender, UnknownEventSubNotificationArgs e)`
	`46`	`+ private async Task OnUnknownEventSubNotification(object? sender, UnknownEventSubNotificationArgs e)`
`47`	`47`	`{`
`48`	`48`	`var metadata = (WebhookEventSubMetadata)e.Metadata;`
`49`	`49`	`_logger.LogInformation("Received event that has not yet been implemented: type:{type}, version:{version}", metadata.SubscriptionType, metadata.SubscriptionVersion);`