- About Hevo
- Hevo Features
- Hevo System Architecture
- Core Concepts
- Free Trials
- Regulatory Compliance
- Scheduling a Demo
- Hevo Support
- General FAQs
- Getting Started
- Creating an Account in Hevo
- Connecting Through SSH
- Connecting Through Reverse SSH Tunnel
- Using Google Account Authentication
- How Hevo Authenticates Sources and Destinations using OAuth
- Reauthorizing an OAuth Account
- Familiarizing with the UI
- Creating your First Pipeline
- Data Loss Prevention and Recovery
- Data Ingestion
- Types of Data Synchronization
- Ingestion Modes and Query Modes for Database Sources
- Ingestion and Loading Frequency
- Data Ingestion Statuses
- Deferred Data Ingestion
- Handling of Primary Keys
- Handling of Updates
- Handling of Deletes
- Hevo-generated Metadata
- Data Loading
- Loading Data in a Database Destination
- Loading Data to a Data Warehouse
- Optimizing Data Loading for a Destination Warehouse
- Manually Triggering the Loading of Events
- Scheduling Data Load for a Destination
- Loading Events in Batches
- Data Loading Statuses
- Data Spike Alerts
- Name Sanitization
- Table and Column Name Compression
- Parsing Nested JSON Fields in Events
- Data Flow in a Pipeline
- Familiarizing with the Pipelines UI
Working with Pipelines
- Best Practices for Creating Database Pipelines
- Creating a Pipeline
- Connectivity Check for RDBMS Sources
- Scheduling a Pipeline
- Modifying a Pipeline
- Prioritizing a Pipeline
- Viewing Pipeline Progress
- Pausing and Deleting a Pipeline
- Log-based Pipelines
- Troubleshooting Data Replication Errors
- Managing Objects in Pipelines
Python Code-Based Transformations
- Supported Python Modules and Functions
Transformation Methods in the Event Class
- Create an Event
- Retrieve the Event Name
- Rename an Event
- Retrieve the Properties of an Event
- Modify the Properties for an Event
- Fetch the Primary Keys of an Event
- Modify the Primary Keys of an Event
- Fetch the Data Type of a Field
- Check if the Field is a String
- Check if the Field is a Number
- Check if the Field is Boolean
- Check if the Field is a Date
- Check if the Field is a Time Value
- Check if the Field is a Timestamp
- Convert Date String to Required Format
- Convert Date to Required Format
- Convert Datetime String to Required Format
- Convert Epoch Time to a Date
- Convert Epoch Time to a Datetime
- Convert Epoch to Required Format
- Convert Epoch to a Time
- Get Time Difference
- Parse Date String to Date
- Parse Date String to Datetime Format
- Parse Date String to Time
- Examples of Python Code-based Transformations
Drag and Drop Transformations
- Special Keywords
Transformation Blocks and Properties
- Add a Field
- Change Datetime Field Values
- Change Field Values
- Drop Events
- Drop Fields
- Find & Replace
- Flatten JSON
- Format Date to String
- Format Number to String
- Hash Fields
- Mask Fields
- Modify Text Casing
- Parse Date from String
- Parse JSON from String
- Parse Number from String
- Rename Events
- Rename Fields
- Round-off Decimal Fields
- Split Fields
- Examples of Drag and Drop Transformations
- Effect of Transformations on the Destination Table Structure
- Transformation Reference
- Transformation FAQs
- Python Code-Based Transformations
- Using Schema Mapper
- Mapping Statuses
- Auto Mapping Event Types
- Manually Mapping Event Types
- Modifying Schema Mapping for Event Types
- Schema Mapper Actions
- Fixing Unmapped Fields
- Resolving Incompatible Schema Mappings
- Resizing String Columns in the Destination
- Schema Mapper Compatibility Table
- Limits on the Number of Destination Columns
- File Log
- Troubleshooting Failed Events in a Pipeline
- Mismatch in Events Count in Source and Destination
- Activity Log
- Can multiple Sources connect to one Destination?
- What happens if I re-create a deleted Pipeline?
- Why is there a delay in my Pipeline?
- Can I change the Destination post-Pipeline creation?
- Why is my billable Events high with Delta Timestamp mode?
- Can I drop multiple Destination tables in a Pipeline at once?
- How does Run Now affect scheduled ingestion frequency?
- Will pausing some objects increase the ingestion speed?
- Can I see the historical load progress?
- Why is my Historical Load Progress still at 0%?
- Why is historical data not getting ingested?
- How do I set a field as a primary key?
- How do I ensure that records are loaded only once?
- Events Usage
- Free Sources
Databases and File Systems
- Data Warehouses
- Connecting to a Local Database
- Amazon DocumentDB
- Amazon DynamoDB
- Generic MongoDB
- MongoDB Atlas
- Support for Multiple Data Types for the _id Field
- Example - Merge Collections Feature
Errors During Pipeline Creation
- Error 1001 - Incorrect credentials
- Error 1005 - Connection timeout
- Error 1006 - Invalid database hostname
- Error 1007 - SSH connection failed
- Error 1008 - Database unreachable
- Error 1011 - Insufficient access
- Error 1028 - Primary/Master host needed for OpLog
- Error 1029 - Version not supported for Change Streams
- SSL 1009 - SSL Connection Failure
- Troubleshooting MongoDB Change Streams Connection
- Troubleshooting MongoDB OpLog Connection
- Errors During Pipeline Creation
- Amazon RDS SQL Server
- Azure SQL Server
- Google Cloud SQL Server
- Generic SQL Server
- Troubleshooting SQL Server
- SQL Server FAQs
- Amazon Aurora MySQL
- Amazon RDS MySQL
- Azure MySQL
- Google Cloud MySQL
- Generic MySQL
- MariaDB MySQL
Errors During Pipeline Creation
- Error 1003 - Connection to host failed
- Error 1006 - Connection to host failed
- Error 1007 - SSH connection failed
- Error 1011 - Access denied
- Error 1012 - Replication access denied
- Error 1017 - Connection to host failed
- Error 1026 - Failed to connect to database
- Error 1027 - Unsupported BinLog format
- Failed to determine binlog filename/position
- Schema 'xyz' is not tracked via bin logs
- Errors Post-Pipeline Creation
- Errors During Pipeline Creation
- MySQL FAQs
- Amazon Aurora PostgreSQL
- Amazon RDS PostgreSQL
- Azure PostgreSQL
- Google Cloud PostgreSQL
- Generic PostgreSQL
- Heroku PostgreSQL
Errors during Pipeline creation
- Error 1003 - Authentication failure
- Error 1006 - Connection settings errors
- Error 1011 - Access role issue for logical replication
- Error 1012 - Access role issue for logical replication
- Error 1014 - Database does not exist
- Error 1017 - Connection settings errors
- Error 1023 - No pg_hba.conf entry
- Error 1024 - Number of requested standby connections
- Errors Post-Pipeline Creation
- Errors during Pipeline creation
- PostgreSQL FAQs
- Troubleshooting Database Sources
- Amazon S3
- Azure Blob Storage
- FTP / SFTP
- Google Cloud Storage (GCS)
- Google Drive
- Google Sheets
- Android SDK
- Writing JSONPath Expressions
REST API FAQs
- Why does my REST API token keep changing?
- Can I use a bearer authorization token for authentication?
- Does Hevo’s REST API support API chaining?
- What is the maximum payload size returned by a REST API?
- How do I split an Event into multiple Event Types?
- How do I split multiple values in a key into separate Events?
- Jira Cloud
- QuickBooks Time
- Finance & Accounting Analytics
- Amazon Ads
- Apple Search Ads
- Facebook Ads
- Facebook Page Insights
- Firebase Analytics
- Google Ads
- Google Analytics
- Google Analytics 4
- Google Analytics 360
- Google Play Console
- Google Search Console
- Instagram Business
- LinkedIn Ads
- Microsoft Ads
- Pinterest Ads
- SendGrid Webhook
- Salesforce Marketing Cloud
- Snapchat Ads
- TikTok Ads
- Twitter Ads
- YouTube Analytics
- Product Analytics
Sales & Support Analytics
- Help Scout
- Hub Planner
- Salesforce Bulk API V2
- Toggl Track
- From how far back can the Pipeline ingest data?
- Can I connect to a Source not listed in Hevo?
- Can I connect a local database as a Source?
- How can I push data to Hevo API?
- How do I connect a CSV file as a Source?
- Why are my selected Source objects not visible in the Schema Mapper?
- How does the Merge Table feature work?
- Familiarizing with the Destinations UI
- Amazon Aurora MySQL
- SQL Server
- Connecting to a Local Database
- Limitations of using MySQL as a Destination
- Structure of Data in the Amazon Redshift Data Warehouse
- Loading Data to an Amazon Redshift Data Warehouse
- Troubleshooting Amazon Redshift Destination
- Amazon Redshift FAQs
- Azure Synapse Analytics
- Clustering in BigQuery
- Partitioning in BigQuery
- Structure of Data in the Google BigQuery Data Warehouse
- Loading Data to a Google BigQuery Data Warehouse
- Near Real-time Data Loading using Streaming
- Troubleshooting Google BigQuery
- Google BigQuery FAQs
- Hevo Managed Google BigQuery
- Structure of Data in the Snowflake Data Warehouse
- Loading Data to a Snowflake Data Warehouse
- Troubleshooting Snowflake
- Snowflake FAQs
- Amazon Redshift
- Can I move data between SaaS applications using Hevo?
- Can I change the primary key in my Destination table?
- How do I change the data type of table columns?
- Can I change the Destination table name after creating the Pipeline?
- How can I change or delete the Destination table prefix?
- How do I resolve duplicate records in the Destination table?
- How do I enable or disable deduplication of records?
- Why does my Destination have deleted Source records?
- How do I filter deleted Events from the Destination?
- Does a data load regenerate deleted Hevo metadata columns?
- Can I load data to a specific Destination table?
- How do I filter out specific fields before loading data?
- How do I sort the data in the Destination?
- dbt™ Models
- Familiarizing with the Models UI
- Types of Models
- Key Features
- Working with SQL Models
- Previewing a Model
- Viewing the Query History
- Legacy Models
- Models FAQs
- Account Management
- Personal Settings
- Team Settings
- Pricing Plans
- Time-based Events Buffer
- Setting up Pricing Plans, Billing, and Payments
- On-Demand Purchases
- Billing Alerts
- Viewing Billing History
- Billing Notifications
- Can I get a plan apart from the Starter plan?
- Are free trial Events charged once I purchase a plan?
- For how long can I stay on the Free plan?
- How can I upgrade my plan?
- Is there a discount for non-profit organizations?
- Can I seek a refund of my payment?
- Do ingested Events count towards billing?
- Will Pipeline get paused if I exceed the Events quota?
- Will the initial load of data be free?
- Does the Hevo plan support multiple Destinations?
- Do rows loaded through Models count in my usage?
- Is Hevo subscription environment-specific?
- Can I pause billing if I have no active Pipelines?
- Can you explain the pricing plans in Hevo?
- Where do I get invoices for payments?
- Account Suspension and Restoration
- Account Management FAQs
- Activate Concepts
- Familiarizing with the Activate UI
- Working with Activate
- Activate Warehouses
- Activate Targets
- Release Notes
- Release Version 2.18
- Release Version 2.17
- Release Version 2.16
- Release Version 2.15
- Release Version 2.14
- Release Version 2.13
- Release Version 2.12
- Release Version 2.11
- Release Version 2.10
- Release Version 2.09
- Release Version 2.08
- Release Version 2.07
- Release Version 2.06
- Release Version 2.05
- Release Version 2.04
- Release Version 2.03
- Release Version 2.02
- Release Version 2.01
- Release Version 2.00
- Release Version 1.99
- Release Version 1.98
- Release Version 1.97
- Release Version 1.96
- Release Version 1.95
- Release Version 1.93 & 1.94
- Release Version 1.92
- Release Version 1.91
- Release Version 1.90
- Release Version 1.89
- Release Version 1.88
- Release Version 1.87
- Release Version 1.86
- Release Version 1.84 & 1.85
- Release Version 1.83
- Release Version 1.82
- Release Version 1.81
- Release Version 1.80 (Jan-24-2022)
- Release Version 1.79 (Jan-03-2022)
- Release Version 1.78 (Dec-20-2021)
- Release Version 1.77 (Dec-06-2021)
- Release Version 1.76 (Nov-22-2021)
- Release Version 1.75 (Nov-09-2021)
- Release Version 1.74 (Oct-25-2021)
- Release Version 1.73 (Oct-04-2021)
- Release Version 1.72 (Sep-20-2021)
- Release Version 1.71 (Sep-09-2021)
- Release Version 1.70 (Aug-23-2021)
- Release Version 1.69 (Aug-09-2021)
- Release Version 1.68 (Jul-26-2021)
- Release Version 1.67 (Jul-12-2021)
- Release Version 1.66 (Jun-28-2021)
- Release Version 1.65 (Jun-14-2021)
- Release Version 1.64 (Jun-01-2021)
- Release Version 1.63 (May-19-2021)
- Release Version 1.62 (May-05-2021)
- Release Version 1.61 (Apr-20-2021)
- Release Version 1.60 (Apr-06-2021)
- Release Version 1.59 (Mar-23-2021)
- Release Version 1.58 (Mar-09-2021)
- Release Version 1.57 (Feb-22-2021)
- Release Version 1.56 (Feb-09-2021)
- Release Version 1.55 (Jan-25-2021)
- Release Version 1.54 (Jan-12-2021)
- Release Version 1.53 (Dec-22-2020)
- Release Version 1.52 (Dec-03-2020)
- Release Version 1.51 (Nov-10-2020)
- Release Version 1.50 (Oct-19-2020)
- Release Version 1.49 (Sep-28-2020)
- Release Version 1.48 (Sep-01-2020)
- Release Version 1.47 (Aug-06-2020)
- Release Version 1.46 (Jul-21-2020)
- Release Version 1.45 (Jul-02-2020)
- Release Version 1.44 (Jun-11-2020)
- Release Version 1.43 (May-15-2020)
- Release Version 1.42 (Apr-30-2020)
- Release Version 1.41 (Apr-2020)
- Release Version 1.40 (Mar-2020)
- Release Version 1.39 (Feb-2020)
- Release Version 1.38 (Jan-2020)
- Upcoming Features
HubSpot is a system for managing customer relationships and storing data. You can use Hevo Pipelines to replicate data from your HubSpot account to the Destination database or data warehouse using HubSpot REST API.
You can use Open Authorization (OAuth) to authenticate your HubSpot account with Hevo.
For creating Pipelines using this Source, Hevo provides you a fully managed BigQuery data warehouse as a possible Destination. This option remains available till the time you set up your first BigQuery Destination irrespective of any other Destinations that you may have. With the managed warehouse, you are only charged the cost that Hevo incurs for your project in Google BigQuery. The invoice is generated at the end of each month and payment is recovered as per the payment instrument you have set up. You can now create your Pipeline and directly start analyzing your Source data. Read Hevo Managed Google BigQuery.
An active HubSpot account from which data is to be ingested exists.
The following permissions in HubSpot to configure a HubSpot account in Hevo:
Administrator: To replicate CRM and Marketing objects.
Super Admin: To replicate Email Events.
Sales Administrator: To replicate Sales objects.
Read more about HubSpot user permissions at HubSpot Knowledge Base.
Configuring HubSpot as a Source
Perform the following steps to configure HubSpot as the Source in your Pipeline:
Click PIPELINES in the Navigation Bar.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select HubSpot.
In the Configure your HubSpot Account page, do one of the following:
Select a previously configured account and click CONTINUE.
Click + ADD HUBSPOT ACCOUNT and perform the following steps to configure an account:
Log in to your HubSpot account.
In the HubSpot Accounts page, select the HubSpot account whose data you would like to synchronize.
Authorize Hevo Data Inc to access your HubSpot data.
In the Configure your HubSpot Source page, specify the following:
Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.
Authorized Account (Non-editable): This field is pre-filled with the email address that you selected earlier when connecting to your HubSpot account.
HubSpot API Version: The API version that you want to use to ingest data from the Source. Default value: API v3.
Historical Sync Duration: The duration for which you want to ingest the existing data from the Source. Default duration: 3 Months.
Note: If you select All Available Data, Hevo ingests all the data available in your HubSpot account since January 01, 1970.
Proceed to configuring the data ingestion and setting up the Destination.
|Default Pipeline Frequency||Minimum Pipeline Frequency||Maximum Pipeline Frequency||Custom Frequency Range (Hrs)|
|1 Hr||30 Mins||24 Hrs||1-24|
Note: The custom frequency must be set in hours, as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.
Historical Data: The first run of the Pipeline ingests historical data for the selected objects on the basis of the historical sync duration specified at the time of creating the Pipeline and loads it to the Destination. Default duration: 3 Months
Incremental Data: Once the historical load is complete, new and updated records for all objects except Owners and Email Campaigns are synchronized with your Destination as per the ingestion frequency.
Hevo synchronizes the archived records for all the standard objects in Hubspot. For any archived record fetched from your Hubspot data, the
is_archived flag is set to TRUE in the Destination.
The ingestion of archived Events is not coupled with the scheduled Pipeline runs due to the Source consideration around the handling of deletes. To reduce the number of Events being ingested during each Pipeline run, the ingestion frequency for deleted Events is set to 24 Hours. You can change this by reaching out to Hevo Support.
In HubSpot, whenever two or more objects are merged, a third object with the merged properties is created. The merged objects do not get picked up during ingestion. When Hevo loads this third object to the Destination, it also adds the following fields to the older objects to identify them as merged:
||boolean||Contains the merged status of an object. It is set to TRUE only if the object is merged with another.|
||long||Contains the ID of the new object which it has been merged into.|
Using these fields, you can identify the stale data, if any, in the Destination.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination:
Note: Effective Release 2.16, in Pipelines created with JDBC-based Destinations, Hevo creates the Destination schema based on the data retrieved from HubSpot. As a result, only fields that contain data are created in Destination tables, and the column limit is not exceeded.
Hevo supports two API versions for ingesting data from HubSpot, v3 API and legacy API (v1 and v2). Depending on the API version you select, Hevo creates the following tables (objects) in the Destination when you run the Pipeline:
For Pipelines created from Release 1.98 onwards: Hevo supports the data ingestion of custom objects and their associations. However, to ingest the data for associations, you need to contact Hevo Support.
Effective Aug 31, 2023, HubSpot will stop supporting the Calendar Events object. As a result, Hevo will stop replicating data for the same.
HubSpot Legacy API
|Calendar Events||Contains details of the events, such as meetings and appointments, in your HubSpot account.|
|Contacts||Contains details about an individual person.|
|Contact Deal Association||Contains details about the mapping between a contact and all deals associated with it.|
|Contact List||Contains the lists of all the contacts in your HubSpot account, grouped by membership.|
|Companies||Contains details about an individual business or organization.|
|Custom Objects||Contains details about custom objects created in the HubSpot portal for specific business requirements. These are tied to the HubSpot account.|
|Deals||Contains details about an ongoing transaction associated with a contact or company. The progress of these deals is tracked till their conclusion.|
|Deal Company Association||Contains details about the mapping between a company and all the deals associated with it.|
|Deal Stage Pipeline||Contains details about the current progress of a deal.|
|Deal Line Item Association||Contains details about the mapping between a deal and all the product line items associated with it.|
|Email Events||Contains details about the Events generated by marketing emails or email campaigns sent through a HubSpot account.|
|Email Campaigns||Contains details such as the subject line of an email message, HubSpot application name, event type, activity status, and time of the last update for an email campaign.|
|Engagements||Contains details generated from CRM actions, such as notes, tasks, emails, meetings, and calls.
At a minimum, engagements should be associated with at least one CRM record.
|Engagement Contact Association||Contains details about the mapping between a contact and all the engagements associated with it.|
|Engagement Company Association||Contains details about the mapping between a company and all engagements associated with it.|
|Engagement Deal Association||Contains details about the mapping between a deal and all engagements associated with it.|
|Form Submissions||Contains details about the fields in the submissions, the time of the form submission, and the page URL that the form was submitted on.|
|Owners||Contains details about the mapping between users and contacts, companies, deals, tickets, or engagements.|
|Products||Contains details of the goods or services for sale that are configured in your HubSpot account.|
|Line Items||Contains details about the line item-level data associated with each product.|
|Tickets||Contains details about the customer requests raised for help or support.|
|Ticket Stage Pipeline||Contains details about the current stage of a ticket.|
HubSpot v3 API
As part of the latest API version in HubSpot, Hevo ingests the following tables (objects) in the Destination using HubSpot v3 API.
Note: If v3 API is selected while configuring your Source, Hevo ingests all the objects supported by both legacy and v3 API. The v3 objects are identified by the suffix
|Engagement Call||Contains details of all the calls made to the contacts in your HubSpot account.|
|Engagement Email||Contains details of all the email interactions between a user and a contact in your HubSpot account.|
|Engagement Meeting||Contains details of all the meetings that have been scheduled and managed in your HubSpot account. It includes meeting dates, participants, locations, agendas, and any additional relevant data related to the meetings.|
|Engagement Note||Contains details of the information captured for the interaction or communication with a contact.|
|Engagement Task||Contains details of the tasks assigned to a user in your Hubspot account. These tasks may include calls, emails, descriptions and relevant details.|
|Engagement Postal Mail||Contains details of the mail communications that a user has created and sent through HubSpot.
It allows users to manage offline communications with contacts and track their interactions.
|Engagement Communications||Contains details of the interactions between a user and a contact via third-party channels, such as WhatsApp and LinkedIn.|
HubSpot does not allow fetching deleted records based on a timestamp. While this can lead to a higher number of ingested Events, Hevo deduplicates such Events upon ingestion. Only the Events that were deleted after the last run of the Pipeline (based on the
archived_attimestamp) count as new Events and are treated as billable.
Due to an open issue with Hubspot relating to the
Contactsobject, the exact time at which a contact was deleted or archived cannot be determined. For the
archived_at timestamp, the HubSpot API returns the last
updated_attimestamp instead of the actual deletion/archival time. Due to this, the last tracked deletion of
Contactsdata cannot be definitively identified, and Hevo must ingest all the deleted contacts and de-duplicate them while loading to the Destination. Therefore, it is always a full load of archived
Contactsdata, and these Events are included in your billable Events count.
Hevo supports only the CRM API v3 to fetch HubSpot data. If any object or record does not support v3 endpoint such as
Form, Hevo uses the legacy API to fetch or synchronize data with the Destination.
Note: Refer the HubSpot API Docs to identify the API associated with the objects you want to ingest.
HubSpot CRM API returns the updates for up to 10,000 records for the same modified timestamp. If other records are updated at that particular point of time, they are not reflected or synchronized with the Destination.
Refer to the following table for the list of key updates made to this page:
|Date||Release||Description of Change|
|Sep-04-2023||NA||Updated the note in the Schema and Primary Keys section to state that the Destination schema for Pipelines with JDBC Destinations is derived from the Source data.|
- Configuring HubSpot as a Source to add information about HubSpot API version option.
- Data Model with the latest list of objects and their respective descriptions.
|Jul-20-2023||NA||Updated section, Data Model to add information about HubSpot deprecating an object.|
|Apr-25-2023||2.12||Updated section, Data Model to add a note regarding the ingestion of custom object associations.|
|Apr-04-2023||NA||Updated section, Configuring HubSpot as a Source to update the information about historical sync duration.|
|Jan-10-2023||2.05||Updated section, Data Model to include information about the new object supported by Hevo.|
|Nov-07-2022||NA||Updated section, Data Model for more clarity and detail.|
|Sep-21-2022||1.98||Updated sections, Data Model and Source Considerations to include information about custom objects.|
|Sep-05-2022||NA||- Updated section, Data Replication to restructure the content for better understanding and coherence.
- Updated section, Configuring HubSpot as a Source to reflect the latest UI changes.
|Apr-25-2022||1.87||Updated section, Limitations about Hevo using the CRM API v3 to fetch HubSpot data.|
|Nov-22-2021||1.76||In the Data Model section:
- Added the
- Changed the description for the
- Added a note to indicate that
|Oct-25-2021||1.74||- Updated the page overview.
- Added the section, Source Considerations.
- Added information about handling of deleted records and the available Pipeline frequencies in the Data Replication section.
|Aug-09-2021||1.69||Added a note in the Data Replication section about archived objects ingested from the Source.|
|Jul-12-2021||1.67||Updated the Data Model section with additional objects that Hevo now supports.|