Connecting to LeadDesk

LeadDesk uses OAuth-based authentication.

Using OAuth Authentication

To connect to LeadDesk, you will first need to register an OAuth application for your account by going to 'General Settings' > 'API' > 'Create'. Once registered, your app will be assigned a client ID and a client secret. After setting the following in the connection string, you are ready to connect:

AuthScheme: Set this to OAuth.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
OAuthClientId: Set this to your app's client ID
OAuthClientSecret: Set this to your app's client Secret
User: Set this to your user login username.
Password: Set this to your account's password.

Example connection string

Profile=C:\profiles\LeadDesk.apip;Authscheme=OAuth;InitiateOAuth=GetAndRefresh;OAuthClientId=my_app_id;OAuthClientSecret=my_app_secret;User=my_login_username;Password=my_login_password;

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
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.