Required Scopes

To configure a Sync for HubSpot, you need to request the following scopes from your HubSpot OAuth application: Contacts:
  • crm.objects.contacts.read
  • crm.schemas.contacts.read
Companies:
  • crm.objects.companies.read
  • crm.schemas.companies.read
Deals:
  • crm.objects.deals.read
  • crm.schemas.deals.read
Custom Objects:
  • crm.objects.custom.read
  • crm.schemas.custom.read
Learn more about configuring scopes for your app in Adding Integrations.

Synced Objects

HubSpot supports the following Synced Objects:

Contacts

Sync Configuration Options

Example
{
    "integration": "hubspot",
    "pipeline": "contacts",
    "configuration": {
        "properties": ["firstname", "lastname", "email", "phone", "company"]
    }
}
properties
array
An array of HubSpot contact property names to sync. If not specified, the Sync will fetch all available contact properties.

Companies

Sync Configuration Options

Example
{
    "integration": "hubspot",
    "pipeline": "companies",
    "configuration": {
        "properties": ["name", "website", "industry"]
    }
}
properties
array
An array of HubSpot company property names to sync. If not specified, the Sync will fetch all available company properties.

Deals

Sync Configuration Options

Example
{
    "integration": "hubspot",
    "pipeline": "deals",
    "configuration": {
        "properties": ["firstname", "lastname", "email", "phone", "company"]
    }
}
properties
array
An array of HubSpot deal property names to sync. If not specified, the Sync will fetch all available deal properties.

Custom Objects

Custom Objects can be used to sync any object type (including custom user-defined object types) from HubSpot directly, without using a mapping to a Synced Object Type.

Sync Configuration Options

Example
{
    "integration": "hubspot",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "custom_object_name",
        "properties": ["custom_field_name1", "custom_field_name2"]
    }
}
customObjectName
string
required
The internal name of the object type to sync, e.g. feedback_submissions.
properties
array
An array of HubSpot property names to use in the sync. If not specified, the Sync will fetch all available properties for the object type.