API Connector Documentation

Print

Import Help Scout Data to Google Sheets

Last Updated On
byAna
< Knowledge Base

In this guide, we’ll walk through how to pull data from the Help Scout Mailbox API directly into Google Sheets, using the API Connector add-on for Sheets.

The Help Scout Mailbox API only allows connecting through OAuth, so we'll first set up a connection and then set up a request to pull in data to your spreadsheet.

Content

Before You Begin

Click here to install the API Connector add-on from the Google Marketplace.

Part 1: Get Your Help Scout OAuth Credentials

  1. Sign in to Help Scout and navigate to your Profile by clicking on the Profile avatar at the top right corner, then click on the Your Profile link that appears in the drop down. helpscout-profile
  2. On the user profile page, click on My Apps in the menu within the left pane and then click on Create My App
    helpscout-createapp
  3. Give your App a name and paste API Connector's redirect URL, which is provided here. Click Create
    Create custom App
  4. A new page will open containing the credentials of your created App, click on Save to save the new App.
    helpscout-viewcredentials

Part 2: Connect API Connector to Help Scout

  1. Open up Google Sheets and click Extensions > API Connector > Manage Connections
  2. Scroll to the bottom of the sidebar and click Add Custom OAuth
  3. Fill in the Custom OAuth modal as follows:
    • OAuth Grant Type: Authorization Code
    • Name: Custom Help Scout
    • Authorization Base URL:  https://secure.helpscout.net/authentication/authorizeClientApplication
    • Token URL: https://api.helpscout.net/v2/oauth2/token
    • Client ID: provided by Help Scout
    • Client Secret: provided by Help Scout
  4. Click Save
    helpscout-customoauth
  5. Click Manage Connections to return to the list of connections
  6. Scroll down until you find your new custom connection. Click Connect
    helpscout-connect
  7. You'll be prompted to give access to the new app you created above. Click Authorize
    helpscout-authorize
  8. You'll be returned to your sheet and can verify that the new connection is now active.

Part 3: Get Help Scout Mailbox Data in Sheets

To create a request, include your full request URL in the request URL field, and select your custom Help Scout connection from the dropdown OAuth menu.

You can see the full list of available endpoint and parameters in the API documentation. For example, to get a list of conversations, configure it as follows.

  1. Open up Google Sheets and click Extensions > API Connector > Open > Create request.
  2. In the request form enter the following
    • Application: Custom
    • Method: GET
    • Request URL: https://api.helpscout.net/v2/conversations
    • OAuth: Custom Helpscout
  3. In the Output Settings click Set Current to choose the current sheet as the destination sheet for your data or manually type in the sheet name. Also, select a cell as the starting point.
  4. Name your request and click Run. A moment later you’ll see Help Scout Mailbox data populate your sheet.
    helpscout-response

Part 4: More Example API URLS

  1. To get a list of all customers: https://api.helpscout.net/v2/customers
  2. To get a list of all conversations: https://api.helpscout.net/v2/conversations
  3. To get a list of all mailboxes: https://api.helpscout.net/v2/mailboxes
  4. To get a list of all users: https://api.helpscout.net/v2/users
  5. To get a list all teams: https://api.helpscout.net/v2/teams

Part 5: API Documentation

Official API documentation: https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/

Leave a Comment

Jump To