Skip to content

Commit

Permalink
Adjust twitch integration configuration (home-assistant#11853)
Browse files Browse the repository at this point in the history
* Add oauth token doc

* Adjust to latest config changes

* ✏️ Tweaks

* Remove optional config from example

Co-authored-by: Franck Nijhof <[email protected]>
  • Loading branch information
Poeschl and frenck authored Feb 18, 2020
1 parent 3aac04b commit 2df149e
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions source/_integrations/twitch.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,22 @@ ha_iot_class: Cloud Polling

The `twitch` platform will allow you to monitor [Twitch](https://www.twitch.tv/) channel status from within Home Assistant and setup automation based on the information.

## Setup
## Setup Client ID

Create a new app at "Register Your Application" in the [Twitch developer portal](https://glass.twitch.tv/console/apps). Then get the **Client ID** for the new app.
Create a new app at "Register Your Application" in the [Twitch developer portal](https://glass.twitch.tv/console/apps). Then get the __Client ID__ for the new application.

## Setup OAuth Token

To enable the follow and subscription attributes, the OAuth token is needed to get the right permissions on the Twitch API.
If you don't need those, ignore the configuration setting: `token`.

To get the OAuth token, visit the [OAuth Token Generator](https://twitchapps.com/tokengen/#), insert your __Client ID__ and `user_read user_subscriptions` inside __scopes__.

Before clicking Summit (the broken image below the form), visit the [Twitch dev console](https://dev.twitch.tv/console) and add a new application.

As __OAuth Redirect URLs__ add `https://twitchapps.com/tokengen/` and click __Create__
.
Back at the Token Generator, click the __Summit__ button, accept the consent screen and get your __OAuth Token__.

## Configuration

Expand All @@ -33,6 +46,10 @@ client_id:
description: Your Twitch client ID.
required: true
type: string
token:
description: Your Twitch OAuth Token.
required: false
type: string
channels:
description: List of channels names
required: true
Expand Down

0 comments on commit 2df149e

Please sign in to comment.