HubSpot

Supports:

✅ Models
✅ Model sync destination
✅ Bulk sync source
✅ Connection Proxy

Connection

Configuration

Name	Type	Description	Required
`client_id`	`string`		`false`
`client_secret`	`string`		`false`
`include_static_list_support`	`boolean`	Enable segment (list) support	`false`
`oauth_refresh_token`	`string`		`false`
`use_search_api`	`boolean`	Use HubSpot incremental API for bulk syncs	`false`

Example

{
  "name": "HubSpot connection",
  "type": "hubspot",
  "configuration": {
    "client_id": "a45gadsfdsaf47byor2ugfbhsgllpf12gf56gfds",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "include_static_list_support": false,
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "use_search_api": false
  }
}

Read-only properties

Name	Type	Description	Required
`hub_domain`	`string`	HubSpot domain	`false`
`hub_user`	`string`	HubSpot user	`false`

Model Sync

Source

Configuration

Name	Type	Description	Required
`list_id`	`string`	Records	`false`
`stream_id`	`string`		`false`

Example

{
  ...
  "configuration": {
    "list_id": "",
    "stream_id": "companies"
  }
}

Target

HubSpot connections may be used as the destination in a model sync. Some destinations support additional configuration.

Companies

Applies to:

companies

Configuration

Name	Type	Description	Required
`create_with_empty_identity`	`boolean`	Sync records with an empty identity value Do not omit records with an empty identity value from create or create and update mode syncs when hs_object_id is the identity mapping.	`false`
`invalid_relationships`	`string`	Records with invalid relationship IDs Accepted values: `error`, `omit_values`, `omit_records`	`false`
`match_additional_domains`	`boolean`	Match against HubSpot’s ‘Additional domains’ field	`false`
`replace_associations`	`boolean`	Replace existing relationships	`false`
`write_null_values`	`boolean`	Copy null values	`false`

Example

{
  ...
  "target": {
      "configuration": {
        "create_with_empty_identity": false,
        "invalid_relationships": "",
        "match_additional_domains": false,
        "replace_associations": false,
        "write_null_values": false
    }
  }
}

Contacts

Applies to:

contacts

Configuration

Name	Type	Description	Required
`create_with_empty_identity`	`boolean`	Sync records with an empty identity value Do not omit records with an empty identity value from create or create and update mode syncs when hs_object_id is the identity mapping.	`false`
`ignore_additional_emails`	`boolean`	Ignore HubSpot’s ‘Additional emails’ field	`false`
`invalid_relationships`	`string`	Records with invalid relationship IDs Accepted values: `error`, `omit_values`, `omit_records`	`false`
`replace_associations`	`boolean`	Replace existing relationships	`false`
`write_null_values`	`boolean`	Copy null values	`false`

Example

{
  ...
  "target": {
      "configuration": {
        "create_with_empty_identity": false,
        "ignore_additional_emails": false,
        "invalid_relationships": "",
        "replace_associations": false,
        "write_null_values": false
    }
  }
}

Other targets

Configuration

Name	Type	Description	Required
`create_with_empty_identity`	`boolean`	Sync records with an empty identity value Do not omit records with an empty identity value from create or create and update mode syncs when hs_object_id is the identity mapping.	`false`
`invalid_relationships`	`string`	Records with invalid relationship IDs Accepted values: `error`, `omit_values`, `omit_records`	`false`
`replace_associations`	`boolean`	Replace existing relationships	`false`
`write_null_values`	`boolean`	Copy null values	`false`

Example

{
  ...
  "target": {
      "configuration": {
        "create_with_empty_identity": false,
        "invalid_relationships": "",
        "replace_associations": false,
        "write_null_values": false
    }
  }
}

Bulk Sync

Source

Configuration

Name	Type	Description	Required
`include_archived`	`boolean`	Include archived HubSpot records	`false`

Example

{
  ...
  "source_configuration": {
    "include_archived": false
  }
}