Add the chat widget to your site

This guide takes you from your codebase to a working chat widget on your site. It should take a few minutes once your account is set up.

Before you start

• A Syncanix account and a workspace.
• Access to your API’s codebase so the CLI can discover it.
• A publishable key for the workspace (you’ll create one along the way).

Steps

1. 1
   Discover your APIRun the discovery CLI in your project. It detects your endpoints and uploads a catalog to your workspace.
2. 2
   Review the catalogIn the dashboard, review the discovered capabilities and choose which ones the assistant may use.
3. 3
   Design the widgetUse the Widget Design Studio to match the widget to your brand, or let it derive a theme from your site.
4. 4
   Embed the snippetCopy the widget snippet and paste it into your site, with your publishable key.
5. 5
   Verify it worksOpen your site, start a chat, and confirm the assistant responds and can use your catalog.

Next steps