Important: Version 01-03-2017 deprecation
This version of the HubSpot integration will be deprecated on November 22, 2017 and no longer be formally supported by the Stitch Support Team.
Connections created from March 1, 2017 to August 21, 2017 use this version. Upgrade to the latest version (2.0) to take advantage of the new enhancements.
HubSpot feature snapshot
A high-level look at Stitch's HubSpot (v01-03-2017) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release Status |
Released |
Supported By | |
Stitch Plan |
Paid |
Singer GitHub Repository | |
DATA SELECTION | |||
Table Selection |
Unsupported |
Column Selection |
Unsupported |
REPLICATION SETTINGS | |||
Anchor Scheduling |
Unsupported |
Advanced Scheduling |
Unsupported |
Table-level Reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
TRANSPARENCY | |||
Extraction Logs |
Unsupported |
Loading Reports |
Supported |
Connecting HubSpot
HubSpot setup requirements
To set up HubSpot in Stitch, you need:
- A paid Stitch plan. While those currently in the Free Trial will also be able to set up HubSpot, replication will be paused until a paid plan is selected after the trial ends.
Initial and historical replication jobs
After you finish setting up HubSpot, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
HubSpot table schemas
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 01-03-2017 of this integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
campaigns
Replication Method : |
Full Table |
Primary Key : |
id |
API endpoint : |
The campaigns
table contains info about the campaigns in your HubSpot account.
id
The ID of the campaign. |
||||
appId
The Application ID for the given email. |
||||
appName
The Application Name for the given email. |
||||
contentId
The ID associated with the content. |
||||
counters
Event count summaries for the given email.
|
||||
name
The name of the email. |
||||
numIncluded
The number of included emails. |
||||
numQueued
The number of queued emails. |
||||
subType
The subtype of the email. For example: |
||||
subject
The subject of the email. |
||||
type
The type of the email. For example: |
companies
Replication Method : |
Full Table |
Primary Key : |
companyId |
API endpoint : |
The companies
table contains info about the companies your HubSpot contacts belong to.
companyId
The ID of the company. |
portalId
The ID of the portal the company is associated with. |
isDeleted
Indicates if the company has been deleted in HubSpot. |
contact_lists
Replication Method : |
Key-based Incremental |
Replication Key : |
updatedAt |
Primary Key : |
listId |
API endpoint : |
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.
listId
The unique ID of the list. |
||||||||
updatedAt
The time that the list was last updated. |
||||||||
internalListId
The list’s internal list ID. This field has been deprecated by HubSpot - use |
||||||||
parentId
The ID of the folder that the list belongs to. |
||||||||
metaData
Metadata about the contact list.
|
||||||||
dynamic
Indicates if the contact list is a dynamic list. |
||||||||
name
The name of the contact list. |
||||||||
filters
A list of filters used to define list membership. For example: adding only contacts who have submitted a particular form.
|
||||||||
portalId
The ID of the portal the contact list belongs to. |
||||||||
createdAt
The time that the list was created. |
||||||||
archived
Indicates if the contact list has been archived. |
||||||||
deleteable
Indicates if the list can be deleted. If |
||||||||
listType
The type of list. For example: |
contacts
Replication Method : |
Full Table |
Primary Key : |
canonical-vid |
API endpoint : |
The contacts
table contains info about individual contacts in HubSpot.
canonical-vid
The canonical ID of the contact. In HubSpot, contacts may have multiple vids, but the canonical-vid will be the primary ID for a contact. |
|||||||||||||||||||||
vid
The internal ID of the contact. |
|||||||||||||||||||||
merged-vids
A list of vids that have been merged into this contact record.
|
|||||||||||||||||||||
portal-id
The ID of the portal the contact is associated with. |
|||||||||||||||||||||
is-contact
Indicates if the contact is a valid contact. |
|||||||||||||||||||||
profile-token
A unique token that can be used to view the contact without logging into HubSpot. |
|||||||||||||||||||||
profile-url
A unique token that can be used to view the contact without logging into HubSpot. Anyone with this URL can view (not edit) the contact’s record. |
|||||||||||||||||||||
identity-profiles
A list of the identities of the contact.
|
|||||||||||||||||||||
list-memberships
A list of the contact’s memberships in contact lists.
|
|||||||||||||||||||||
form-submissions
A list of form submissions for the contact.
|
|||||||||||||||||||||
merge-audits
Details about any merges that have happened for the record.
|
Replication Method : |
Full Table |
Primary Key : |
dealId : portalId |
API endpoint : |
The deals
table contains info about the deals in a HubSpot portal.
dealId
The ID of the deal. |
||||||
portalId
The ID of the portal the deal is associated with. |
||||||
isDeleted
Indicates if the deal has been deleted in HubSpot. |
||||||
associations
IDs of the Vids, Companies, and Deals associated with the deal.
|
email_events
Replication Method : |
Key-based Incremental |
Replication Key : |
id |
Primary Key : |
id |
API endpoint : |
The email_events
table contains info about email events and how recipients interact with content.
id
The ID of the event. |
||||||
appId
The ID of the HubSpot application that sent the email message. |
||||||
appName
The name of the HubSpot application that sent the email message. |
||||||
browser
Details about the browser that serviced the event.
|
||||||
created
The time the event was created. |
||||||
deviceType
The type of device used to service the event. |
||||||
duration
The approximate number of milliseconds the user had opened the email message. |
||||||
emailCampaignId
The ID of the email campaign that the email message is a part of. |
||||||
emailCampaignGroupId
The ID of the email campaign group associated with the email message. |
||||||
filteredEvent
Indicates if the event was filtered. |
||||||
from
The |
||||||
hmid
An auto-generated ID that corresponds to the header |
||||||
ipAddress
The IP address where the event originated. |
||||||
linkId
The ID of the link the recipient clicked in the email message. |
||||||
location
Details about where the event occurred, including the city, state, and country.
|
||||||
portalId
The ID of the HubSpot portal that sent the email message. |
||||||
recipient
The email address of the recipient of the email message. |
||||||
response
The full response from the recipient’s email server. |
||||||
sentBy
Details about the email message’s
|
||||||
smtpId
The ID that HubSpot attaches to the email message. |
||||||
subject
The subject line of the email message. |
||||||
type
The type of event. Click the link in attribute’s name for more details about email event types. |
||||||
url
The URL in the email message that the recipient clicked. |
||||||
userAgent
The user agent responsible for the event. |
engagements
Replication Method : |
Key-based Incremental |
Replication Key : |
lastUpdated |
Primary Key : |
id |
API endpoint : |
The engagements
table contains info about all the engagements in a HubSpot portal.
id
The ID for the engagement. |
|||||||||||||||||||||||||
lastUpdated
The time the engagement was last updated. |
|||||||||||||||||||||||||
portalId
The ID of the portal the engagement belongs to. |
|||||||||||||||||||||||||
active
Indicates if the engagement is active. |
|||||||||||||||||||||||||
createdAt
The time the engagement was created. |
|||||||||||||||||||||||||
ownerId
The ID of the owner associated with the engagement. |
|||||||||||||||||||||||||
type
The type of engagement. For example: |
|||||||||||||||||||||||||
timestamp
The time the engagement should appear in the timeline. |
|||||||||||||||||||||||||
associations
IDs of the objects associated with the engagement. For example: contacts, deals.
|
|||||||||||||||||||||||||
attachments
For
|
|||||||||||||||||||||||||
metadata
Metadata about the engagement.
|
Replication Method : |
Key-based Incremental |
Replication Key : |
updatedAt |
Primary Key : |
guid |
API endpoint : |
The forms
table contains info about your HubSpot website forms.
guid
The GUID of the form. |
|||||||||||||||||||||||||||||||||||
updatedAt
The time the form was last updated. |
|||||||||||||||||||||||||||||||||||
deletedAt
If the form was deleted, the time that the deletion took place. |
|||||||||||||||||||||||||||||||||||
portalId
The ID of the portal the form belongs to. |
|||||||||||||||||||||||||||||||||||
name
The name of the form. |
|||||||||||||||||||||||||||||||||||
action
Deprecated by HubSpot. |
|||||||||||||||||||||||||||||||||||
method
The API method used to send the form submission. For example: |
|||||||||||||||||||||||||||||||||||
cssClass
The CSS class associated with the form. |
|||||||||||||||||||||||||||||||||||
redirect
The URL that the visitor will be redirect to after filling out the form. |
|||||||||||||||||||||||||||||||||||
submitText
The text that displays to the end-user to submit the form. For example: |
|||||||||||||||||||||||||||||||||||
followUpId
Deprecated by HubSpot. |
|||||||||||||||||||||||||||||||||||
notifyRecipients
A list of email addresses that should receive submission notifications. |
|||||||||||||||||||||||||||||||||||
leadNurturingCampaignId
The ID of the lead nurturing campaign the form is associated with. |
|||||||||||||||||||||||||||||||||||
formFieldGroups
Details about the fields in the form.
|
|||||||||||||||||||||||||||||||||||
createdAt
The time the form was created. |
|||||||||||||||||||||||||||||||||||
performableHtml
Deprecated by HubSpot. |
|||||||||||||||||||||||||||||||||||
migratedFrom
Deprecated by HubSpot. |
|||||||||||||||||||||||||||||||||||
ignoreCurrentValues
Indicates if the form will pre-populate fields with known values for known contacts. |
|||||||||||||||||||||||||||||||||||
deleteable
Indicates if the form is deleteable. |
|||||||||||||||||||||||||||||||||||
inlineMessage
The ‘thank you’ message that displays on the page after the form is submitted. |
|||||||||||||||||||||||||||||||||||
tmsId
Deprecated by HubSpot. |
|||||||||||||||||||||||||||||||||||
captchaEnabled
Indicates if a Captcha is enabled on the form. |
|||||||||||||||||||||||||||||||||||
campaignGuid
The GUID of the campaign the form is associated with. |
|||||||||||||||||||||||||||||||||||
cloneable
Indicates if the form is cloneable. |
|||||||||||||||||||||||||||||||||||
editable
Indicates if the form is editable. |
|||||||||||||||||||||||||||||||||||
formType
The type of form. For example: |
|||||||||||||||||||||||||||||||||||
metaData
Metadata about the form.
|
keywords
Replication Method : |
Key-based Incremental |
Replication Key : |
created_at |
Primary Key : |
keyword_guid |
API endpoint : |
The keywords
table contains info about your HubSpot portal keywords.
keyword_guid
The GUID of the keyword. |
created_at
The time the keyword was created. |
keyword
The text value of the keyword. |
country
If the keyword is localized, this column will contain the selected country’s ID. |
visits
The number of visits attributed to the keyword. |
contacts
The number of contacts attributed to the keyword. |
leads
The number of leads attributed to the keyword. |
owners
Replication Method : |
Key-based Incremental |
Replication Key : |
updatedAt |
Primary Key : |
ownerId : portalId |
API endpoint : |
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.
ownerId
The ID of the owner. |
|||||
portalId
The ID of the portal the owner is associated with. |
|||||
updatedAt
The time that the owner was last updated in HubSpot. |
|||||
type
The type of owner. For example: |
|||||
firstName
The first name of the owner. |
|||||
lastName
The last name of the owner. |
|||||
email
The email address associated with the owner. |
|||||
createdAt
The time that the owner was created in HubSpot. |
|||||
remoteList
Details about the remote list associated with the owner.
|
subscription_changes
Replication Method : |
Key-based Incremental |
Replication Key : |
timestamp |
Primary Key : |
recipient : portalId : timestamp |
API endpoint : |
The subscription_changes
table contains info about changes made subscriptions.
recipient
The contact associated with the subscription change event. |
|||||||||
portalId
The ID of the portal associated with the subscription change event. |
|||||||||
timestamp
The time that the subscription change event occurred. |
|||||||||
changes
Details about the subscription change event.
|
workflows
Replication Method : |
Key-based Incremental |
Replication Key : |
updatedAt |
Primary Key : |
id |
API endpoint : |
The workflows
table contains info about the workflows in your HubSpot portal.
id
The ID of the workflow. |
||||
updatedAt
The time that the workflow was last updated. |
||||
name
The name of the workflow. |
||||
type
The type of workflow. For example: |
||||
enabled
Indicates if the workflow is enabled in your HubSpot portal. |
||||
inserted-at
The time that the workflow was inserted. |
||||
personaTagIds
Info about the personas tied to the workflow.
|
||||
contactListIds
Summary info for the contact lists associated with the workflow.
|
Related | Troubleshooting |
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.