Skip to main content
Private channels allow you to restrict app updates to specific users. This is useful for beta testing, early access programs, or paid tiers.

Overview

When a user requests an update from a private channel, your backend must:
  1. Verify the user has access to the requested channel
  2. Request an access token from the Overlayed API
  3. Return the token to the client
The client then uses this token to authenticate with the update server.

Client Setup

Configure the access token fetcher in your Electron main process:
Handle token invalidation to move users back to the public channel:

Server Implementation

Your server must call the Overlayed API to generate access tokens. The endpoint is:
Headers:
  • Authorization: Bearer {your_overlayed_api_key}
  • Content-Type: application/json
Body:
Response:

Security Considerations

  • Store your Overlayed API key securely. Never expose it to clients.
  • Validate user authentication before generating tokens.
  • Use short token expiration times (30-60 minutes recommended).
  • The audience field should be a unique identifier for the user. This is logged for analytics.