Help Scout Developer Platform — Sidebar App Template
This is a basic starter template for building a Help Scout Sidebar App. It uses Vite and React, and it comes with Help Scout's UI Kit and JavaScript SDK pre-installed.
🚀 Getting Started
- Go to https://github.com/helpscout/app-template and click the green Use this template button → Create a new repository. Give your new repo a name, and save it.
- Go to https://codesandbox.io/ and create an account if you don't have one (you can login with your Github account.)
- On CodeSandbox, click on Import repository and select the repository you created in step 1.
The first time you open your repo in CodeSandbox it will take a couple of minutes to build a container and install dependencies. Once that's done, you'll see the code editor on the left and a preview panel of your app on the right.
-
Hover on the preview panel and click on the Show navigator icon on the top right. This will reveal the URL of your environment. Copy this URL, you'll need it in a few minutes.
-
On Help Scout, login as an Administrator or Account owner and navigate to Manage -> Apps -> Build a custom app (or click here)
-
Click on Create App, fill out the form as described below, and click Save:
- App Name: anything you want
- Content Type: Dynamic App
- Callback URL: the URL of your environment you copied previously
- New Apps Platform: Toggle on
- Mailboxes: select the mailboxes where you want this app to be available in
- Go to one of the Mailboxes you selected in the previous step and open a conversation. You should see your app running in the right Sidebar.
- Now you can start making changes to your app in CodeSandbox and you should see those changes reflected immediately in Help Scout.