Skip to main content

​
Overview

To authenticate with Help Scout, you need one key piece of information:
  1. API Key - Your Help Scout Work API Key
This guide will walk you through finding or creating those credentials within Help Scout.

​
Prerequisites:

  • You must set up an account with Help Scout.

​
Step 1: Finding Help Scout API Key

  1. Log into your Help Scout account.
  2. Each user has a Docs API key. To generate, view, or regenerate the API key, click the “person” icon on the top right of your account, next to the search, then click Your Profile.
  1. Next, click the Authentication link in the menu on the left and select the API Keys tab.
Note: If you don’t see an API key in your profile, it’s because you haven’t been granted the “Docs: Create new, edit settings & Collections” permission by the Account Owner or an Administrator.
  1. Store your API key securely.

​
Step 2: Connect Your Help Scout Account

To authenticate using your API credentials, navigate to the Help Scout authentication form. Enter your credentials as follows:
  • API Key: Your Help Scout API Key
Click “Connect” to complete the authentication.