Docs

Install and configure SupportLime

Five minutes from signup to a live assistant. This page covers the script tag, the dashboard settings and the JavaScript API.

1. Install the widget

Create a free account, add your website URL (we crawl it), then paste this tag before the closing </body> tag of every page. Your key is in Dashboard → Widget.

<script src="https://widget.supportlime.com/v1.js" data-key="sl_pub_YOUR_KEY" async></script>

Optional attributes: data-position="left", data-color="#84cc16" (launcher colour before settings load). The loader is about 2 KB, runs after the page is interactive and mounts the chat frame only when a visitor clicks.

Platform guides: Shopify, WordPress, WooCommerce, Webflow, Wix, Squarespace, Framer, Next.js and React.

2. Teach the assistant

  • Website crawl. We follow your sitemap (or crawl links), respect robots.txt and noindex, and skip carts, logins and admin pages. Unchanged pages are not re-processed.
  • Text and Q&A. Paste policies, FAQs or exact answers in Dashboard → Knowledge. Q&A pairs are the most precise way to fix an answer.
  • Single pages. Add a URL that is not linked from your site.
  • Re-sync. Daily on paid plans, weekly on Free, or on demand.

Answers are generated only from this content. When the assistant cannot find an answer it says so, offers to connect the visitor with you and asks for an email.

3. Widget settings

  • Assistant name, greeting, suggested questions set the first impression.
  • Persona is extra guidance for tone and rules ("never promise delivery dates"). Visitors never see it.
  • Colour and position match your brand.
  • Ask for email: before the first message, after the first answer, only on handoff, or never.
  • Allowed domains: the widget refuses to load anywhere else. Localhost is always allowed for testing.
  • Live / paused switches the widget off without removing the tag.

4. JavaScript API

// Available once v1.js has loaded
window.SupportLime.open();      // open the chat
window.SupportLime.close();
window.SupportLime.toggle();
window.SupportLime.identify({ email: 'jane@acme.com', name: 'Jane' });
window.SupportLime.setContext({ plan: 'pro', page: 'checkout' });
window.SupportLime.isOpen();    // boolean

Call identify after a user logs in so their conversations are attached to the right contact in your inbox. Open the chat from your own "Need help?" buttons with open().

5. Content Security Policy

script-src  https://widget.supportlime.com;
frame-src   https://widget.supportlime.com;
connect-src https://api.supportlime.com;

6. Inbox, tickets and team

Every widget conversation appears in Dashboard → Inbox. Replying pauses the assistant in that thread; the visitor sees your reply in the widget, or by email if they left one. Resolve a conversation when done, or turn it into a ticket with status, priority, assignee and notes. Invite teammates in Dashboard → Team; they log in with a one-time email code.

7. API and MCP server

Growth and Scale plans include API keys and a remote MCP server, so Claude, ChatGPT and other agents can read your inbox, reply, create tickets and add knowledge on your behalf. The REST API mirrors the dashboard: /api/v1/websites, /api/v1/inbox/conversations, /api/v1/tickets, /api/v1/analytics, authenticated with Authorization: Bearer <api key>. Webhooks notify your own systems on handoffs, tickets and captured leads. See the API reference.

Frequently asked questions

Does the widget work on every browser?
Yes, all current browsers on desktop and mobile. On phones the chat opens full screen.
Where is my data stored?
Conversation and knowledge data is stored in the EU/US on our servers and Cloudflare; AI processing uses a leading model provider under a no-training agreement. See the privacy policy for sub-processors.
Can I export conversations?
Yes, from the API, and a CSV export is coming to the dashboard.

Try it on your own site

Free plan, no card. Paid plans start at $29 with unlimited teammates.

Add it to your siteRead the docs

Feedback? Need help?