- About Hevo
- Hevo Features
- Hevo System Architecture
- Core Concepts
- Free Trials
- Regulatory Compliance
- Hevo Support
- General FAQs
- Getting Started
- Creating an Account in Hevo
- Connection Options
- Familiarizing with the UI
- Creating your First Pipeline
- Data Loss Prevention and Recovery
- Activity Log
- Data Ingestion
- Ingestion Modes and Query Modes
- Types of Data Synchronization
- Ingestion and Loading Frequency
- Ingestion Frequency and Data Synchronization
- 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
- Scheduling a Pipeline
- Modifying a Pipeline
- Prioritizing a Pipeline
- Viewing Pipeline Progress
- Troubleshooting Data Replication Errors
- Pausing and Deleting a Pipeline
- Log-based Pipelines
- Pipeline Objects
- 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
- Using Schema Mapper
- Mapping Statuses
- Auto Mapping Event Types
- Mapping a Source Event Type with a Destination Table
- Mapping a Source Event Type Field with a Destination Table Column
- Schema Mapper Actions
- Fixing Unmapped Fields
- Resolving Incompatible Schema Mappings
- Resizing String Columns in the Destination
- Schema Mapper Compatibility Table
- Troubleshooting Failed Events in a Pipeline
- Mismatch in Events Count in Source and Destination
- Does creation of Pipeline incur cost?
- Can I have the same Source and Destination in the Pipeline?
- Why are my new Pipelines in trial?
- Can multiple Sources connect to one Destination?
- Is my data stored after I delete a Pipeline?
- What happens if I re-create a deleted Pipeline?
- When should I pause vs delete my Pipeline?
- Why am I getting warnings while adding Pipelines?
- Why is there a delay in my Pipeline?
- Can I delete skipped objects in a Pipeline?
- How do I disable Auto Mapping?
- How do I change the ingestion frequency for tables?
- How do I change the query mode for Pipelines?
- How does changing the query mode affect data ingestion?
- Why is my billable Events high with Delta Timestamp mode?
- How does the timing of Change Schedule work?
- 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 sort Event Types listed in the Schema Mapper?
- How do I include new tables in the Pipeline?
- Can I see the historical load progress?
- Why is my Historical Load Progress still at 0%?
- Why is the historical data not getting ingested?
- How do I restart the historical load for all the objects?
- How do I set a field as a primary key?
- How can I load only filtered Events to the Destination?
- How do I ensure that records are loaded only once?
- Why do the Source and the Destination events count differ?
- How can I transfer Excel files using Hevo?
- How can I load an XML file from an S3 folder?
- 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 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
- Heroku PostgreSQL
- Generic 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
- File Log
- 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?
- Is it possible to use a Bearer Authorization token?
- 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
- Finance & Accounting Analytics
- Apple Search Ads
- Facebook Ads
- Facebook Page Insights
- Google Campaign Manager
- Google Ads
- Google Analytics
- Google Analytics 4
- Google Analytics 360
- Google Play Console
- Google Search Console
- Instagram Business
- LinkedIn Ads
- Microsoft Advertising
- Pinterest Ads
- SendGrid Webhook
- Salesforce Marketing Cloud
- Snapchat Ads
- TikTok Ads
- Twitter Ads
- YouTube Analytics
- Product Analytics
- Sales & Support Analytics
- From how far back can the Pipeline ingest data?
- What is a free Source?
- Why am I unable to modify my OAuth Source connection settings?
- Can I connect to a Source not listed in Hevo?
- Can I connect a local database as a Source?
- How do I connect a CSV file as a Source?
- Which file formats are supported by file storage-based Sources?
- How does the Merge Table feature work?
- Familiarizing with the Destinations UI
- Amazon Aurora MySQL
- Microsoft SQL Server
- Connecting to a Local Database
- Structure of Data in the Amazon Redshift Data Warehouse
- Loading Data to an Amazon Redshift Data Warehouse
- Troubleshooting Amazon Redshift Destination
- Amazon Redshift FAQs
- Hevo Managed Google BigQuery
- Clustering in BigQuery
- Partitioning in BigQuery
- Loading Data to a Google BigQuery Data Warehouse
- Near Real-time Data Loading using Streaming
- Troubleshooting Google BigQuery
- Google BigQuery FAQs
- Structure of Data in the Snowflake Data Warehouse
- Loading Data to a Snowflake Data Warehouse
- Troubleshooting Snowflake
- Snowflake FAQs
- Amazon Redshift
- Can I create a Destination through API?
- 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?
- Activate Concepts
- Familiarizing with the Activate UI
- Working with Activate
- Activate Warehouses
- Activate Targets
- 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 try Hevo for free?
- 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?
- When will I be charged for my subscription?
- 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?
- What is a free Source?
- 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?
- What are the payment methods available in Hevo?
- Can you explain the pricing plans in Hevo?
- Where do I get invoices for payments?
- Is my billing information removed upon account deletion?
- Account Suspension and Restoration
- Account Management FAQs
- Release Notes
- 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
Front is a customer communication hub that connects all communication channels such as email, SMS, WhatsApp, social media, and live chat to your team’s inbox. Front also allows you to share knowledge and collaborate in real-time on critical customer messages to provide the best response possible.
Hevo uses Front’s Core API to replicate the data present in your Front account to the desired Destination database or data warehouse for scalable analysis.
An active Front account from which the data is to be ingested.
An API Token to allow Hevo to connect to your Front account.
Creating the API Key and Secret
In the Front dashboard, in the top right, click Settings(gear icon).
In the left navigation pane, click Plugins & API.
In the Plugins page, click API.
In the page displayed, under the Front Tokens section, click New Token to generate your token.
In the Create Token page, specify the following:
NAME: A name for your API token.
Scopes: The API permissions needed by Hevo to access your data. To select the scopes, do the following:
- Click Select scopes, and select the required scopes from the drop-down.
Read Token permission scopes to know more about scopes.
Once you create the token, in the page displayed, under the Front Tokens section, click on your token to see its details.
In the Edit Token page, hover over the TOKEN field, and click Copy to use the token in Hevo to configure Front as a Source.
Configuring Front as a Source
Perform the following steps to configure Front as the Source in your Pipeline:
Click PIPELINES in the Asset Palette.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select Front.
In the Configure your Front Source page, specify the following:
Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.
API Token: The API token that you created in your Front account, to enable Hevo to read data.
Historical Sync Duration: The duration for which the existing data in the Source must be ingested. Default duration: 3 Months.
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.
|Default Pipeline Frequency||Minimum Pipeline Frequency||Maximum Pipeline Frequency||Custom Frequency Range (Hrs)|
|5 Mins||5 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: In the first run of the Pipeline, Hevo ingests historical data for all the objects on the basis of the historical sync duration selected at the time of creating the Pipeline and loads it to the Destination. Historical load parallelization is applicable for this Source. Default duration: 3 Months
Incremental Data: Once the historical load is complete, all new and updated records are synchronized with your Destination as per the ingestion frequency.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination database:
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
|Attachments||Contains the files attached in a conversation.|
|Channel||Contains the details about the channels in your Front account. A channel is a resource which can send and receive messages.|
|Comments||Contains the list of comments in your Front account. A comment is a private message written by a teammate, visible only to the other teammates.|
|Comment Mentions||Contains the details of the teammates mentioned in a comment.|
|Contacts||Contains details about an individual person.|
|Contacts||Contains the details of a person or entity with whom you have communicated.|
|Contact Groups||Contains the details of the groups a contact belongs to.|
|Contact Handles||Contains the details of the handles used to reach the contact.|
|Contact Notes||Contains the notes added to a contact.|
|Contact Links||Contains the list of all the links associated with a contact.|
|Conversations||Contains the details about conversations. A conversation is a unique thread of messages.|
|Conversation Tags||Contains the tags used in a conversation.|
|Conversation Links||Contains the links used in conversation.|
|Conversation Followers||Contains the details of the teammates following a conversation.|
|Conversation Inboxes||Contains the inbox where a conversation resides.|
|Conversation Messages||Contains the messages in a conversation.|
|Conversation Message Attachments||Contains the attachments present in the messages of a conversation.|
|Conversation Message Recipient||Contains the details of a recipient of the message in a conversation.|
|Groups||Contains the list of groups that a contact belongs to.|
|Inbox||Contains the details of an inbox. An inbox is a container of messages.|
|Inbox Channels||Contains the details of all the channels in an inbox.|
|Rules||Contains the details of the rules in your account. A rule is a set of conditions that triggers automatic actions when they are met.|
|Rule Actions||Contains the list of actions performed by a rule.|
|Shifts||Contains the details of a shift. A shift represents an interval of time repeated over one or more days in a week.|
|Tags||Contains the details about the tags used in your conversations. A tag is a label that is used to classify conversations.|
|Team||Contains the list of teams in your company.
Team is a Full Load object.
|Teammate||Contains the details of your teammates. A teammate is a Front user, a member of your company|
|Teammate Shifts||Contains information about the shifts of your teammates.|
|Team Inbox||Contains all the inboxes belonging to a team.|
|Team Teammate||Contains the details of all the teammates in a team.|
Read the detailed Hevo documentation for the following related topics:
Hevo treats a parent and its child objects differently. This section lists the parent objects along with their child objects, and the differences in how you can manage these objects.
|Parent Objects||Child Objects|
|Contacts||- Contact Notes|
- Comment Mentions- Inbox
- Inbox Channels
- Conversation Followers
If you skip a parent object, its child objects are also skipped.
If you skip a parent object, it is marked as skipped, but its child objects are still shown as active.
You only have the option to skip or include child objects, whereas for parent objects, you have additional options such as changing the offset, restarting the object, or running it now.
Refer to the following table for the list of key updates made to this page:
|Date||Release||Description of Change|
|Oct-17-2022||NA||Updated section,Data Replication to add information about historical load parallelization for quicker access to historical data.|
|Sep-05-2022||NA||Updated section, Data Replication to reorganize the content for better understanding and coherence.|