Supportly
SupportlyDocs
/

Getting Started

Getting Started

Widget Integration

Widget Integration

AI Configuration

AI Configuration

API Reference

API ReferenceAPI Playground

Team Management

Team Management

Billing

Billing

FAQ / Troubleshooting

FAQ & Troubleshooting
Get started free
SupportlyDocs

Getting Started

Getting Started

The fastest way to get value from Supportly is to treat setup like an operational launch, not a cosmetic exercise. Start with one workspace, one production widget key, one concise system prompt, and a small set of high-signal FAQs.

Account setup and first workspace

Sign in with Clerk, complete onboarding, and create the first workspace with the name your support team already uses internally. Consistent naming matters because it appears across ticketing, API key management, and team invites.

Choose the workspace type based on how the team operates. Individual workspaces fit solo operators and consultants. Company workspaces fit support teams, shared ownership, and downstream reporting.

  1. 1

    Create the account

    Finish sign-in and confirm the email address you want tied to workspace ownership and future billing communication.

  2. 2

    Complete onboarding

    Enter the workspace name, select the workspace type, and capture the industry so the initial defaults reflect your support model.

  3. 3

    Verify defaults

    Open Settings, AI Config, and Widget to confirm the workspace was provisioned with default billing, widget, and AI configuration rows.

Recommended first rollout

Use a single production workspace for the initial launch. Keep staging and experimentation on test keys so live customer transcripts remain clean.

Embed the first widget

Generate a live API key from Settings and use that key in the website embed script. The widget configuration is fetched at runtime, so you can refine copy, branding, and pre-chat behavior without redeploying the host site.

For the first launch, place the widget on pages with obvious support intent: pricing, onboarding, billing help, or logged-in account surfaces.

Production embed

Use the script tag below on your site. Replace the placeholder key with the live workspace key generated in Supportly.

index.htmlhtml
1<script
2 src="https://your-supportly-domain.com/widget.js?v=YOUR_WIDGET_VERSION"
3 data-workspace-key="ws_live_xxxxxxxxx"
4></script>
  • Start with a short welcome message that names the support function clearly.
  • Enable only the pre-chat fields needed for routing or follow-up.
  • Test both successful AI resolution and explicit escalation to a human operator.

Operational readiness checklist

AreaWhat to verifyWhy it matters
TeamInvite at least one additional operatorAssignment, notifications, and availability cannot be validated with a single account.
AISet persona, tone, and escalation rulesThe default assistant should not go live without domain-specific boundaries.
Knowledge baseAdd 5-10 FAQs for recurring support questionsInitial retrieval quality depends on concise, specific source material.
WidgetPreview appearance on desktop and mobileBranding and pre-chat friction affect conversion immediately.

Suggested first FAQs

Seed the knowledge base with short, complete answers before traffic arrives.

seed-faqs.jsonjson
1[
2 {
3 "question": "How do I reset my password?",
4 "answer": "Open the sign-in page, choose Forgot password, and follow the email reset flow."
5 },
6 {
7 "question": "Where can I update billing details?",
8 "answer": "Open Settings > Billing in your account and update the payment information on file."
9 }
10]

Next

Widget Integration

On this page

Account setup and first workspaceEmbed the first widgetOperational readiness checklist