Assistant SDK overview

Install the ThriveDesk Assistant and control the customer-facing widget from JavaScript.

The Assistant SDK is the browser integration surface for the ThriveDesk widget. Use it to initialize an Assistant, open a specific screen, prefill contact details, display Knowledge Base articles, and coordinate widget behavior with your application.

Prerequisites

  • A configured Assistant in Settings → Channel → Assistant.
  • The Assistant ID and installation snippet from its Installation tab.
  • Permission to add JavaScript to your website or tag manager.

Install the Assistant

Copy the installation snippet shown by ThriveDesk and place it before your closing </body> tag. The snippet is the source of truth for the current script URL and Assistant ID; do not copy those values from another workspace.

After the snippet loads, register work that depends on the widget inside the ready callback:

<script>
  Assistant('ready', () => {
    Assistant('identify', {
      name: 'Jane Cooper',
      email: '[email protected]'
    });
  });
</script>

Production workspace

No separate Assistant sandbox is publicly documented. Test with a dedicated Assistant and inbox before adding the snippet to your production site.

Initialization and ready callback

Initialize the Assistant with or without its launcher and wait until it is safe to call methods.

Prerequisites
Install the Assistant
Related