twitch-eventsub-framework

Installation

go get -u github.com/dnsge/twitch-eventsub-framework/v2

Go 1.21+ is required.

Quick Start

Use a Handler to listen for incoming notifications from Twitch servers.

// Create my handler with no secret key verification
handler := eventsub.NewHandler(nil)

// Process channel.update EventSub notifications
handler.HandleChannelUpdate = func(h bindings.NotificationHeaders, sub bindings.Subscription, event bindings.EventChannelUpdate) {
    fmt.Println("Got a channel.update notification!")
    fmt.Printf("Channel = %s, Title = %s\n", event.BroadcasterUserName, event.Title)
}

// Listen for HTTP requests from Twitch EventSub servers
http.ListenAndServe("127.0.0.1:8080", handler)

// Test it with the Twitch CLI!
// $ twitch event trigger channel.update -v 2 -F http://127.0.0.1:8080

Use a SubClient to subscribe to EventSub subscriptions.

// Create a client with a ClientID and App Token
client := eventsub.NewClient(eventsub.NewStaticCredentials(clientID, appToken))

// Subscribe to channel.update events for forsen
client.Subscribe(context.Background(), &eventsub.SubRequest{
    Type:    "channel.update", 
    Version: "2",
    Condition: bindings.ConditionChannelUpdate{
        BroadcasterUserID: "22484632",
    },
    Callback: "https://my.website/api/twitch/webhooks",
    Secret:   `my signing secret`,
})

Examples

1. See examples/sub_client/main.go for an example usage of creating a new webhook subscription.
2. See examples/sub_handler/main.go for an example usage of receiving webhook notifications from Twitch.

Migrating to v2

See MIGRATE_FROM_V1.md for details on the differences between v1 and v2.