- 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
- Data Ingestion
- Types of Data Synchronization
- Ingestion Modes and Query Modes for Database Sources
- 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
- 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
- Does creation of Pipeline incur cost?
- Why are my new Pipelines in trial?
- 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 delete skipped objects in a Pipeline?
- Can I change the Destination post-Pipeline creation?
- How does changing the query mode affect data ingestion?
- 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 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 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?
- 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
- Finance & Accounting Analytics
- Apple Search Ads
- Facebook Ads
- Facebook Page Insights
- Firebase Analytics
- 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
- Help Scout
- Hub Planner
- 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 can I transfer Excel files using Hevo?
- 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
- 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 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?
- 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.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
ActiveCampaign is a cloud software platform that integrates email marketing, automation and customer relationship management to enable you to create a rich and personalized experience for your customers. It provides access to a variety of prebuilt automations, and integrations such as Shopify and Salesforce, and the creation of customized campaigns to suit customer behaviours.
Hevo uses the ActiveCampaign RESTful version 3 API to ingest data from your ActiveCampaign account and load it to the desired Destination for scalable analysis.
An active ActiveCampaign account from which data is to be ingested
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.
An API key and Account Name are available to authenticate Hevo on your ActiveCampaign account.
You must be logged in as an Admin user to access all the data in your account.
Obtaining the Account Name and API Key
ActiveCampaign automatically provides you with the API credentials; account name and API key, for authenticating Hevo on your ActiveCampaign account. The API key does not expire and can be reused for all your Pipelines.
Perform the following steps to obtain your account name and API key:
Log in to your ActiveCampaign account.
In the left navigation panel, click Settings.
In the Settings navigation panel, click Developer.
In the Developer page, in the API Access section:
Copy the API URL and save it in a secure location like any other password. The API URL contains the account name. For example, if the API URL is https://hevodata123456.api-us1.com, account name is hevodata123456.
Copy the API key by clicking Copy API Key, and save it in a secure location like any other password.
Use the account name and API key to configure ActiveCampaign as a Source in Hevo.
Configuring ActiveCampaign as a Source
Perform the following steps to configure ActiveCampaign 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 ActiveCampaign.
In the Configure your ActiveCampaign Source page, specify the following:
Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.
API Key: The private key in your ActiveCampaign account, to enable Hevo to read data.
Account Name: The unique identifier of your ActiveCampaign account, to enable Hevo to access the data.
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)|
|1 hr||1 hr||24 hrs||1-24|
Note: You must set the custom frequency 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 all historical data for all the objects and loads it to the Destination.
Incremental Data: Once the historical load is complete, all new and updated records for the Contacts and Deals objects are synchronized with your Destination according to 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:
Note: You need to be an Admin in ActiveCampaign in order to ingest data from the objects Tasks, Calendars, Stages and Pipelines. Additionally, you need permissions from an Admin in order to ingest data from the Automation, Deals, Forms, and Secondary Contacts objects.
|Accounts||Full Load||Contains the details of your customer accounts.|
|Accounts Contact Association||Full Load||Contains the details of the contacts associated with your customer accounts.|
|Account Custom Fields||Full Load||Contains the details of all the custom fields you may have created for an account. Custom fields in accounts allow you to store additional information specific to those accounts.|
|Account Custom Field Values||Full Load||Contains the values of all the account custom fields associated with your account.|
|Addresses||Full Load||Contains the addresses of all the businesses you work with.|
|Automations||Full Load||Contains the details of all the automations in your ActiveCampaign account. Automations allow you to build a series of emails that are sent to subscribers when triggered by a specific date, activity, or event.|
|Brandings||Full Load||Contains the details of all the brandings associated with your ActiveCampaign account. Branding allows you to create easily identifiable products to help in sales.|
|Calendar Feeds||Full Load||Contains the details of all your ActiveCampaign calendar feeds. Calendar feeds allow you to push your ActiveCampaign tasks to a calendar client that supports subscription calendars such as Google Calendar and Apple Calendar.|
|Campaigns||Full Load||Contains the details of all the campaigns belonging to your ActiveCampaign account. Campaigns are email marketing messages used for attracting customers.|
|Connections||Full Load||Contains the details of all the links between your ActiveCampaign account and accounts in an external service such as Shopify.|
|Contacts||Incremental||Contains the details of all your contacts in ActiveCampaign.|
|Contact Tags||Full Load||Contains the details about the tags related to a contact. Tags are created and used by users to gather essential information about a contact.|
|Contacts Custom Fields||Full Load||Contains the details of all the custom fields that you may have created to capture additional information about your contacts.|
|Contacts Custom Field Values||Full Load||Contains the values of all the custom fields in contacts.|
|Custom Deal Fields||Full Load||Contains the details of all the custom fields that you may have created to capture additional information about deals.|
|Custom Deal Fields Values||Full Load||Contains the values of the custom deal fields.|
|Deals||Incremental||Contains the details of all the deals in your ActiveCampaign account. A deal contains the information about a potential sale.|
|Deal Roles||Full Load||Contains the details of all the roles that have been assigned to your contacts associated with deals.|
|E-Commerce Customers||Full Load||Contains the details of all the customers in a third party e-commerce service such as Shopify that is linked with your ActiveCampaign account.|
|E-Commerce Orders||Full Load||Contains the details of the orders in an external e-commerce service such as Shopify that is linked with your ActiveCampaign account.|
|E-Commerce Order Products||Full Load||Contains the details of resources such as products and line items in an external e-commerce service such as Shopify that is linked with your ActiveCampaign account.|
|Forms||Full Load||Contains the details of all the forms belonging to your ActiveCampaign account. Forms allow you to collect and store information about contacts in your database.|
|Groups||Full Load||Contains the details of all the groups belonging to your ActiveCampaign account. Groups are used to classify users with access to the ActiveCampaign account so that they are assigned only the relevant roles and permissions required.|
|Group Limits||Full Load||Contains the details of all the limitations applied on user groups such as the limit set on the number of emails sent and the number of contacts stored.|
|Lists||Full Load||Contains the details of all the lists in your ActiveCampaign account. A list is a group of customer contacts that have been placed together due to some broad similarities.|
|Messages||Full Load||Contains the details of the messages sent and received from the customers such as the sender name and email address.|
|Pipelines||Full Load||Contains the details of all your pipelines. A pipeline is a defined set of stages to track a process selling a subscription.|
|Saved Responses||Full Load||Contains the details of the templates for one-off personal emails that you send to a single contact.|
|Secondary Contacts||Full Load||Contains the details of all the secondary contacts in your account. A secondary contact is any additional contact linked with a deal ,along with the primary contact.|
|Scores||Full Load||Contains the details of all the scores assigned to the leads to evaluate and prioritize them.|
|Segments||Full Load||Contains the details of all the segments used to group contacts in your ActiveCampaign account.|
|Stages||Full Load||Contains the details about all the deal stages in your pipelines. A stage is used to group deals in a pipeline so that they can be tracked easily.|
|Tags||Full Load||Contains the details of all the tags used to organize your contacts into multiple categories.|
|Tasks||Full Load||Contains the details of all the tasks assigned to users. Tasks allow you to keep track of what a user needs to do related to a contact or a deal.|
|Task Outcomes||Full Load||Contains the list of all the task outcomes. A task outcome is a list of possible results from an interaction with a prospect or a customer.|
|Task Types||Full Load||Contains the details of all the tasks associated with your account. Tasks are a way to track what a user needs to do in relation to a contact or a deal.|
|Task Types and Outcome Relations||Full Load||Contains the details about the tasks, their type, and particular outcomes.|
|Users||Full Load||Contains the details of all the users that have access to the ActiveCampaign account.|
Read the detailed Hevo documentation for the following related topics:
Pagination: Each API response for each ActiveCampaign object fetches one page with up to 100 records per page.
Rate limit: ActiveCampaign imposes a limit of a maximum of 5 API calls per second per account to optimize performance.
- Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.
Refer to the following table for the list of key updates made to this page:
|Date||Release||Description of Change|
|Nov-08-2022||2.01||Updated sections, Data Replication, Schema and Primary keys, and Data Model to add information about support for a new Contact Tags object and incremental ingestion for the Contacts and Deals objects.|