Quickstart

Create a tenant, add your help center domain, issue identity tokens, and embed Supdesk in your app.

Supdesk gives each company an AI support agent plus a branded help center at a custom hostname (for example support.clientname.app). End users chat via your web widget, iOS or Android SDK, or the hosted help center.

1. Create a tenant

Sign up at the dashboard. You pick a slug (used for <slug>.supdesk.co.uk) and company name. Invite teammates from Settings → Members.

2. Publish knowledge

Add categories and articles in the dashboard. Published public articles appear in the help center; internal articles still feed the AI. On publish, chunks are embedded for hybrid vector + full-text retrieval.

3. Connect your backend

  • Copy the identity secret and sign JWTs for logged-in users (HS256, claim sub = your user id).
  • Set connector base URL and store the generated connector secret. Verify X-Supportal-Signature on every inbound call.
  • Implement POST /user-context (or your configured path) and optional custom actions / POST /refunds.

4. Embed the widget or SDK

Load embed.js from your tenant host, call Supportal.init({ identityToken }), or use the iOS/Android SDKs with the same host and an identity token provider. Anonymous sessions work for FAQs only — connector tools and refunds require a verified identity token.

5. Custom domain (optional)

Add a hostname in the dashboard and point a CNAME to our fallback origin. TLS is provisioned automatically via Cloudflare for SaaS. See Custom domain.

Local development

Run API on :8787, web on :5173, marketing site on :5174, and examples/mock-backend on :8788 for end-to-end tests. Seed tenant demo is created automatically.