Documentation Index
Fetch the complete documentation index at: https://docs.kavachos.com/llms.txt
Use this file to discover all available pages before exploring further.
Get credentials
Register an application
Go to the Twitch Developer Console and click Register Your Application. Set the OAuth Redirect URL to:Copy credentials
After saving, click Manage on the app. Copy the Client ID. Click New Secret to generate and copy the Client Secret.Configuration
lib/kavach.ts
Endpoints
| Endpoint | URL |
|---|---|
| Authorization | https://id.twitch.tv/oauth2/authorize |
| Token | https://id.twitch.tv/oauth2/token |
| User info | https://api.twitch.tv/helix/users |
Scopes
Default scope:user:read:email
| Scope | What it unlocks |
|---|---|
user:read:email | Read the user’s verified email address |
user:read:follows | Read the channels the user follows |
channel:read:subscriptions | Read the user’s channel subscriptions |
User data returned
| Field | Source | Notes |
|---|---|---|
id | data[0].id | Stable numeric Twitch user ID |
email | data[0].email | Only present with user:read:email scope |
name | data[0].display_name | Localized display name (may differ from login) |
avatar | data[0].profile_image_url | Direct CDN URL; changes when user updates profile |
The Twitch Helix API requires a
Client-ID header on every request alongside the Bearer token. KavachOS handles this automatically, you do not need to set it manually.Related
OAuth overview
Generic OAuth configuration and custom provider setup.
Another popular social provider with verified email addresses.
GitHub
Developer-focused OAuth provider with org membership scopes.
Social provider in the same nav group.