Skip to main content

Authorization

Follow this guide to create a new Help Scout credential that will allow Nexla to authenticate to and exchange data with your Help Scout account.
help_scout_api_auth.png

Help Scout

Prerequisites​

The Help Scout Inbox API 2.0 uses OAuth 2.0 for all authentication. Before creating a Help Scout credential in Nexla, you must create an OAuth2 application in your Help Scout account to obtain an App ID (client ID) and App Secret (client secret). These credentials are used to authenticate Nexla's API requests on your behalf.

Create a Help Scout OAuth2 Application​

Help Scout OAuth2 applications are created from your personal profile settings. Each application generates a unique App ID and App Secret pair.

  1. Sign in to your Help Scout account at app.helpscout.com.

  2. Click your avatar or account icon in the upper-right corner of the screen, and select Your Profile from the dropdown menu.

  3. In the left-hand navigation panel of your profile page, click My Apps.

  4. Click the Create My App button to open the application creation form.

  5. Enter a descriptive name for the application in the App Name field — for example, Nexla Integration.

  6. Enter a Redirection URL for the application.

    If you plan to use the Client Credentials OAuth2 flow (recommended for server-to-server integrations like Nexla), you can enter a placeholder URL such as https://www.example.com in the Redirection URL field. The Client Credentials flow does not redirect users to an external URL.

  7. Click Create to save the application. Help Scout will display the App ID and App Secret for the newly created application.

Important

Copy your App Secret immediately after creating the application. Help Scout does not display the App Secret again after you navigate away from this page. Store it securely, for example, in a password manager or secrets vault.

  1. Note the App ID and App Secret values — you will need both when configuring the Help Scout credential in Nexla.

For additional reference, see the Help Scout Authentication documentation.

Create a Help Scout Credential​

  • To create a new Help Scout credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Authentication Settings​

Help Scout uses OAuth 2.0 with the Client Credentials flow for server-to-server API access. This flow exchanges your App ID and App Secret directly for an access token, without requiring a user login redirect.

  1. Enter the App ID from your Help Scout OAuth2 application in the App ID field. This value serves as the OAuth2 client_id for all API token requests.

  2. Enter the App Secret from your Help Scout OAuth2 application in the App Secret field. This value serves as the OAuth2 client_secret and should be kept confidential.

    Access tokens issued via the Client Credentials flow are valid for 48 hours. Nexla automatically handles token renewal by re-requesting a new access token using your App ID and App Secret, so no manual re-authorization is needed.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.