ExpandedToggleIcon        Connection Dialog

To connect to Pipedrive, first you need to select Authentication Type and then specify the required parameters or perform web login depending on the Authentication Type selected.


For APIToken authentication type, specify the API Token.

Your API Token can be found under Settings -> Personal (Personal preferences)-> API. Check the following topic in the Pipedrive documentation for more details: https://support.pipedrive.com/hc/en-us/articles/207344545-How-to-find-your-personal-API-key.


For RefreshToken (OAuth 2.0) authentication, perform the following steps:

1.Click the Web Login button
2.In the opened login page in the browser sign in to Pipedrive.
3.Select your account to use.
4.Сlick Continue to the App to proceed further.
5.Refresh token is generated.


In addition to the required options, you can configure the Advanced connection parameters for more fine connection tuning.


ExpandedToggleIcon        Advanced Connection Options

The following table describes the options that you can include in the Connection String using the Advanced Connection Editor dialog box:




Authentication Type

Determines the authentication type to use - APIKey or RefreshToken (OAuth 2.0).

Client Id

Id of registered Pipedrive app.

Client Secret

Password of registered Pipedrive app.

Connection Lifetime

When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connection Timeout

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 60.

Default Command Timeout

The time in seconds to wait while trying to execute a command before terminating the attempt and generating an error. The default value is 60.

Failover Retries

The number of retry attempts to re-run a command in case when the command failed because of an exception, that indicates that the reason of the failure may be temporary.

Local SQL Engine

Determines whether to enable local SQL processing (enabled by default). Local SQL processing allows performing complex SELECT statements that cannot be directly compiled to Pipedrive API calls. In this case the data from the mentioned cloud objects is queried to the local cache, and then the query is performed against the cache.

If local SQL processing is disabled, only simple SELECT statements that can be directly translated into Pipedrive API calls can be used. More complex SELECT statements will fail.

Max Pool Size

The maximum number of connections allowed in the pool. Setting the Max Pool Size value in the connection string can affect performance. The default value is 100.

Min Pool Size

The minimum number of connections allowed in the pool. The default value is 0.


This parameter stores the API Key (an automatically generated API key that is used to connect to Pipedrive). The parameter is used for APIToken authentication only.

Persist Security Info

Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.


If true, by default, the connection is drawn from the appropriate pool or is created and added to the appropriate pool.

Proxy Host

The host name or IP address of proxy server.

Proxy Password

The password for the proxy server account.

Proxy Port

The port number of the proxy server. The default value is 3128.

Proxy User

The proxy server account name.


Indicates whether the connection is read-only (allows only SELECT statements).


This parameter stores Refresh Token. The parameter is used for OAuth authentication only.

Token Server

This parameter is used for OAuth authentication only.  SSIS Data Flow Components for Pipedrive can query new refresh tokens automatically when the current one expires and store them between sessions if you set this parameter. This parameter specifies the location to store new tokens between sessions. You can specify a file or a registry key to store tokens. For example, "file://D:\temp\oauth_token_1234.txt" or "reg://HKEY_CURRENT_USER\Software\Devart\dotConnect\OAuth_12345"


If set to True, allows working with Pipedrive custom fields.

UTC Dates

If set to True, dates will be converted to UTC format during import, and the date values entered by the user (in SELECT statements, etc.) are considered UTC dates when sending them to the data source.