Skip to main content

How to set up a Help Scout integration

Josh Peacock
  • Updated

Setting up a Help Scout integration is easy!

To do this you will first need to generate a Docs API Key in Help Scout to establish the connection with LaunchBrightly. You can find detailed instructions from Help Scout's developer documentation for Docs, as well as a summary below:

  1. Click the profile icon in the top right of your Help Scout account
  2. Select Your Profile
  3. Click Authentication in the left-hand menu
  4. Select the API Keys tab
  5. Copy your Docs API Key

Note: If you don't see an Docs API Key in your profile, you haven't been granted the "Docs: Create new, edit settings & Collections" permission. Contact your Help Scout Account Owner or Administrator to request access.

Once you have copied your API Key, you can set up your Help Scout integration from the Settings page in LaunchBrightly:

  1. Select Add integration

  2. Select Help Scout

  3. Add a Name for the integration and paste in your API Key

  4. Select Test connection to confirm the details are correct

  5. Click Save

And you're all set!

Note: All API keys are immediately encrypted and stored using AWS Key Management Service (KMS), which leverages hardened hardware security modules (HSMs) to protect and manage cryptographic keys.