Lyftron HelpScout Provider
The Lyftron API Profile for HelpScout allows you to query data from HelpScout. The HelpScout profile is a single file (i.e. helpscout.apip) which is meant to be used with the Lyftron API Driver. The profile contains the table definitions and other HelpScout specific metadata that the Lyftron API Driver uses to connect to HelpScout.
To use the HelpScout Profile set the Profile property of Lyftron API Driver to the path of the HelpScout profile, as well as the other connection properties specified in the documentation below. Once the Lyftron API Driver has been configured, you can issue SQL queries to access data from any of the HelpScout Tables.
Connecting to HelpScout
To authenticate to HelpScout, you can use either Access Token or the Basic Authentication standard. Use Access Token to connect to Mailbox API 2.0. Use Basic Authentication to connect to Docs API.
Using Basic Authentication for Docs API
Docs API uses API keys to control access to the API. You can view and regenerate API keys "Person Icon" > "Your Profile" > "Authentication" > "Generate an API Key". Each API Key is associated with a Help Scout user. Set the connection properties "User" to your API Key and a dummy Password, such as "X", goes in the password field.
Using OAuth Authentication for Mailbox API 2.0
You will first need to register an OAuth application for your account. Once registered, Redirect to "Your Profile" > "My Apps" > "Select App" > "Create My App" Credentials to receive a App name, Redirection URL, App ID and a App Secret for your app. Set the connection properties "OAuthClientId" to your App ID, "OAuthClientSecret" to your App Secret, and "RedirectURL" to the Callback URL that you set for your app. To have the driver automatically retrieve and refresh tokens for you, set "InitiateOAuth" to GETANDREFRESH.
After setting the following in ProfileSettings connection property, you are ready to connect:
- OAuthClientID: Set this to the App Id that is specified in your app settings.
- OAuthClientSecret: Set this to App Secret that is specified in your app settings.
- CallbackURL: Set this to the Redirect URI you specified in your app settings.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
Your app will be assigned a App ID and a App secret. Set these in your connection string via the OAuthClientId and OAuthClientSecret properties.