Lyftron Intercom Provider
The Lyftron API Profile for Intercom allows you to query data from Intercom. The Intercom profile is a single file (i.e. intercom.apip) which is meant to be used with the Lyftron API Driver. The profile contains the table definitions and other Intercom specific metadata that the Lyftron API Driver uses to connect to Intercom.
To use the Intercom Profile set the Profile property of Lyftron API Driver to the path of the Intercom profile, as well as the other connection properties specified in the documentation below. Once the LyftronAPI Driver has been configured, you can issue SQL queries to access data from any of the Intercom Tables.
Connecting to Intercom
To authenticate to Intercom, you can use either Basic authentication or the OAuth standard. Use Basic to connect to your own data. Use OAuth to allow other users to connect to their data.
Using Basic Authentication
To use Basic Authentication, specify your Api-Key in ProfileSettings connection property. Set this to your Intercom Access Token. Intercom provides an Access Token as soon as you create an app on your workspace. Find your access token in the Configure > Authentication / Test and publish > Your workspaces section of your Developer Hub.
Using OAuth Authentication
First, enable the OAuth option by checking the box in the Intercom Developer Hub, within the Authentication page. Provide a RedirectURL (set it to http://localhost:3333 if connecting locally), and specify the permissions you wish to enable in your application.
After setting the following in ProfileSettings connection property, you are ready to connect:
- OAuthClientId: Set this to the Client Id that can be found on the Basic Information page for your app in the Developer Hub.
- OAuthClientSecret: Set this to the Client Secret that can be found on the Basic Information page for your app in the Developer Hub.
- CallbackURL: Set this to the Redirect URI you specified in your Authentication page in the Developer Hub.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.