HubSpot integration summary

Stitch’s HubSpot integration replicates data using the HubSpot REST API. Refer to the Schema section for a list of objects available for replication.

HubSpot feature snapshot

A high-level look at Stitch's HubSpot (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Sunset on September 23, 2019

Supported by

Stitch

Stitch plan

Standard

API availability

Not available

Singer GitHub repository

singer-io/tap-hubspot

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Unsupported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Supported

Column selection

Unsupported

Select all

Supported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

HubSpot table reference

Custom HubSpot Field Replication

Custom object properties, or fields, are supported by Stitch’s HubSpot integration. Stitch will query the properties list for each object and, if custom fields are available through HubSpot’s API, replicate them to your destination.

This is applicable to any object that supports custom fields in HubSpot.

HubSpot Date/DateTime Values & UNIX Timestamps

HubSpot uses UNIX-formatted timestamps in milliseconds to store date and datetime data. Stitch doesn’t perform any transformation during the replication process, meaning these values won’t be converted to timestamps before they’re loaded into your destination.

To account for this, consider creating a user-defined function to perform the conversion or building views on top of the raw data.


campaigns

The campaigns table contains info about the campaigns in your HubSpot account.

Replication Method

Full Table

Primary Key

id

Useful links

HubSpot documentation

campaigns schema on GitHub

HubSpot API method

appId

INTEGER

appName

STRING

contentId

INTEGER

counters

OBJECT

click

INTEGER

delievered

INTEGER

open

INTEGER

processed

INTEGER

sent

INTEGER

id

INTEGER

name

STRING

numIncluded

INTEGER

numQueued

INTEGER

subType

STRING

subject

STRING

type

STRING

companies

The companies table contains info about the companies your HubSpot contacts belong to.

Note: when this table is synced, the hubspot_contacts_by_company table will also be automatically synced and created in your data warehouse.

Replication Method

Full Table

Primary Key

companyId

Useful links

HubSpot documentation

companies schema on GitHub

HubSpot API method

companyId

INTEGER

isDeleted

BOOLEAN

portalId

INTEGER

contact_lists

The contact_lists table contains info about the contacts lists in your HubSpot account. Contact lists are used to segment contacts into groups, and there are two types: dynamic (smart lists) and static.

Replication Method

Key-based Incremental

Primary Key

listId

Replication Key

updatedAt

Useful links

HubSpot documentation

contact_lists schema on GitHub

HubSpot API method

archived

BOOLEAN

createdAt

DATE-TIME

deleteable

BOOLEAN

dynamic

BOOLEAN

filters

ARRAY

internalListId

INTEGER

listId

INTEGER

listType

STRING

metaData

OBJECT

name

STRING

parentId

INTEGER

portalId

INTEGER

readOnly

BOOLEAN

updatedAt

DATE-TIME

contacts

The contacts table contains info about individual contacts in HubSpot.

Contact properties

If properties have been set for the contact, additional fields beginning with properties__ will be included in the table. Note: Contacts will only have an entry for a property if that property has been set for the contact’s record.

HubSpot always types the value of properties fields as STRING despite the property type. Refer to HubSpot’s documentation for more info.

Replication Method

Key-based Incremental

Primary Key

canonical-vid

Replication Key

properties__lastModifiedDate__value

Useful links

HubSpot documentation

contacts schema on GitHub

HubSpot API method

associated-company

OBJECT

canonical-vid

INTEGER

form-submissions

ARRAY

conversion-id

STRING

form-id

STRING

page-url

STRING

portal-id

INTEGER

timestamp

DATE-TIME

title

STRING

identity-profiles

ARRAY

deleted-changed-timestamp

DATE-TIME

identities

ARRAY

timestamp

DATE-TIME

type

STRING

value

STRING

saved-at-timestamp

DATE-TIME

vid

INTEGER

is-contact

BOOLEAN

list-memberships

ARRAY

internal-list-id

INTEGER

is-member

BOOLEAN

static-list-id

INTEGER

timestamp

DATE-TIME

vid

INTEGER

merge-audits

ARRAY

canonical-vid

INTEGER

merged_from_email

OBJECT

selected

BOOLEAN

source-id

STRING

source-label

STRING

source-type

STRING

source-vids

ARRAY

timestamp

INTEGER

value

STRING

merged_to_email

OBJECT

selected

BOOLEAN

source-id

STRING

source-label

STRING

source-type

STRING

timestamp

INTEGER

value

STRING

num-properties-moved

INTEGER

timestamp

DATE-TIME

user-id

INTEGER

vid-to-merge

INTEGER

merged-vids

ARRAY

portal-id

INTEGER

profile-token

STRING

profile-url

STRING

vid

INTEGER

deal_pipelines

The deal_pipelines table contains info about the deal stage and pipeline properties.

Replication Method

Full Table

Primary Key

pipelineId

Useful links

HubSpot documentation

deal_pipelines schema on GitHub

HubSpot API method

active

BOOLEAN

displayOrder

INTEGER

label

STRING

pipelineId

STRING

stages

ARRAY

active

BOOLEAN

closedWon

BOOLEAN

displayOrder

INTEGER

label

STRING

probability

NUMBER

stageId

STRING

staticDefault

BOOLEAN

deals

The deals table contains info about the deals in a HubSpot portal.

Replication Method

Full Table

Primary Keys

dealId

portalId

Useful links

HubSpot documentation

deals schema on GitHub

HubSpot API method

associations

OBJECT

associatedCompanyIds

ARRAY

associatedDealIds

ARRAY

associatedVids

ARRAY

dealId

INTEGER

isDeleted

BOOLEAN

portalId

INTEGER

email_events

The email_events table contains info about email events and how recipients interact with content.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

id

Useful links

HubSpot documentation

email_events schema on GitHub

HubSpot API method

appId

INTEGER

appName

STRING

browser

OBJECT

family

STRING

name

STRING

producer

STRING

producerUrl

STRING

type

STRING

url

STRING

created

DATE-TIME

deviceType

STRING

duration

INTEGER

emailCampaignGroupId

INTEGER

emailCampaignId

INTEGER

filteredEvent

BOOLEAN

from

STRING

hmid

STRING

id

STRING

ipAddress

STRING

linkId

INTEGER

location

OBJECT

city

STRING

country

STRING

state

STRING

portalId

INTEGER

recipient

STRING

response

STRING

sentBy

OBJECT

created

DATE-TIME

id

STRING

smtpId

STRING

subject

STRING

type

STRING

url

STRING

userAgent

STRING

engagements

The engagements table contains info about all the engagements in a HubSpot portal.

Replication Method

Key-based Incremental

Primary Key

engagement_id

Replication Key

lastUpdated

Useful links

HubSpot documentation

engagements schema on GitHub

HubSpot API method

associations

OBJECT

companyIds

ARRAY

contactIds

ARRAY

dealIds

ARRAY

attachments

ARRAY

engagement

OBJECT

active

BOOLEAN

createdAt

DATE-TIME

id

INTEGER

lastUpdated

DATE-TIME

ownerId

INTEGER

portalId

INTEGER

timestamp

DATE-TIME

type

STRING

engagement_id

INTEGER

metadata

OBJECT

bcc

ARRAY

email

STRING

body

STRING

cc

ARRAY

email

STRING

disposition

STRING

durationMilliseconds

INTEGER

endTime

INTEGER

externalAccountId

STRING

externalId

STRING

forObjectType

STRING

from

OBJECT

email

STRING

firstName

STRING

lastName

STRING

fromNumber

STRING

html

STRING

recordingUrl

STRING

startTime

INTEGER

status

STRING

subject

STRING

text

STRING

title

STRING

to

ARRAY

email

STRING

toNumber

STRING

forms

The forms table contains info about your HubSpot website forms.

Replication Method

Key-based Incremental

Primary Key

guid

Replication Key

updatedAt

Useful links

HubSpot documentation

forms schema on GitHub

HubSpot API method

action

STRING

campaignGuid

STRING

captchaEnabled

BOOLEAN

cloneable

BOOLEAN

createdAt

DATE-TIME

cssClass

STRING

deletable

BOOLEAN

deletedAt

INTEGER

editable

BOOLEAN

followUpId

STRING

formFieldGroups

ARRAY

default

BOOLEAN

fields

ARRAY

defaultValue

STRING

description

STRING

displayOrder

INTEGER

enabled

BOOLEAN

fieldType

STRING

groupName

STRING

hidden

BOOLEAN

isSmartField

BOOLEAN

label

STRING

labelHidden

BOOLEAN

name

STRING

options

ARRAY

description

STRING

displayOrder

INTEGER

doubleData

NUMBER

hidden

BOOLEAN

label

STRING

readOnly

BOOLEAN

value

STRING

placeholder

STRING

required

BOOLEAN

selectedOptions

ARRAY

type

STRING

unselectedLabel

STRING

validation

OBJECT

blockedEmailAddresses

ARRAY

data

STRING

message

STRING

name

STRING

useDefaultBlockList

BOOLEAN

isSmartGroup

BOOLEAN

richText

OBJECT

content

STRING

formType

STRING

guid

STRING

ignoreCurrentValues

BOOLEAN

inlineMessage

STRING

leadNurturingCampaignId

STRING

metaData

ARRAY

name

STRING

value

STRING

method

STRING

migratedFrom

STRING

name

STRING

notifyRecipients

STRING

performableHtml

STRING

portalId

INTEGER

redirect

STRING

submitText

STRING

tmsId

STRING

updatedAt

DATE-TIME

owners

The owners table contains info about the owners that exist in your HubSpot portal. Owners are created and updated in HubSpot when new users are added or when owners are synced from Salesforce to HubSpot.

Replication Method

Key-based Incremental

Primary Keys

ownerId

portalId

Replication Key

updatedAt

Useful links

HubSpot documentation

owners schema on GitHub

HubSpot API method

createdAt

DATE-TIME

email

STRING

firstName

STRING

hasContactsAccess

BOOLEAN

lastName

STRING

ownerId

INTEGER

portalId

INTEGER

remoteList

ARRAY

active

BOOLEAN

id

INTEGER

ownerId

INTEGER

portalId

INTEGER

remoteId

STRING

remoteType

STRING

signature

STRING

type

STRING

updatedAt

DATE-TIME

subscription_changes

The subscription_changes table contains info about changes made subscriptions.

Replication Method

Key-based Incremental

Primary Keys

recipient

portalId

timestamp

Replication Key

timestamp

Useful links

HubSpot documentation

subscription_changes schema on GitHub

HubSpot API method

changes

ARRAY

causedByEvent

OBJECT

created

DATE-TIME

id

STRING

change

STRING

changeType

STRING

portalId

INTEGER

source

STRING

subscriptionId

INTEGER

timestamp

DATE-TIME

portalId

INTEGER

recipient

STRING

timestamp

DATE-TIME

workflows

The workflows table contains info about the workflows in your HubSpot portal.

Note: The workflows stream only supports contact-based workflows.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updatedAt

Useful links

HubSpot documentation

workflows schema on GitHub

HubSpot API method

contactListIds

OBJECT

active

INTEGER

enrolled

INTEGER

steps

ARRAY

enabled

BOOLEAN

id

INTEGER

insertedAt

DATE-TIME

name

STRING

personaTagIds

ARRAY

type

STRING

updatedAt

DATE-TIME


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.