Node-RED_Twitch_EventSub/README.md

Node-RED_Twitch_EventSub

Node-RED flow to subscribe, receive and respond to Twitch webhook

Note

• My Twitch channel
• To support me
• It is HIGHLY recommended to secure your Node-RED flow (your server will be exposed to the internet) !!
• EventSub doc
• This Flow is compatible with the Twitch API

Prerequisites

• Node-RED running on port 443 with HTTPS enabled OR a ngrok auth token

• Twitch APP Client ID

• Twitch APP Client Secret

Dependencies

• node-red-dashboard
• node-red-contrib-crypto-js-dynamic
• Optional : node-red-contrib-ngrok

For ngrok users

• Create a free account on ngrok
• Save your AuthToken
• Install the ngrok node on Node-RED
• Drag and drop a ngrok node on your flow
• Setup the node using your AuthToken
• Open a tunnel and save the URL

Twitch Setup

• Create an APP and save your APP ID and Secret
• Add the following URL using your domain name or ngrok tunnel URL

Note : As your Node-RED should be secured with http basic auth the URI are https://admin:password@xxxxxxxxx.eu.ngrok.io or https://admin:password@your.domain.name with "admin" and "password" corresponding to you Node-RED dashboard auth. It can be different from your Node-RED admin auth.

Node-RED Setup

API

• Import the flow
• Edit the API Settings node with your
  • Twitch client ID
  • Twitch client secret
  • Sub secret : a password (defined by the user) to validate the Twitch event signature
  • Twitch channel
  • Sub URI : your Node-RED server name or ngrok tunnel URL WITHOUT "HTTPS://" (Ex : your.domain.name or xxxxxxxxxxx.ngrok.io and admin:password@your.domain.name or admin:password@xxxxxxxxxxx.ngrok.io for a properly secured server)
  • Scopes (space-separated)

Recommended Scopes

bits:read channel:manage:broadcast channel:manage:polls channel:manage:predictions channel:manage:redemptions channel:read:polls channel:read:predictions channel:read:redemptions channel:read:subscriptions moderation:read user:read:follows user:read:subscriptions channel:moderate channel:read:hype_train

All scopes

analytics:read:extensions analytics:read:games bits:read channel:edit:commercial channel:manage:broadcast channel:manage:extensions channel:manage:polls channel:manage:predictions channel:manage:redemptions channel:manage:schedule channel:manage:videos channel:read:editors channel:read:goals channel:read:hype_train channel:read:polls channel:read:predictions channel:read:redemptions channel:read:stream_key channel:read:subscriptions clips:edit moderation:read moderator:manage:banned_users moderator:read:blocked_terms moderator:manage:blocked_terms moderator:manage:automod moderator:read:automod_settings moderator:manage:automod_settings moderator:read:chat_settings moderator:manage:chat_settings user:edit user:edit:follows user:manage:blocked_users user:read:blocked_users user:read:broadcast user:read:email user:read:follows user:read:subscriptions channel:moderate chat:edit chat:read whispers:read whispers:edit

Tokens

• Go to the Node-RED dashboard (https://your.domain.name/ui or https://xxxxxxxxxx.ngrok.io/ui)
• Generate an APP token and USER token by clicking on Auhtorize APP and Authorize USER (will requires to loggin with your Twitch account and accept the scopes)
• Optional : you can test the validity and expiration of the Token using "Validate" nodes on the Node-RED editor

Note : The Authorize App and Authorize User buttons will appear when the API options are submitted

Subscribe

• Type the channel username
• Subscribe to an event by selecting the desired Event on the Node-RED GUI
• Clic on "Subscribe"

Unsubscribe

• Refresh the subscriptions
• Select the channel
• Select the event you want to unsubscribe
• Clic on "Unsubscribe"

Events

If you subscribed to multiple channels you can separte the event by the broadcaster channel ID.

• When an event is posted to /webhook the JSON will be validated using the "Sub secret" code and sent to the second flow "Reponse"
• The "Inject" node and "Fake event" function can be removes as they are only used for Testing/Debug purposes
• Retrieve and use the events informations by connectig your node/function to the annotated functions

HAVE FUN