Name: KavachOS
Author: KavachOS

Get credentials

Register an application

Go to the Twitch Developer Console and click Register Your Application. Set the OAuth Redirect URL to:

https://auth.example.com/auth/oauth/twitch/callback

Pick any category — Website Integration works for most apps.

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

import { createKavach } from 'kavachos';
import { oauth } from 'kavachos/plugins/oauth';

const kavach = await createKavach({
  database: { provider: 'postgres', url: process.env.DATABASE_URL! },
  secret: process.env.KAVACH_SECRET!,
  baseUrl: 'https://auth.example.com',
  plugins: [
    oauth({
      providers: [
        {
          id: 'twitch', 
          clientId: process.env.TWITCH_CLIENT_ID!, 
          clientSecret: process.env.TWITCH_CLIENT_SECRET!, 
        },
      ],
    }),
  ],
});

TWITCH_CLIENT_ID=abcdef1234567890abcdef1234567890
TWITCH_CLIENT_SECRET=...

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.

Twitch email addresses may not be verified. Check the broadcaster_type and account age in the raw response if you need higher assurance.

Twitch