Overview

Build with Blaze

Use this overview as the control room for the developer docs: register an application, wire OAuth, choose scopes, call REST endpoints, then subscribe to real-time Events when polling is no longer enough.

Start with app setup Explore Events

Implementation flow

Follow the path your backend will actually take

The docs now read like an integration journey instead of a pile of links. Start with the application record, then move through credentials, data access, and live updates.

1Create the applicationRegister the client, define redirect URLs, and review generated credentials.2Connect OAuthBuild the authorization request, exchange the code, and keep secrets server-side.3Read and manage dataUse Channels, Users, Chat, Categories, and Moderation endpoints for stream state, profiles, followers, roles, activity, chat actions, taxonomy, and moderation actions.4Subscribe to live changesAttach Event subscriptions to a Socket.IO session and handle the incoming payloads.

Getting started

Set up the app before writing integration code

These pages cover the decisions that usually create integration drift: redirect URLs, credentials, token type, and the minimum scopes your app should request.

Console

Foundation

App Setup

Create a Blaze application, add redirect URLs, then open Manage to review the Client ID and generate a Client Secret.

Open guide

Tokens

Authentication

OAuth

Learn the user and app access token flows, how redirect_uri matching works, and where each credential belongs.

Open guide

Access

Permissions

Scopes

Choose the smallest permission set for your integration before calling APIs or creating subscriptions.

Open guide

REST surface

Use the platform endpoints with the right context

REST references are split by the objects developers work with most often, so channel, user, chat, category, and moderation behavior stays easy to scan.

Start

API Guide

Introduction

Learn the API request model: base URL, token context, scopes, resource families, endpoint cards, and when to move from REST to Events.

Read reference

/v1/channels

API Reference

Channels

Work with live stream state, channel stats, followers, roles, subscribers, activity feeds, and editable channel metadata.

Read reference

/v1/users

API Reference

Users

Fetch user profile data and user-centered relationships that power account, creator, and audience experiences.

Read reference

/v1/chats

API Reference

Chat

Send chat messages and delete chat messages for channel workflows that need direct REST actions.

Read reference

/v1/categories

API Reference

Moderation

Ban users, remove bans, and temporarily mute users in channels where the actor has moderation permission.

Read reference

Real-time surface

Move from polling to event-driven updates

Events documentation covers the Socket.IO lifecycle, subscription creation, payload contracts, and delivery limits.

Start

Events

Introduction

Understand the session_welcome message, sessionId, and the point where your client becomes ready to receive notifications.

Read reference

Attach

Events

Subscriptions

Create event subscriptions with a token, event type, version, condition, and Socket.IO sessionId.

Read reference

Payloads

Events

Event Types

Review event message structure and the payload fields your client should handle when activity arrives.

Read reference

Rules

Events

Limits

Check delivery expectations and boundaries before you design retries, reconnection, and subscription cleanup.

Read reference

Recommended next stop

If your app is already registered and authenticated, continue with Users to confirm the token context before adding deeper channel or event workflows.

Open Users