Skip to main content
You’ll have an app running — install lifecycle, an embedded UI, a live session, a signed webhook — in about two minutes. None of it needs the real Sentralbee stack: the CLI ships a mock platform that stands in for it locally.

1. Install the CLI and scaffold an app

Install the sentralbee CLI, then scaffold a new app. What you get is a complete starter, all wired up: a Hono API on the install lifecycle, a session-authed API, a webhook handler, and a React embed.
Prefer not to install globally? bunx @sentralbee/cli create my-app scaffolds the same app without a global install. Installing the CLI is still the smoothest way to use the sentralbee dev / webhook / token / manifest commands below from anywhere.
Then install dependencies:

2. Look around

The whole app is small:

3. Run it

This builds the embed UI and starts sentralbee dev, which:
  1. generates a throwaway dev keypair and starts your app with the matching public key,
  2. mock-installs a workspace — delivering a fake API key (and webhook secret) to /install/provision, exactly as the real platform would,
  3. prints an embed URL carrying a live session token.
Open the Embed URL and you’ll see your app running as the mock workspace — ”✓ Connected”. Add &theme=dark to preview dark mode.

4. Exercise the pieces

From your app’s directory, in another terminal:

5. Build your app

  • Add an endpoint — add a route to the api Hono instance in api/src/app.ts. It’s session-authed, so read the tenant with c.get('workspace'), never from the request body.
  • Call Sentralbee — decrypt your stored key and use sentralbeeClient; see Calling the API.
  • Handle webhooks — declare events in your manifest and verify with verifyWebhookSignature; see Webhooks.
  • Request permissions — edit sentralbee.app.json → scopes; see The manifest.
  • Build your UI — edit ui/src/App.tsx with the useHostTheme / useSafeArea / useSessionToken hooks; see The embed UI.

Where to next