API Data Provider - Online Help

Connecting to Intercom

To authenticate to Intercom, you can use either Token authentication or the OAuth standard. Use Token authentication to connect to your own data. Use OAuth to allow other users to connect to their data.

Using Token Authentication

To authenticate to Intercom via token authentication, you'll need to obtain your Intercom Access token. You can find your Access token for new apps in your workspace by navigating to 'Configure' > 'Authentication' > 'Your workspace' from your Developer Hub. Once you have your Intercom Access token, set it as the API Key in the ProfileSettings connection property.

Example connection string

Profile=C:\profiles\Intercom.apip;ProfileSettings='APIKey=my_api_key';

Using OAuth Authentication

To authenticate to Intercom via OAuth, you will first need to enable OAuth by checking the box in the Intercom Developer Hub, within the Authentication page. Provide a RedirectURL (such as 'http://localhost:3333' if connecting locally), and specify the permissions you wish to enable in your application. Your app will be assigned a client ID and client Secret. After setting the following in ProfileSettings connection property, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • 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.

Example connection string

Profile=C:\profiles\Intercom.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey Your Intercom Access Token.
AuthScheme The scheme used for authentication. Accepted entries are None or OAuth.
Allowed values are: BASIC, NONE, NTLM, OAUTH, OAUTH_CLIENT
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060.0