HubSpot Source Connector

The HubSpot source connector in DataSync lets you retrieve data from HubSpot using the HubSpot API for loading or synchronizing in your data warehouse. You can authenticate using a HubSpot Private App Access Token to securely access the data your application is authorized to retrieve.

After creating all required source connections, configure your destination source to complete the connection setup.

Create a private app in HubSpot

To connect using a HubSpot Private App Access Token, set the AuthScheme property to PrivateAppToken and OAuthAccessToken to the value of your app's access token. For latest details, see the HubSpot Private Apps documentation.

Create a private app

1. Log in to HubSpot.
2. Click the gear icon on the upper‑right corner to open Settings.
3. In the left‑sidebar menu, select Integrations, then Legacy apps.
4. Click Create.
5. Choose Private.
6. On the Basic Info tab, enter your app name.
7. Hover over the placeholder logo and click Upload icon to upload a square image as the logo.
8. Enter a description for your app.
9. Select the Scopes tab and click + Add new scope.
10. Select Read or Write for each scope you want the app to access.
    • These scopes determine which HubSpot data the driver can retrieve.
    • Refer to the OAuthRequiredScopes and OAuthOptionalScopes properties for recommended selections.
11. Click Update when finished.
12. Click Create app.
13. Review the information about your app's access token.
14. Click Continue creating.
15. Click Show token to reveal your access token.
16. Click Copy to copy the token to your clipboard.
    
    You can now set the copied token in the Additional connection properties in DataSync used for both OAuthAccessToken and AuthScheme.

View your app's access token

If you need to view or copy your app's access token again:

1. Click the gear icon on the upper‑right corner to open Settings.
2. In the left‑sidebar menu, select Integrations, then Legacy apps.
3. Select the private app you created.
4. Click the Auth tab.
5. Click Show token to reveal the access token.
6. Click Copy to copy the token to your clipboard.

Create a source connection in DataSync

1. Log in to DataSync.
2. From the welcome screen, select Connections.
3. Next to Source Connections, click New.
4. Select HubSpot.
5. In the Connection Properties panel, enter the connection properties.
6. (Optional) In the Additional Connection Properties panel, select Add property and enter the parameters for each property.
7. In the Advanced Settings panel, configure the settings, including the Tracking Type and other values according to your requirements.
8. Click Save.

Parameters

Connection properties

Parameter	Description
Description	Unique name for the connection. Example: HubSpot
Timeout	Time in seconds to wait for connection opening and query execution before timeout.
Verbosity	1 – Log queries, row counts, execution start/end, errors. 2 – Includes level 1 plus cache queries, HTTP headers. 3 – Includes level 2 plus request/response bodies. 4 – Includes level 3 plus transport-level communication. 5 – Includes level 4 plus all interface commands.
Enable Pooling	Connection pooling option for performance.
Pool idle timeout	Maximum idle time for connections before returning them to the pool, in seconds.
Max Pool Size	Maximum number of connections allowed in the pool.
Pool wait time	Maximum wait time for connection allocation before error is thrown, in seconds.

Additional connection properties

Additional connection string properties not specified in the Connection Properties panel. For each property added, you can choose Visible or Encrypted. Selecting Encrypted hides the value from the interface and stores it encrypted in the back end, such as when defining passwords.

Property	Value
OAuthAccessToken	Application access token for your HubSpot private app. See View your app's access token. Example: pat-na1-12345678-abcdefgh-ijklmno
OAuthOptionalScopes	Scope list defining the API permissions available to your app: "automation,business-intelligence,crm.lists.read,crm.lists.write,crm.objects.companies.write,crm.objects.contacts.read,crm.objects.contacts.write,crm.objects.deals.read,crm.objects.deals.write,crm.objects.owners.read,crm.schemas.companies.read,crm.schemas.companies.write,crm.schemas.contacts.read,crm.schemas.contacts.write,crm.schemas.deals.read,crm.schemas.deals.write,content,conversations.visitor_identification.tokens.create,crm.import,cms.source_code.read_write,e-commerce,files,forms,forms-uploaded-files,hubdb,integration-sync,oauth,sales-email-read,social,tickets,timeline,transactional-email" Scopes can be refined based on the HubSpot OAuth documentation.
AuthScheme	Authentication scheme for the connection. See View your app's access token.

Advanced settings

Advanced settings control how the HubSpot connector tracks changes, handles regional and time configuration, and processes data batches during extraction. These options allow fine‑tuning for performance and accuracy, and should be configured according to your system environment and operational requirements.

Setting	Description
Tracking Type	Method for tracking changes: None or Date.
Region	Region setting for the connector, if required by your setup.
Time Zone	Time zone matching the HubSpot application server.
Time Offset	Refresh offset in seconds to compensate for timing issues in record selection. Minimum value is 0; maximum is 3600 seconds.
Batch Size	Quantity of records processed in each batch during extraction. Larger batch sizes increase memory usage but can improve performance up to a point. The default value is 2000 and the maximum should not exceed 10000 records. Adjust according to your network speed and disk performance; in most cases the default (2000) works best.

Example