Skip to content
Docs
Sign in

SDK reference

Every option, method and event of the chat widget, kept in step with each release.

  1. Overview

    The whole SDK on one page.

  2. Quickstart

    Credentials, the install paths and a first check, in five minutes.

  3. Installation

    Every install path in depth: script tag, async loader, npm, web component, CDN URLs and version pinning.

  4. Frameworks

    The React kit (<HelpAI />, useHelpAI()), Next.js, Remix, Vue, Nuxt, Svelte, Astro, Angular, WordPress, Shopify, Webflow.

  5. Configuration

    Every option by group, with examples.

  6. Option reference

    The table of every option, generated from the schemas; authoritative.

  7. API reference

    Exports, instance methods (ask, open, state, ready, reset, …), the global API, no-script triggers, deep links, JSX typings.

  8. Events and hooks

    Every event and its payload, on() and hook().

  9. Page tools

    WebMCP-shaped tools the AI agent calls on your page (registerTool, tools, useHelpAITool, <form toolname>), run once in the browser.

  10. Theming

    Colors, shapes, fonts, launcher styles, theme: "host" and ::part() styling.

  11. Recipes

    Copy-paste solutions for common integrations.

  12. Analytics

    Sending widget activity to Google Analytics, Segment, PostHog and other trackers.

  13. Security and privacy

    Isolation, CSP, what the widget stores and sends.

  14. Browser support

    Supported browsers and fallbacks.

  15. Troubleshooting

    An install that does not show, connect or answer.

  16. FAQ

    Short answers to common questions.