Guides
Task-shaped recipes. Each one assumes you have done the Quickstart and know your way around Sessions and tokens.
These guides are written so an LLM agent can lift them into a working integration with minor edits. Where a step is provider- or platform-specific, the variation is called out inline. Where a guide spans hundreds of lines because the topic deserves it, it gets its own page.
Migrate from another provider
Drop-in walkthroughs for teams replacing an existing identity stack. Each guide opens with a one-page mapping table and ends with a complete before/after file diff.
| Guide | When to read |
|---|---|
| From Auth0 | You’re on Universal Login + Rules / Actions and want to keep features without rewriting your authorization model. |
| From Clerk | You’re on <ClerkProvider> and want a brand-owned hosted UI without the “Powered by” footer. |
| From NextAuth / Auth.js | You’re on Auth.js v5 and want OIDC handled without managing Provider config in code. The fastest migration in the list. |
| From WorkOS | You’re using AuthKit + Connections and want the same enterprise surface (SAML, Directory Sync, audit log) with a simpler dashboard. |
See the migration hub for the mental-model translations that recur in every migration.
Tutorials
End-to-end build walkthroughs that take you from pnpm create to
a shipping app. Each tutorial is independent — you can pick up at
the step that matches your stack.
| Tutorial | What you build |
|---|---|
| Theme the sign-in UI | Four progressive levels of theming — preset name, token overrides, light/dark with system follow, slot-level classNames + provider icons. Works the same on @synqid/react, @synqid/nextjs, and @synqid/react-native. |
| Build a Solana mobile app | A complete Expo + Synq + Mobile Wallet Adapter app: branded sign-in, MWA wallet connect, sign-to-link against Synq, transaction signing, and a server-side webhook handler that reconciles linked wallets into your DB. ~90 minutes. |
Production
The three pages every team should read once before flipping DNS, once before a hire’s first Synq-touching PR, and once per quarter as a refresher.
| Guide | What it covers |
|---|---|
| Production checklist | Identity, tokens, webhooks, ops, resilience, compliance, performance, browser/mobile, final smoke test. The list to walk before flipping DNS. |
| Multi-environment setup | One Brand vs separate Brands per env, env-var layout, Vercel preview pattern, ngrok for local webhooks, failure modes to avoid. |
| Rotate everything (no downtime) | client_secret, BYO OAuth secrets, webhook secrets, SESSION_SECRET, JWKS keys. Quarterly cadence + scriptable rotation. |
Per platform
Coming soon. Until each one lands as its own page, the
@synqid/nextjs,
@synqid/react, and
@synqid/react-native chapters cover the
same ground inline with examples.
| Guide | What it would cover |
|---|---|
| Next.js (App Router) | Already covered in depth in @synqid/nextjs. |
| React Native + Expo | Already covered in depth in @synqid/react-native. |
| Express / Fastify backend | Token verification, scope-based authorization, refresh proxy, client_credentials for workers. |
| Vanilla React (SPA) | PKCE, in-memory token, refresh via hidden iframe, multi-tab sync. |
| Vue / Svelte / Solid | The same patterns without React. @synqid/js directly. |
| CLIs and AI agents | Device flow, polling, OS keychain storage, scope policies for act claim. |
Per provider (BYO)
How to wire your own OAuth credentials for each supported provider.
For now, the shape is the same for all: paste client_id and
client_secret from the provider’s developer console into Synq’s
Brand → Connections.
The provider-specific clickpath for each is documented in Concepts → BYO credentials.
Per feature
| Guide | What it would cover |
|---|---|
| Connect a wallet | Already covered in @synqid/js and the users API. |
| Implement a token gate | Already covered in Concepts → Token gates and the token-gates API. |
| Subscribe to webhooks | Already covered in Concepts → Webhooks and the webhooks API. |
| Headless modals deep dive | Already covered in @synqid/react → Headless modals. |
| Build a CLI with the device flow | Device-flow specifics are in OIDC API → Device flow. |
| Server-to-server (client_credentials) | Already covered in @synqid/js. |
Reading order
If you are landing on this site to ship something today and have a specific goal:
- Building a Next.js app: Quickstart →
@synqid/nextjs→ Production checklist. - Replacing an existing auth library: pick the migration guide → run the dual-issuer middleware → swap one route at a time.
- Going to production for the first time: Multi-environment setup → Production checklist → Rotate everything (scheduled cadence).
- Implementing an integration with Synq from a non-Next.js
stack:
@synqid/js→ Sessions and tokens → OIDC API.
Need a guide that doesn’t exist yet? Email support@synq.id — we prioritize based on what teams actually ask for.