twitchwebsub

1.0.3 • Public • Published

Twitch WebSub Webhooks

Sub on Twitch


Example

$ npm install
$ CLIENT_ID=YOUR_TWITCH_CLIENT_ID_HERE node examples/run.js

Install from npm

$ npm install twitchwebsub

Usage

Create a new TwitchWebSub server object

var TwitchWebSub = require("twitchwebsub");
var WebSub = TwitchWebSub.server(options);
 
// Listen on port 9001
WebSub.listen(9001);
Options
Key Type Description
callback string url that twitch will call to get to this program
client_id string Twitch API client id
secret string Optional - Default :: "I hate my life and don't care if people spoof requests from Twitch."

Events

Key Parameters Description
listen HTTP server is listening for connections.
error err We've run into a problem.
denied data Subscription request was denied by Twitch
subscribe data Successfully subscribed to a Topic
unsubscribe data Subscription was canceled by Twitch
feed data Twitch sent us information about a subscription

Functions

.listen(port) - Listen for http requests on a given port
.subscribe(topic) - Subscribe to a topic
.unsubscribe(topic) - Unsubscribe from a topic
.on(event, callback) - Listen for an event from twitch

Package Sidebar

Install

npm i twitchwebsub

Weekly Downloads

8

Version

1.0.3

License

MIT

Last publish

Collaborators

  • timothycole