How it works

This page explains the mental model behind [your product]. Reading it once should make the rest of the docs easier to navigate.

Note

An explanation page is the place for “why” and “how it fits together.” Save step-by-step instructions for Guides and exhaustive field lists for Reference.

Core objects

The product is organized around a small set of objects:

• Account — the top-level container. Every other object belongs to one account.
• User — a person who can sign in and act on behalf of an account.
• Widget — the primary resource your customers create and manage. (Rename to match your domain.)
• Event — an immutable record of something that happened. Powers webhooks and audit logs.

Rename, remove, or add objects so they match your own domain. The point of this page is to give a new reader a one-screen overview.

Lifecycle

A typical widget flows through these states:

draft → active → archived

Transitions happen either through the API, the dashboard, or scheduled jobs the platform runs on your behalf.

How a typical project is structured

• Directoryyour-app/

  • .env
  • Directorysrc/

    • client.ts initializes the SDK with your API key
    • Directorywidgets/

      • create.ts
      • list.ts
  • package.json

What’s next

• Glossary — definitions for the terms used across the docs.
• Quickstart — try it end-to-end.