- Introduction
-
Getting Started
- Creating an Account in Hevo
- Subscribing to Hevo via AWS Marketplace
- Subscribing to Hevo via Snowflake Marketplace
- Connection Options
- Familiarizing with the UI
- Creating your First Pipeline
- Data Loss Prevention and Recovery
- Upgrading Pipeline from Standard to Edge
-
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
- Best Practices to Avoid Reaching Source API Rate Limits
-
Edge
- Data Ingestion
- Core Concepts
-
Pipelines
- Familiarizing with the Pipelines UI
- Creating an Edge Pipeline
- Working with Edge Pipelines
- Pipeline Job History
- Pipeline Overview
- Needs Attention
- Object and Schema Management
- Activity Log
-
Sources
- Connect AI
- PostgreSQL
- Oracle
- MySQL
- SQL Server
- Troubleshooting Database Sources
- CockroachDB
- MongoDB
- SharePoint
- Salesforce Bulk API V2
- Ordergroove
- BambooHR
- Stripe
- NetSuite SuiteAnalytics
- Shopify
- Slack
- ClickUp
- Monday.com
- Pipedrive
- Workable
- Fathom
- HubSpot
- Salesforce Marketing Cloud
- Google Analytics 4
- Google Ads
- Facebook Ads
- Microsoft Ads
- LinkedIn Ads
- Xero
- Instagram Business
- Amazon Selling Partner
- TikTok Ads
- StackAdapt
- Amazon Ads
- Pinterest Organic
- Zendesk Support
- Snapchat Ads
- TikTok Organic
- Google Search Console
- Klaviyo v2
- Braintree Payments
- Facebook Pages
- Tempo
- PayPal
- Auth0
- Pinterest Ads
- Apple Search Ads
- Permit.io
- Amplitude Analytics
- Customer.io
- Paddle
- Jira Cloud
- Fullstory
- GitHub
- WorkOS
- ActiveCampaign
- Campaign Monitor
- Infobip
- Mailgun Send
- Metaplane
- Notion
- Recharge
- sevdesk
- Statuspage
- Teamwork.com
- Workday RaaS
- Yotpo
- TikTok Shop Partner Center
- Linear
- Microsoft Dynamics 365 Business Central
- Checkout.com
- Pylon
- Increase
- Microsoft Teams
- Rollbar
- Toggl Track
- QuickBooks Online
- Zoho Desk
- Livestorm
- Attentive
- SendGrid
- Bitly
- Shortcut
- Buzzsprout
- Persona
- Mailjet
- Open Exchange Rates
- PagerDuty
- CircleCI
- SonarQube
- Chargebee
- Freshdesk
- Bing Webmaster Tools
- Rundeck
- Cal.com
- Mixpanel
- Matomo
- Walmart Marketplace
- Xray
- Reddit Ads
- Zoho Recruit
- HiBob
- Freshchat
- Zoho Books
- Marketo
- LaunchDarkly
- Outreach
- Airtable
- Attio
- Okta
- Zendesk Chat
- Bigin by Zoho CRM
- Brevo
- Naming Conventions for Source Data Entities
- Destinations
- Transformations
- Alerts
- Activate
- Custom Connectors
-
Data Loading
- Loading Data in a Database Destination
- Loading Data to a Data Warehouse
- Optimizing Data Loading for a Destination Warehouse
- Deduplicating Data in a Data Warehouse Destination
- 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
-
Pipelines
- Data Flow in a Pipeline
- Familiarizing with the Pipelines UI
- Working with Pipelines
- Managing Objects in Pipelines
- Pipeline Jobs
-
Transformations
-
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
-
TimeUtils
- 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
- Utils
- 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
- If-Else
- 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
-
Schema Mapper
- 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
- Changing the Data Type of a Destination Table Column
- 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
- Audit Tables
- Activity Log
-
Pipeline FAQs
- 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?
- Why can't I see my Pipelines after logging in?
- Events Usage
-
Sources
- Free Sources
-
Databases and File Systems
- Data Warehouses
-
Databases
- Connecting to a Local Database
- Amazon DocumentDB
- Amazon DynamoDB
- Elasticsearch
-
MongoDB
- Generic MongoDB
- MongoDB Atlas
- Support for Multiple Data Types for the _id Field
- Example - Merge Collections Feature
-
Troubleshooting MongoDB
-
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
- SQL Server
-
MySQL
- Amazon Aurora MySQL
- Amazon RDS MySQL
- Azure MySQL
- Generic MySQL
- Google Cloud MySQL
- MariaDB MySQL
-
Troubleshooting 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
- Oracle
-
PostgreSQL
- Amazon Aurora PostgreSQL
- Amazon RDS PostgreSQL
- Azure PostgreSQL
- Generic PostgreSQL
- Google Cloud PostgreSQL
- Heroku PostgreSQL
- Upgrading Pipelines with PostgreSQL Sources to Use the pgoutput Plugin
-
Troubleshooting 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
- Can I track updates to existing records in PostgreSQL?
- How can I migrate a Pipeline created with one PostgreSQL Source variant to another variant?
- How can I prevent data loss when migrating or upgrading my PostgreSQL database?
- Why do FLOAT4 and FLOAT8 values in PostgreSQL show additional decimal places when loaded to BigQuery?
- Why is data not being ingested from PostgreSQL Source objects?
- Troubleshooting Database Sources
- Database Source FAQs
- File Storage
- Engineering Analytics
- Finance & Accounting Analytics
-
Marketing Analytics
- ActiveCampaign
- AdRoll
- Amazon Ads
- Apple Search Ads
- AppsFlyer
- CleverTap
- Criteo
- Drip
- Facebook Ads
- Facebook Page Insights
- Firebase Analytics
- Freshsales
- Google Ads
- Google Analytics 4
- Google Analytics 360
- Google Play Console
- Google Search Console
- HubSpot
- Instagram Business
- Klaviyo v2
- Lemlist
- LinkedIn Ads
- Mailchimp
- Mailshake
- Marketo
- Microsoft Ads
- Onfleet
- Outbrain
- Pardot
- Pinterest Ads
- Pipedrive
- Recharge
- Segment
- SendGrid Webhook
- SendGrid
- Salesforce Marketing Cloud
- Snapchat Ads
- SurveyMonkey
- Taboola
- TikTok Ads
- Twitter Ads
- Typeform
- YouTube Analytics
- Product Analytics
- Sales & Support Analytics
- Source FAQs
-
Destinations
- Familiarizing with the Destinations UI
- Cloud Storage-Based
- Databases
-
Data Warehouses
- Amazon Redshift
- Amazon Redshift Serverless
- Azure Synapse Analytics
- Databricks
-
Google BigQuery
- 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
- Modifying BigQuery Destinations to Use Service Account Authentication
- Troubleshooting Google BigQuery
- Google BigQuery FAQs
- Hevo Managed Google BigQuery
- Snowflake
- Troubleshooting Data Warehouse Destinations
-
Destination FAQs
- Can I change the primary key in my Destination table?
- Can I change the Destination table name after creating the Pipeline?
- How can I change or delete the Destination table prefix?
- 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?
- How do I filter out specific fields before loading data?
- Transform
- Alerts
- Account Management
- Activate
- Glossary
-
Releases-
2026 Releases
- Release 2.53 (August 24 – September 21, 2026)
- Release 2.52 (July 27 – August 24, 2026)
- Release 2.51 (Jun 29 – July 27 , 2026)
- Release 2.50 (Jun 01–29, 2026)
- Release 2.49 (May 04-Jun 01, 2026)
- Release 2.48 (Apr 06-May 04, 2026)
- Release 2.47 (Mar 09-Apr 06, 2026)
- Release 2.46 (Feb 09-Mar 09, 2026)
- Release 2.45 (Jan 12-Feb 09, 2026)
-
2025 Releases
- Release 2.44 (Dec 01, 2025-Jan 12, 2026)
- Release 2.43 (Nov 03-Dec 01, 2025)
- Release 2.42 (Oct 06-Nov 03, 2025)
- Release 2.41 (Sep 08-Oct 06, 2025)
- Release 2.40 (Aug 11-Sep 08, 2025)
- Release 2.39 (Jul 07-Aug 11, 2025)
- Release 2.38 (Jun 09-Jul 07, 2025)
- Release 2.37 (May 12-Jun 09, 2025)
- Release 2.36 (Apr 14-May 12, 2025)
- Release 2.35 (Mar 17-Apr 14, 2025)
- Release 2.34 (Feb 17-Mar 17, 2025)
- Release 2.33 (Jan 20-Feb 17, 2025)
-
2024 Releases
- Release 2.32 (Dec 16 2024-Jan 20, 2025)
- Release 2.31 (Nov 18-Dec 16, 2024)
- Release 2.30 (Oct 21-Nov 18, 2024)
- Release 2.29 (Sep 30-Oct 22, 2024)
- Release 2.28 (Sep 02-30, 2024)
- Release 2.27 (Aug 05-Sep 02, 2024)
- Release 2.26 (Jul 08-Aug 05, 2024)
- Release 2.25 (Jun 10-Jul 08, 2024)
- Release 2.24 (May 06-Jun 10, 2024)
- Release 2.23 (Apr 08-May 06, 2024)
- Release 2.22 (Mar 11-Apr 08, 2024)
- Release 2.21 (Feb 12-Mar 11, 2024)
- Release 2.20 (Jan 15-Feb 12, 2024)
-
2023 Releases
- Release 2.19 (Dec 04, 2023-Jan 15, 2024)
- Release Version 2.18
- Release Version 2.17
- Release Version 2.16 (with breaking changes)
- Release Version 2.15 (with breaking changes)
- 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
-
2022 Releases
- 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)
-
2021 Releases
- 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)
-
2020 Releases
- 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)
-
2026 Releases
- Early Access New
On This Page
Instagram Business is Meta’s platform for content creators and businesses to manage Instagram professional accounts, publish posts, stories, and reels, and track engagement and performance metrics. It helps businesses understand how their content and accounts are performing so they can refine their marketing strategy and grow their audience.
Hevo uses the Instagram API with Facebook Login to replicate data from your Instagram Business account to the Destination of your choice. As Instagram Business accounts are managed through Facebook, Hevo authenticates using the Facebook account that manages the Facebook Page linked to your Instagram Business account.
Hevo supports the following authentication methods to connect to your Instagram Business account:
-
Open Authorization (OAuth): Allows Hevo to connect to your account through an authorization flow, where you sign in to Facebook and grant Hevo access to your account data. This is the recommended method for most users.
-
Using System User Token: Provide a system user access token generated in Meta Business Manager. This is the recommended method for agencies managing multiple Instagram Business accounts.
-
Using an OAuth app: Allows Hevo to connect to your account using the App ID, App Secret, and long-lived access token of a Meta app that you create in your developer account.
Note: To create a Pipeline with Instagram Business as the Source using an OAuth app, you must use the Create a Pipeline endpoint through the Hevo API. This method is not available in the Hevo UI. Read Creating a Pipeline with Hevo API for the steps to create the Pipeline.
Supported Features
| Feature Name | Supported |
|---|---|
| Capture deletes | No |
| History mode | No |
| Custom data (user-configured tables & fields) | No |
| Data blocking (skip objects and fields) | Yes |
| Resync (objects and Pipelines) | Yes |
| API configurable | Yes |
Prerequisites
-
An active Instagram Business account linked to a Facebook Page exists, from which data is to be ingested.
-
You have Admin access to the Facebook Page or Meta Business Manager account linked to your Instagram Business account to grant OAuth permissions or generate a system user access token.
-
(Optional) If you are authenticating using a system user token, the system user access token is available to provide Hevo access to your Instagram Business account data.
Obtain the System User Access Token (Optional)
A system user access token allows Hevo to access your Instagram Business account without requiring OAuth authorization. This is useful if you manage multiple Instagram Business accounts or use a shared Meta Business Manager account. To use this authentication method, generate a system user access token in Meta Business Manager and ensure it has the following scopes for your Instagram Business account(s):
-
instagram_basic
-
instagram_manage_insights
-
pages_show_list
-
pages_read_engagement
-
business_management
Use this token when configuring your Instagram Business Source in Hevo.
If the system user access token configured in the Pipeline is revoked manually from your Instagram Business account, Hevo cannot authenticate with the Source. As a result, all active jobs for the Pipeline fail, and no data is replicated. To resume data replication, modify the Source configuration in the Pipeline with a valid system user access token. Once the updated token is saved, Hevo re-authenticates the Source, and data ingestion resumes from the last saved offset.
Configure Instagram Business as a Source in your Pipeline
Perform the following steps to configure your Instagram Business Source:
-
Click Pipelines in the Navigation Bar.
-
Click + Create Pipeline in the Pipelines List View.
-
On the Select Source Type page, select Instagram Business.
-
On the Select Destination Type page, select the type of Destination you want to use.
-
On the Select Pipeline Type page, click Edge, and then click Continue.

This page appears only if the selected Destination type is supported in Edge and your Team has an existing Instagram Business Pipeline with the same Destination type. Otherwise, you can proceed to create an Edge Pipeline.
-
In the Configure Source screen, specify the following:

-
Source Name: A unique name for your Source, not exceeding 255 characters. For example, Instagram Business Source.
-
Authentication Method: Select how you want to authenticate your Instagram Business account:
-
Grant User Access: Recommended for most users. Click the Authenticate Your Instagram Business Account button to authenticate your Instagram Business account with Hevo using OAuth 2.0. In the pop-up window, log in to your Facebook account, review the permissions Hevo requests to access your Instagram Business account data, and grant the required permissions to complete the authorization.
-
Use System User Token: Recommended for agencies managing multiple Instagram Business accounts. Specify the access token generated from your Meta Business Manager account in the System User Access Token field.

-
-
Account Selection: From the drop-down, select whether to sync all Instagram Business accounts accessible to your authenticated account or only specific ones. Default value: Sync All Accounts.

-
Sync All Accounts: Hevo syncs data for all Instagram Business accounts accessible to your authorized Facebook account, including any accounts added later.
-
Sync Specific Accounts: Select the accounts you want to sync from the Instagram accounts to sync drop-down.

-
-
Historical Sync Duration: The duration for which you want to ingest existing data from the Source. This cannot be changed after the Pipeline is created. Default value: 3 Months.
-
-
Click Test & Continue to test the connection to your Instagram Business Source.
Configure Instagram Business as a Source Using the Hevo API
You can connect Hevo to your Instagram Business account with an OAuth app created in your developer account. This method is available only through the Hevo API. Specify the credentials of the app in the request that creates the Pipeline, and Hevo uses them to authenticate with your account.
The following credentials from your OAuth app are required to authenticate the connection:
-
Client ID: The App ID of your Meta app. Meta displays it on the app dashboard, and names it App ID in the UI and
client_idin the API. -
Client Secret: The App Secret of your Meta app. Hevo sends it with the App ID to authenticate the request. Meta names it App Secret in the UI and
client_secretin the API. -
Access Token: A long-lived user access token that your app receives when a Facebook user authorizes it. Meta issues no refresh token for this flow, so Hevo uses the long-lived token and renews it from Meta.
Create the app in your Meta developer account and grant it the permissions required for the Instagram Business accounts you want to replicate. Read Create an app with Meta for the steps to create the app, and Get a long-lived user access token for the steps to exchange a short-lived token for the long-lived one.
Grant the app the following permissions:
| Permission | Allows Hevo to |
|---|---|
pages_read_engagement |
Read the Facebook Pages that your Instagram Business accounts are linked to. |
pages_show_list |
List the Facebook Pages that you manage, which Hevo uses to find the Instagram Business accounts linked to them. |
instagram_basic |
Read the profile and media of your Instagram Business accounts. |
instagram_manage_insights |
Read the metrics of your Instagram Business accounts and their media, which Hevo replicates in the User Insights, User Lifetime Insights, and Media Insights objects. |
business_management |
Access the Pages that your business owns in Meta Business Manager. |
Hevo’s own sign-in flow also requests ads_management. Hevo tests the connection before it creates the Pipeline, so a token that is missing any of the five permissions listed is rejected, and Hevo deletes the access token that it generated.
Prepare the Source Configuration
Before you build your request, retrieve the settings that the Instagram Business connector currently accepts. Refer to Read the Connector Configuration for the steps to retrieve them.
In the response, the auth object describes the credentials of your own OAuth app. In the connector configuration response, Hevo returns the auth object under data.schema.properties.auth, and the connector settings under data.schema.properties.config. Only a connector that accepts an OAuth app has an auth property. Each credential carries "type": "string". Every credential except client_id also carries "format": "password" and "writeOnly": true. The following example shows part of the auth object:
{
"auth": {
"required": [
"client_access"
],
"properties": {
"client_access": {
"required": [
"client_id",
"client_secret"
],
"properties": {
"client_id": {
"title": "Client ID"
},
"client_secret": {
"title": "Client Secret"
}
}
},
"refresh_token": {
"title": "Refresh Token"
},
"access_token": {
"title": "Access Token"
}
},
"anyOf": [
{
"required": [
"refresh_token"
]
},
{
"required": [
"access_token"
]
}
]
}
}
Leave config.auth_method blank, or set it to GRANT_USER_ACCESS, which is its default. Send the Meta user token in auth.access_token. To sync only some accounts, set config.sync_mode to SPECIFIC_ACCOUNTS and list the Instagram Business account IDs as strings in config.selected_accounts, such as ["17841454050633047"].
Specify the credentials of your app in the auth object. Use sync_mode to control which accounts Hevo replicates. Specify ALL_ACCOUNTS to replicate every Instagram Business account your app can access, or SPECIFIC_ACCOUNTS to choose them yourself, in which case selected_accounts becomes mandatory. Default value: ALL_ACCOUNTS. The following example shows the source object for an Instagram Business Source:
{
"name": "<source_name>",
"connector_id": "instagram_business",
"type": "INSTAGRAM_BUSINESS",
"config": {
"sync_mode": "ALL_ACCOUNTS",
"historical_sync_duration": "last_3_months"
},
"auth": {
"client_access": {
"client_id": "<client_id>",
"client_secret": "<client_secret>"
},
"access_token": "<access_token>"
}
}
Note: Replace the placeholder values in the example with your own. For example, <source_name> with My Instagram Business Account.
Specify this source object in the request that creates your Pipeline. Read Creating a Pipeline with Hevo API for the complete request and the remaining steps.
Hevo validates the credentials and tests the Source and Destination connections before it saves anything. To test the Source connection, Hevo uses the credentials in the auth object to generate an access token. If a credential is rejected or a test fails, the request returns an error, and no Pipeline is created. Hevo also deletes the access token that it generated.
Note: Hevo does not store these credentials in the Source configuration. It exchanges them for an authorization when the Pipeline is created, so the Source is set up without a browser sign-in. Hevo does not return them if you retrieve the Source configuration later. If you revoke the credentials in Meta, Hevo cannot authenticate with the Source. As a result, all active jobs for the Pipeline fail, and no data is replicated. To resume data replication, send the new credentials using the Modify Source Configuration in a Pipeline endpoint. Read Modifying the Source Configuration for the steps to send them.
Data Replication
Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.
Hevo ingests the following types of data from your Source objects:
-
Historical Data: The first run of the Pipeline ingests historical data for the selected objects based on the Historical Sync Duration specified when configuring the Source, and loads it into the Destination.
-
Incremental Data: Once the historical load is complete, new and updated records for objects are ingested as per the sync frequency.
For the following objects, Hevo ingests only the incremental data in subsequent Pipeline runs:
-
Media Comment
-
Media History
-
Media Insights
-
User Insights
For the Media Comment object, Hevo fetches comments for all media during the initial sync. During subsequent Pipeline runs, Hevo incrementally syncs comments for posts from the last 30 days. Once a week, Hevo also syncs comments for posts from the last 2 years to capture comments on older posts.
For all other objects, Hevo ingests the entire data during each Pipeline run.
Instagram API currently enforces a rate limit on the number of calls that can be made in a given time period. If this limit is exceeded, a rate limit exception occurs. To understand how Hevo handles such scenarios, read Handling Rate Limit Exceptions.
Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.
Schema and Primary Keys
Hevo uses the following schema to upload the records to the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
| Object | Description |
|---|---|
| Media Comment | Contains details about comments posted on your Instagram media, including the comment text, like count, and the commenting user’s information. |
| Media History | Contains details about the photos, videos, carousel albums, and stories posted on your Instagram Business account, including the caption, media type, and media URLs. |
| Media Insights | Contains performance metrics for your Instagram media, including impressions, reach, likes, saves, and shares, broken down by media type, such as photo, video, carousel album, story, and reel. |
| Page Detail | Contains details about the Facebook Page linked to your Instagram Business account, including the Page name and category. |
| User History | Contains details about your Instagram Business account profile, including follower, following, and media counts, as well as profile information such as username, website, and profile picture. |
| User Insights | Contains daily aggregated insights for your Instagram Business account, such as reach, follower, unfollower counts, and engagement metrics such as likes, comments, saves, and shares. |
| User Lifetime Insights | Contains lifetime information about your Instagram Business account, including the age, gender, country, and city of your followers and engaged audience. |
Additional Information
Read the detailed Hevo documentation for the following related topics:
Source Considerations
-
Instagram allows you to fetch data from up to 2 years before the current date.
-
The Instagram API returns only the 10,000 most recently created media items for an account. Therefore, when Hevo ingests the Media History object, media items older than the latest 10,000 cannot be fetched.
-
Story insights are available for only 24 hours after a story is posted. After that, Instagram no longer provides insights for the story.
-
Instagram may take up to 48 hours to make insights data available through the API. As a result, Hevo may not immediately ingest the latest insights data.
Revision History
Refer to the following table for the list of key updates made to this page:
| Date | Release | Description of Change |
|---|---|---|
| Oct-19-2026 | 2.54 | Added section, Configure Instagram Business as a Source Using the Hevo API. |
| Aug-18-2026 | NA | New document. |