Welcome to the Help Scout JavaScript SDK! This SDK provides a powerful and easy-to-use set of tools to help you build and extend apps within the Help Scout platform. By leveraging the JavaScript SDK, you can create seamless interactions with Help Scout’s features and access contextual information like conversation, customer, and user data.


To install the Help Scout JavaScript SDK, run the following command:

npm install @helpscout/javascript-sdk


yarn add @helpscout/javascript-sdk


To get started with the Help Scout JavaScript SDK, simply import it and access the methods provided:

import HelpScout from "@helpscout/javascript-sdk";

Now you can use the SDK to interact with Help Scout’s interface directly from apps. See the SDK reference for detailed information on available methods and usage examples. Learn how to fetch contextual data, show notifications, and more with the Help Scout JavaScript SDK.

For more information on accessing data from your apps using the getApplicationContext() method, refer to the Getting Data from Help Scout with JavaScript guide.