Copy data from HubSpot using Azure Data Factory or Synapse Analytics

APPLIES TO: Azure Data Factory Azure Synapse Analytics

This article outlines how to use the Copy Activity in an Azure Data Factory or Synapse Analytics pipeline to copy data from HubSpot. It builds on the copy activity overview article that presents a general overview of copy activity.

Supported capabilities

This HubSpot connector is supported for the following capabilities:

① Azure integration runtime ② Self-hosted integration runtime

For a list of data stores that are supported as sources/sinks , see the Supported data stores table.

The service provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.

The connector supports the Windows versions in this article.

Getting started

To perform the Copy activity with a pipeline, you can use one of the following tools or SDKs:

• The Copy Data tool
• The Azure portal
• The .NET SDK
• The Python SDK
• Azure PowerShell
• The REST API
• The Azure Resource Manager template

Create a linked service to HubSpot using UI

Use the following steps to create a linked service to HubSpot in the Azure portal UI.

1. Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then click New:

   • Azure Data Factory
   • Azure Synapse

   

2. Search for HubSpot and select the HubSpot connector.

   

3. Configure the service details, test the connection, and create the new linked service.

   

Connector configuration details

The following sections provide details about properties that are used to define Data Factory entities specific to HubSpot connector.

Linked service properties

The HubSpot connector now supports version 2.0 (Preview). Refer to this section to upgrade your HubSpot connector version from version 1.0. For the property details, see the corresponding sections.

• Version 2.0 (Preview)
• Version 1.0

Version 2.0 (Preview)

The HubSpot linked service supports the following properties when apply version 2.0 (Preview):

Example:

{
    "name": "HubSpotLinkedService",
    "properties": {
        "type": "Hubspot",
        "version": "2.0",
        "typeProperties": {
            "clientId" : "<clientId>",
            "clientSecret": {
                "type": "SecureString",
                "value": "<clientSecret>"
            },
            "accessToken": {
                "type": "SecureString",
                "value": "<accessToken>"
            },
            "refreshToken": {
                "type": "SecureString",
                "value": "<refreshToken>"
            }
        }
    }
}

Version 1.0

The HubSpot linked service supports the following properties when apply version 1.0:

Example:

{
    "name": "HubSpotLinkedService",
    "properties": {
        "type": "Hubspot",
        "typeProperties": {
            "clientId" : "<clientId>",
            "clientSecret": {
                "type": "SecureString",
                "value": "<clientSecret>"
            },
            "accessToken": {
                "type": "SecureString",
                "value": "<accessToken>"
            },
            "refreshToken": {
                "type": "SecureString",
                "value": "<refreshToken>"
            }
        }
    }
}

Dataset properties

For a full list of sections and properties available for defining datasets, see the datasets article. This section provides a list of properties supported by HubSpot dataset.

To copy data from HubSpot, set the type property of the dataset to HubspotObject. The following properties are supported:

Example

{
    "name": "HubSpotDataset",
    "properties": {
        "type": "HubspotObject",
        "typeProperties": {},
        "schema": [],        
        "linkedServiceName": {
            "referenceName": "<HubSpot linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Copy activity properties

For a full list of sections and properties available for defining activities, see the Pipelines article. This section provides a list of properties supported by HubSpot source.

HubspotSource as source

To copy data from HubSpot, set the source type in the copy activity to HubspotSource. The following properties are supported in the copy activity source section:

Example:

"activities":[
    {
        "name": "CopyFromHubspot",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<HubSpot input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "HubspotSource",
                "query": "SELECT * FROM Companies where Company_Id = xxx"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Data type mapping for HubSpot

When you copy data from HubSpot, the following mappings apply from HubSpot's data types to the internal data types used by the service. To learn about how the copy activity maps the source schema and data type to the sink, see Schema and data type mappings.

Lookup activity properties

To learn details about the properties, check Lookup activity.

HubSpot connector lifecycle and upgrade

The following table shows the release stage and change logs for different versions of the HubSpot connector:

Upgrade the HubSpot connector from version 1.0 to version 2.0 (Preview)

1. In Edit linked service page, select version 2.0 (Preview) and configure the linked service by referring to Linked service properties version 2.0 (Preview).

2. The data type mapping for the HubSpot linked service version 2.0 (Preview) is different from that for the version 1.0. To learn the latest data type mapping, see Data type mapping for HubSpot.

3. query is only supported in version 1.0. You should use the tableName instead of query in version 2.0 (Preview).

Related content

For a list of data stores supported as sources and sinks by the copy activity, see supported data stores.