Skip to main content

New hires land on day one with a dozen tasks spread across HR, IT, and their team — and no single place to see what's done, what's left, and where to get help. The Onboarding Hub solves that: a gamified checklist with progress tracking, milestone badges, and contextual Glean chat on every step.

This recipe builds the hub two ways so you can pick the trade-off that fits your portal — Web SDK for fastest SSO integration, Platform Chat when you need full UI control.

Onboarding Hubchecklist + progress + chat
Path A: Web SDKrenderChat — Glean owns chat UI
Path B: Platform Chatglean.chat.create — you own the UI
Gleanpermission-aware cited answers
Node 20.19+ or 22.12+
Your work email, so setup can find your Glean tenant
Onboarding content already indexed in Glean, because the checklist answers from your own docs
Web SDK path only: you are already signed in to Glean in your normal browser
1

Pick a path

Both paths build the same first-week checklist. Choose Web SDK if you want Glean's chat UI and the Glean session already in your browser. Choose Platform Chat if you want to own the answer UI and call Glean from your backend.

1

Copy the project onto your machine

Creates an `onboarding-hub` folder in whatever directory you run this from. Every command after this one runs inside that folder.

npx -y tiged@2.12.8 --mode=git gleanwork/glean-cookbook/recipes/onboarding-hub/web-sdk onboarding-hub
2

Install dependencies

Installs the Glean Web SDK and the Vite dev server that hosts the page.

cd onboarding-hub && npm install
3

Find your Glean tenant

Your email is used once to find which Glean tenant you belong to. The command creates `.env.local` and fills in `VITE_GLEAN_BACKEND`.

cd onboarding-hub && npm run configure -- --email "<work-email>"
4

Keep the sample checklist, or use your own

`public/steps.json` is already in the project, so you can run with the sample. To use your own onboarding program, replace those steps. Each one needs a unique `id`, a `title`, a `group` (`it`, `hr`, `team`, or `engineering`), `initiallyDone`, and an `askPrompt`.

5

Open the page

Starts Vite and prints a Local URL. Open that URL yourself in your normal browser where you are already signed in to Glean.

cd onboarding-hub && npm run dev
6

Check it against your own content

Once the page is open in your signed-in browser, confirm your checklist renders. Click **Ask about this** on a step and check that Glean returns a cited first-day answer.

Take it further
  • Wire real HRIS completion events instead of localStorage toggles.
  • Add a manager view that shows onboarding progress across the team.
  • Scope chat to onboarding-only documents, so a first-week question cannot wander into unrelated content.

What should I do on my first day?

Returns a cited answer drawn from your own onboarding documents, and the checklist reflects steps that actually appear in them rather than a hardcoded list.

How do I set up VPN?

Returns a cited answer from your own IT documentation.

What's our PTO policy?

Returns a cited answer respecting the asker's permissions — the same question from two people with different access should not return content either of them can't see.

Ask about a step your docs don't cover

Platform Chat path only: the app offers its escalation affordance rather than inventing a plausible-sounding onboarding step. The Web SDK owns its unsupported-answer experience.

Each of these was run against a live Glean instance on 2026-08-21.

View source

Runs the recipe through the Glean cookbook plugin.

Auth

Web SDK

This path uses your existing Glean browser session. Find the web app URL on the About page. The API server URL is a different field.

Platform Chat

Run the authenticate step on this page. It discovers your tenant from work email and signs you in with OAuth, using the shipped login command. If OAuth is unavailable, create a scoped Glean-issued token in Token Management (CHAT).

At a glance
SurfacesWeb SDK, Platform API
StatusShowcase
Time~45 min
Required scopes

Platform Chat

CHAT