Connector Configlink
Updated 5 days ago
The connector setup configuration (config
field) is different for each connector.
Most of the configuration fields documented in this section can be used both in the Create a connector and Modify a connector requests. The following fields as well as some other connector type-specific fields can only be used when creating a connector:
schema
table
schema_prefix
timeframe_months
The following connectors can be managed through the Fivetran REST API:
- 6sense
- 15Five
- 360Learning
- ActiveCampaign
- Acumatica
- Ada
- Adjust
- Adobe Analytics
- Adobe Analytics Data Feed
- Adobe Commerce
- ADP Workforce Now
- AdRoll
- Affinity
- Afterpay
- Aha
- Aircall
- Airtable
- Alchemer
- Algolia
- Amazon Ads
- Amazon Attribution
- Amazon Kinesis Firehose
- Amazon S3
- Amazon Selling Partner
- Amplitude
- Anaplan
- Apache Kafka
- Appcues
- Appfigures
- Apple App Store
- Apple Search Ads
- AppsFlyer
- Asana
- Assembled
- Attentive
- Attio
- Aumni
- Auth0
- Autodesk BIM 360
- AvantLink
- Awin
- AWS CloudTrail
- AWS Cost Explorer
- AWS Inventory
- AWS Lambda
- AWS MSK
- Azure Blob Storage
- Azure Boards
- Azure Devops
- Azure Functions
- Azure Event Hubs
- Azure Service Bus
- BallotReady
- BambooHR
- BigCommerce
- BigQuery
- BillingPlatform
- Birdeye
- Bitly
- Box
- Braintree
- Branch
- Braze
- Brevo
- Brex
- Buzzsprout
- Calabrio
- Calendly
- Canny
- Care Quality Commission
- Castor EDC
- Ceridian Dayforce
- Channel Advisor
- Chargebee Product Catalog 1.0
- Chargebee Product Catalog 2.0
- ChargeDesk
- Checkout.com
- Churnkey
- ChurnZero
- Cimis
- Cin7
- CircleCI
- Clari
- ClickUp
- CloudFront
- Coassemble
- Codefresh
- Collibra
- Confluence
- Confluent Cloud
- Contrast Security
- Copper
- Cosmos DB
- Coupa
- Criteo
- Crossbeam
- crowd.dev
- Customer.io
- Cvent
- D2L Brightspace
- dbt Cloud
- DCL Logistics
- DEAR
- Delighted
- Deputy
- Destini
- Dixa
- Docebo
- DocumentDB
- Drata
- Drift
- Drip
- Dropbox
- Dropbox Sign
- DynamoDB
- EasyPost
- e-conomic
- Eloqua
- Employment Hero
- Eventbrite
- Everhour
- Expensify
- EZOfficeInventory
- Facebook Ads
- Facebook Pages
- FinancialForce
- Firebase
- Fivetran Platform Connector
- Flexport
- Fone Dynamics
- Float
- Forj Community
- Fountain
- FreshBooks
- Freshchat
- Freshdesk
- Freshservice
- Friendbuy
- Front
- Freshteam
- FTP/FTPS
- FullStory
- Gainsight Customer Success
- Gem
- GetFeedback
- GitHub
- GitLab
- Gladly
- GlobalMeet
- GoCardless
- Gong
- Google Ad Manager
- Google Ads
- Google Analytics
- Google Analytics 4
- Google Analytics 4 Export
- Google Analytics 360
- Google Analytics (MCF)
- Google Calendar
- Google Campaign Manager 360
- Google Cloud Functions
- Google Cloud Storage
- Google Display & Video 360
- Google Drive
- Google Play
- Google Search Ads 360
- Google Search Console
- Google Sheets
- Gorgias
- Greenhouse
- GreenPowerMonitor
- Grepsr
- GRIN
- Guru
- Happyfox
- Harvest
- Heap
- Height
- Help Scout
- Helpshift
- Heroku Kafka
- HiBob
- High-Volume Agent Db2 for i
- High-Volume Agent Oracle
- High-Volume Agent SAP ECC on Db2 for i
- High-Volume Agent SAP ECC on Hana
- High-Volume Agent SAP ECC on Hana With NetWeaver
- High-Volume Agent SAP ECC on Oracle
- High-Volume Agent SAP ECC on Oracle With NetWeaver
- High-Volume Agent SAP S/4Hana
- High-Volume Agent SAP S/4Hana With Netweaver
- High-Volume Agent SAP B1 on HANA
- High-Volume Agent SQL Server
- Hopin
- HubSpot
- iLevel
- Impact
- incident.io
- Infobip
- Insightly
- Instagram Business
- Integral Ad Science
- Integrate
- Intercom
- Ironclad
- ironSource
- Iterable
- Jira
- Jira Align
- Jotform
- JustCall
- Kandji
- Katana
- Keypay
- Khoros Care
- Kissmetrics
- Klarna
- Klaviyo
- KnowBe4
- Konnect Insights
- Kustomer
- Lattice
- LaunchDarkly
- LearnUpon
- Lessonly
- Lever
- Liftoff
- Lightspeed Retail
- Linear
- LinkedIn Ad Analytics
- LinkedIn Company Pages
- LiveChat
- LinkSquares
- LiveChat
- Looker
- Loop
- Loopio
- Luma
- Mailchimp
- Mailgun
- Mandrill
- MariaDB
- Marin Software
- Marketo
- Mavenlink
- Maxio Chargify
- Medallia
- Megaphone
- Meltwater
- Mention
- Microsoft Advertising
- Microsoft Dynamics 365 Business Central
- Microsoft Dynamics 365 CRM
- Microsoft Dynamics 365 Finance
- Microsoft Lists
- Microsoft Teams
- Mixpanel
- Mixmax
- MNTN
- Mode
- Moloco
- MongoDB
- MySQL
- Mux
- Namely
- Navan
- Notion
- NetSuite SuiteAnalytics
- Nylas
- Okta
- Ometria
- OneDrive
- Open Exchange Rates
- Opsgenie
- Optimizely
- Oracle
- Oracle Business Intelligence Publisher
- Oracle Fusion CRM
- Oracle Fusion FSCM
- Oracle Fusion HCM
- Oracle Moat Analytics
- Orbit
- Ordway
- Ortto
- Outbrain
- Outreach
- PagerDuty
- PandaDoc
- Papershift
- Pardot
- PartnerStack Vendor
- Paychex
- PayPal
- Pendo
- Persona
- Personio
- Pingdom
- Pinpoint
- Pinterest Ads
- Pipedrive
- Pivotal Tracker
- Piwik PRO
- Playvox
- PostgreSQL
- PostHog
- PowerReviews Enterprise
- Prive
- Productboard
- Qualaroo
- Qualtrics
- QuickBooks
- Recharge
- Recurly
- Reddit Ads
- Redshift
- Reltio
- Reply.io
- RetailNext
- Retently
- Revel Systems
- RevOps
- RevX
- RingCentral
- Rippling
- Rollbar
- Rootly
- RTB House
- Sage HR
- Sage Intacct
- Sailthru
- Salesforce
- Salesforce Commerce Cloud
- Salesforce Marketing Cloud
- Salesloft
- Salsify
- Samsara
- SAP Business ByDesign
- SAP Concur
- SAP HANA
- SAP SuccessFactors
- SAP S/4
- SCORM
- Security Journey
- Segment
- SendGrid
- ServiceNow
- ServiceTitan
- Sensor Tower
- SFTP
- SharePoint
- ShipHero
- ShipStation
- Shopify
- Shortcut
- Shopware
- Short.io
- Simplecast
- Simplesat
- Skilljar
- Skuvault
- Slab
- Slack
- Smadex
- Smartwaiver
- Snapchat Ads
- Snowflake
- Snowplow
- Sonarqube
- Split
- Splunk
- Spotify Ads
- Sprout Social
- SQL Server
- Square
- Squarespace
- StackAdapt
- Standard Metrics
- Statuspage
- Stripe
- Stylight
- Subscript
- SugarCRM
- SurveyMonkey
- Survicate
- Swoogo
- Tableau
- Taboola
- Talkdesk
- Talkwalker
- Teamwork
- Tempo
- The Trade Desk
- Thinkific
- TikTok Ads
- Toggl Track
- Transcend
- Trello
- Trisolute
- Twilio
- Twitter Organic
- Twitter Ads
- Typeform
- Unicommerce
- Upland Software
- UpPromote
- UserVoice
- Verizon Media
- Vitally
- Vonage
- VWO
- Wasabi Cloud Storage
- Webhooks
- When I Work
- Wherefour
- WooCommerce
- WordPress
- Workable
- Workday Financial Management
- Workday HCM
- Workday RaaS
- Workday Strategic Sourcing
- WorkflowMax
- WorkRamp
- Wrike
- Xero
- Xray
- Yahoo DSP
- Yahoo Search Ads on Yahoo Japan
- Yotpo
- YouTube Analytics
- Zendesk Chat
- Zendesk Sell
- Zendesk Sunshine
- Zendesk Support
- Zenefits
- Zoho Books
- Zoho Campaigns
- Zoho CRM
- Zoho Desk
- Zoom
- Zuora
- Zuora Sandbox
6sense Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "6sense",
"group_id": "target_group_id",
"config": {
"schema": "6sense_schema_name",
"api_key": "your_6sense_API_Key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your 6sense API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
15Five Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "15five",
"group_id": "target_group_id",
"config": {
"schema": "15five_schema_name",
"api_key": "your_15five_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your 15Five API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
360Learning Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "360learning",
"group_id": "target_group_id",
"config": {
"schema": "360learning_schema_name",
"api_key": "your_360learning_api_key",
"company_id": "your_comapny_id"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your 360Learning API key. |
company_id | Your 360Learning company ID. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key
andcompany_id
. - By using the Connect Card or the Fivetran dashboard.
ActiveCampaign Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "activecampaign",
"group_id": "target_group_id",
"config": {
"schema": "activecampaign_schema_name",
"api_key": "your_activecampaign_api_key",
"sub_domain": "http://your.sub.domain/"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your ActiveCampaign API key. |
sub_domain | Your ActiveCampaign subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key
andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
Acumatica Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "acumatica",
"group_id": "target_group_id",
"config": {
"schema": "acumatica_schema_name",
"sub_domain": "your_acumatica_subdomain",
"client_id": "your_acumatica_client_id",
"client_secret": "your_acumatica_client_secret",
"instance": "your_acumatica_instance_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | Your Acumatica subdomain. |
client_id | Your Acumatica client ID. |
client_secret | Your Acumatica client secret. |
instance | Your Acumatica instance name. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain
,client_id
,client_secret
, andinstance
. - By using the Connect Card or the Fivetran dashboard.
Ada Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "ada",
"group_id": "target_group_id",
"config": {
"schema": "ada_schema_name",
"bearer_token": "your_ada_bearer_token",
"sub_domain": "your_bot_handle"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
bearer_token | Your Ada API access token. |
sub_domain | Your Ada bot handle. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
bearer_token
andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
Adjust link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adjust",
"group_id": "target_group_id",
"config": {
"schema": "adjust"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
csv_definition
,export_storage_type
,bucket_name
, ands3_role_arn
(optional) in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "adjust", "group_id": "target_group_id", "config": { "schema": "adjust" }, "auth": { "csv_definition" : "my export definition", "export_storage_type" : "AWS_S3 or GCS", "bucket_name": "bucket", "s3_role_arn" : "role_arn" } }
content_copyAuth parameterslink
Name Description Possible Values csv_definition
CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition). export_storage_type
Your cloud storage. GCS
,AWS_S3
bucket_name
Your AWS S3 or GCS bucket. s3_role_arn
Used if the export_storage_type
isAWS_S3
, the Role ARN required for authentication.NOTE: If
export_storage_type
isGCS
is, then you will need to grant Fivetran access to your Google Cloud Storage bucket.By using the Connect Card or the Fivetran dashboard.
Adobe Analytics link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics",
"client_id": "clientId",
"client_secret": "clientSecret",
"technical_account_id": "technicalAccountId",
"organization_id": "organizationId",
"private_key": "privateKey",
"date_granularity": "HOUR",
"timeframe_months": "THREE",
"adobe_analytics_configurations": [
{
"table": "test_table",
"sync_mode": "SpecificReportSuites",
"report_suites": [
"test_report_suites"
],
"elements": [
"variables/daterangeweek"
],
"metrics": [
"metrics/videoplay"
],
"calculated_metrics": [
"cm300009702_5f3af08b41e485452a641b88"
],
"segments": [
"s300009702_5f3a8781f882e4754a131377"
]
}
]
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
client_id | Client ID from the Service Account (JWT) credentials of your Adobe Project. | |
client_secret | Client Secret from the Service Account (JWT) credentials of your Adobe Project. | |
technical_account_id | Technical Account ID from the Service Account (JWT) credentials of your Adobe Project. | |
organization_id | Organization ID from the Service Account (JWT) credentials of your Adobe Project. | |
private_key | The complete contents of your private key file including the start and end tags (----BEGIN PRIVATE KEY---- Your key without line breakers----END PRIVATE KEY---- ). | |
date_granularity | The aggregation duration. Default value: HOUR . | HOUR , DAY , WEEK , MONTH , QUARTER , YEAR |
timeframe_months | The number of months' worth of reporting data to include in the initial sync. This cannot be modified once the connector is created. Default value: TWELVE . | THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
adobe_analytics_configurations | The list of configurations of tables you want to sync. The number of tables and their configurations is limited to 5. Required for connector creation. | |
table | The table name unique within the schema to which connector will sync the data. Required for connector creation. | |
sync_mode | Whether to sync all report suites or specific report suites. Default value: AllReportSuites . | AllReportSuites , SpecificReportSuites |
report_suites | Specific report suites to sync. Must be populated if sync_mode is set to SpecificReportSuites . Required for connector creation. | |
elements | The elements that you want to sync. Required for connector creation. | |
metrics | The metrics that you want to sync. | |
calculated_metrics | The calculated_metrics that you want to sync. | |
segments | The segments that you want to sync. |
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Adobe Analytics Data Feed link
The Adobe Analytics Data Feed connector supports the following cloud file storage services as a source:
The API requests are source-specific.
Amazon S3 Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics_data_feed",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics_data_feed_s3",
"source": "S3",
"s3bucket": "bucket",
"s3role_arn": "role_arn"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
s3bucket | The S3 bucket name. |
s3role_arn | The Role ARN required for authentication. |
source | The data source. |
Amazon S3 Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
s3bucket
,s3role_arn
andsource
. - By using the Connect Card or the Fivetran dashboard.
Azure Blob Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics_data_feed",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics_data_feed_blob",
"source": "AZURE_BLOB_STORAGE",
"abs_connection_string": "connection_string",
"abs_container_name": "container_name",
"abs_connection_method": "SSH_TUNNEL",
"abs_container_address": "fivetran.blob.windows.net",
"abs_host_ip": "13.120.106.58",
"abs_host_user": "fivetran",
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
source | The data source. | |
abs_connection_string | Azure Blob storage connection string. | |
abs_container_name | Azure Blob storage container name. | |
abs_connection_method | The connection method. Default value: DIRECT | DIRECT , SSH_TUNNEL , PRIVATE_LINK |
abs_container_address | IP address or domain of the storage container which is accessible from the host machine. Required when abs_connection_method is set to SSH_TUNNEL . | |
abs_host_ip | IP address of the host tunnel machine which is used to connect to the storage container. Required when abs_connection_method is set to SSH_TUNNEL . | |
abs_host_user | Username used to log in to the host machine. Required when abs_connection_method is set to SSH_TUNNEL . |
Azure Blob Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
abs_connection_string
,abs_container_name
andsource
. - By using the Connect Card or the Fivetran dashboard.
Azure Service Bus link
POST https://api.fivetran.com/v1/connectors
{
"service": "azure_service_bus",
"group_id": "target_group_id",
"config": {
"schema": "schema_name",
"auth_type": "connection_string",
"has_manage_permissions": "false",
"subscriber_name": "subscriber_name",
"message_type": "text",
"sync_type": "packed",
"schema_registry_urls" : ["serveraddress1:8080, serveraddress2:8080"],
"schema_registry_key" : "schema_registry_key",
"schema_registry_secret" : "schema_registry_secret",
"connection_method" : "direct",
"topics" : ["topic1", "topic2"],
"namespace" : "my_namespace"
},
"auth": {
"connection_string": "Connection String",
"client_access" : {
"client_id": "my_client_id",
"client_secret": "my_client_secret"
},
"refresh_token": "refresh_token"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
auth_type | The authentication mode to access the topic | ConnectionString , AzureActiveDirectory |
has_manage_permissions | The boolean value specifying whether the connection string has manage permissions | true , false |
topics | The comma-separated list of topics which should be synced. Required if you do not have manage permissions | |
namespace | The ASB namespace which we have to sync. Required if auth_type is AzureActiveDirectory . | |
subscriber_name | The subscriber name. If the connection string does not have manage permission, you need to specify a subscriber name we can use to fetch data. If not specified, we default to fivetran_sub_<schema> | |
message_type | The format of messages in the topic | Text , Json , Avro , Protobuf , Xml |
sync_type | The sync type, which is based on the message type. For Text and Xml , Packed is supported. For Protobuf and Avro , Unpacked is supported. For Json , both Packed and Unpacked are supported. | Packed , Unpacked |
schema_registry_urls | The comma-separated list of schema registry servers in the server:port format | |
schema_registry_key | The key used to access the schema registry. Required for the Avro and Protobuf message types | |
schema_registry_secret | The secret used to access the schema registry. Required for the Avro and Protobuf message types | |
connection_method | The connection method | direct , sshTunnel , privateLink |
asb_ip | The IP address (or) the URL of ASB namespace. Required if connection_method is sshTunnel | |
host_ip | The IP address of the host machine which we use to connect to ASB via ssh. Required if connection_method is sshTunnel | |
host_user | The username on the host machine which we use to connect to ASB via ssh. Required if connection_method is sshTunnel |
Auth parameterslink
Name | Description | Possible Values |
---|---|---|
connection_string | The connection string used for authentication. Required if the authentication type is ConnectionString | |
client_id | Client ID of your Azure application. Required if the authentication type is AzureActiveDirectory | |
client_secret | Client Secret of your Azure application. Required if the authentication type is AzureActiveDirectory | |
refresh_token | The refresh token. Required if the authentication type is AzureActiveDirectory |
Azure Service Bus Authorizationlink
There are three ways to authorize this connector type:
- By providing the connection string in the
auth
field whenauth_type
isConnectionString
. - By specifying values for
access_token
,refresh_token
, andscope
whenauth_type
isAzureActiveDirectory
. - By using the Connect Card or the Fivetran dashboard when
auth_type
isAzureActiveDirectory
.
FTP(S) Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics_data_feed",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics_data_feed_ftp",
"source": "FTP",
"ftp_host": "host",
"ftp_port": 21,
"ftp_user": "user",
"ftp_password": "password",
"is_ftps": true
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
ftp_host | FTP host. | |
ftp_port | FTP port. | |
ftp_user | FTP user. | |
ftp_password | FTP password. | |
is_ftps | Use Secure FTP (FTPS). | Specify true for FTPS, false for FTP |
source | The data source. |
FTP(S) Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
ftp_host
,ftp_port
,ftp_user
,ftp_password
andsource
. - By using the Connect Card or the Fivetran dashboard.
SFTP Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics_data_feed",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics_data_feed_sftp",
"source": "SFTP",
"sftp_host": "host",
"sftp_port": 22,
"sftp_user": "user",
"sftp_password": "password",
"sftp_is_key_pair": true
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sftp_host | SFTP host. | |
sftp_port | SFTP port. | |
sftp_user | SFTP user. | |
sftp_password | SFTP password required if sftp_is_key_pair is false | |
sftp_is_key_pair | Log in with key pair or password | true , false |
source | The data source. |
SFTP Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sftp_host
,sftp_port
,sftp_user
,sftp_password
andsource
. - By using the Connect Card or the Fivetran dashboard.
Adobe Commerce Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_commerce",
"group_id": "target_group_id",
"config": {
"schema": "adobe_commerce_schema_name",
"host_url": "your.host.url.com",
"username": "your_adobe_commerce_username",
"password": "your_adobe_commerce_password"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
host_url | Your Adobe Commerce host url. |
username | Your Adobe Commerce username. |
password | Your Adobe Commerce password. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host_url
,username
andpassword
. - By using the Connect Card or the Fivetran dashboard.
ADP Workforce Now link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adp_workforce_now",
"group_id": "target_group_id",
"config": {
"schema": "test_adp_workforce_now",
"client_id": "test_client_id",
"client_secret": "test_client_secret",
"ws_certificate": "xxxxx-xxxxx-xxxxx-xxxxx",
"private_key": "xxxxx-xxxxx-xxxxx-xxxxx"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id | Your ADP Client ID. |
client_secret | Your ADP Client Secret. |
ws_certificate | The contents of your PEM formatted Web Services certificate file. |
private_key | The contents of your private key file. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id
,client_secret
,ws_certificate
andprivate_key
. - By using the Connect Card or the Fivetran dashboard.
AdRoll link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service" : "adroll",
"group_id": "target_group_id",
"config": {
"schema": "adroll",
"table": "table",
"sync_mode" : "SpecificAdvertisables",
"advertisables": ["adv1","adv2"],
"report_type" : "ALL_CAMPAIGNS",
"dimensions": ["eid","campaigns"],
"metrics": ["impressions","cost"],
"timeframe_months": "THREE"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
sync_mode | Whether to sync all advertisables or specific advertisables. Default value: AllAdvertisables . | AllAdvertisables , SpecificAdvertisables |
advertisables | Specific advertisables to sync. Must be populated if sync_mode is set to SpecificAdvertisables . | |
report_type | The report type you want. Default value: ALL_ADS . | ALL_AUDIENCE , ALL_CAMPAIGNS , ALL_ADS , ALL_ADGROUPS , CONVERSIONS , ALL_ADVERTISABLES |
dimensions | The dimenstions that you want to sync. | |
metrics | The metrics that you want to sync. | |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE . | THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service" : "adroll", "group_id": "target_group_id", "config": { "schema": "adroll", "table": "table", "sync_mode" : "SpecificAdvertisables", "advertisables": ["adv1","adv2"], "report_type" : "ALL_CAMPAIGNS", "dimensions": ["eid","campaigns"], "metrics": ["impressions","cost"], "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your AdRoll client application.client_secret
Client Secret
of your AdRoll client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or through the Fivetran dashboard.
Affinity Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "affinity",
"group_id": "target_group_id",
"config": {
"schema": "affinity_schema_name",
"api_key": "your_affinity_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Affinity API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Afterpay Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "afterpay",
"group_id": "target_group_id",
"config": {
"schema": "afterpay_schema_name",
"api_environment": "your_afterpay_api_environment",
"merchant_id": "your_afterpay_merchant_id",
"secret_key": "your_afterpay_secret_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_environment | Your Afterpay API environment. |
merchant_id | Your Afterpay merchant ID. |
secret_key | Your Afterpay secret key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_environment
,merchant_id
andsecret_key
. - By using the Connect Card or the Fivetran dashboard.
Aha Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aha",
"group_id": "target_group_id",
"config": {
"schema": "aha_schema_name",
"base_url": "your_aha_base_url",
"api_token": "your_aha_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
base_url | Your Aha Base URL. |
api_token | Your Aha API Token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
base_url
andapi_token
. - By using the Connect Card or the Fivetran dashboard.
Aircall Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aircall",
"group_id": "target_group_id",
"config": {
"schema": "aircall_schema_name",
"api_id": "your_aircall_api_id",
"api_token": "your_aircall_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_id | Your Aircall API ID. |
api_token | Your Aircall API Token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_id
andapi_token
. - By using the Connect Card or the Fivetran dashboard.
Airtable link
IMPORTANT: Airtable connectors created on or after June 14, 2023, must authenticate using OAuth 2.0.
Requestlink
OAuth 2.0 authenticationlink
{
"service": "airtable",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_airtable"
},
"auth": {
"client_access": {
"client_id": "my_client_id",
"client_secret": "my_client_secret"
},
"refresh_token": "my_refresh_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema_prefix | The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
client_id | Client ID of your Airtable client application. |
client_secret | Client Secret of your Airtable client application. |
refresh_token | The long-lived Refresh token along with the client_id and client_secret parameters carry the information necessary to get a new access token for API resources. |
API key authenticationlink
POST https://api.fivetran.com/v1/connectors
{
"service": "airtable",
"group_id": "target_group_id",
"config": {
"schema_prefix" : "test_airtable",
"api_key" : "****"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema_prefix | The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
api_key | API key of the Airtable account. |
Authorizationlink
There are three ways to authorize this connector type:
- By specifying the following fields in the request:
- For Airtable enterprise accounts:
api_key
. - For Airtable non-enterprise accounts:
base_id
,table_name
andapi_key
.
- For Airtable enterprise accounts:
- By specifying
client_access
andrefresh_token
in theauth
section. - By using the Connect Card or the Fivetran dashboard.
Alchemer Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "alchemer",
"group_id": "target_group_id",
"config": {
"schema": "alchemer_schema_name",
"query_param_value": "your_alchemer_api_key",
"api_secret_key": "your_alchemer_api_secret_key",
"sub_domain": "Subdomain name like .com,.eu,-ca.com"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
query_param_value | Your Alchemer API key. |
api_secret_key | Your Alchemer API Secret key. |
sub_domain | Your Alchemer subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
query_param_value
,api_secret_key
andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
Algolia Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "algolia",
"group_id": "target_group_id",
"config": {
"schema": "algolia_schema_name",
"region": "your_algolia_region",
"application_id": "your_algolia_application_id",
"api_key": "your_algolia_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
region | Your Algolia Region. |
application_id | Your Algolia Application ID. |
api_key | Your Algolia API Key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
region
,application_id
, andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Amazon Ads link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "amazon_ads",
"group_id": "target_group_id",
"config": {
"schema": "test_amazon_ads",
"region": "NORTH_AMERICA",
"sync_mode": "SpecificProfiles",
"profiles": [12345],
"attribution_window": "DAY_7"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
region | The region used by the Amazon Ads profile. | NORTH_AMERICA , EUROPE , FAR_EAST |
sync_mode | Option to select connector should sync all profiles or specific profiles. | AllProfiles , SpecificProfiles |
profiles | Specific User Profile IDs to sync. Must be populated if sync_mode is set to SpecificProfiles . | |
attribution_window | Time period used to attribute conversions based on clicks. | DAY_1 , DAY_7 , DAY_14 , DAY_30 |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "amazon_ads", "group_id": "target_group_id", "config": { "schema": "test_amazon_ads", "region": "NORTH_AMERICA", "sync_mode": "SpecificProfiles", "profiles": [12345], "attribution_window": "DAY_7" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Amazon Ads client application.client_secret
Client Secret
of your Amazon Ads client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or through the Fivetran dashboard.
Amazon Attribution Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "amazon_attribution",
"group_id": "target_group_id",
"config": {
"schema": "amazon_attribution_schema_name",
"region_api_url": "your_amazon_attribution_region_api_url",
"region_token_url": "your_amazon_attribution_region_token_url",
"region_auth_url": "your_amazon_attribution_region_auth_url"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
region_api_url | Your amazon attribution region api url. |
region_token_url | Your amazon attribution region token url. |
region_auth_url | Your amazon attribution region auth url. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
region_api_url
,region_token_url
,region_auth_url
. - By using the Connect Card or the Fivetran dashboard.
Amazon Kinesis Firehose link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "kinesis",
"group_id": "target_group_id",
"config": {
"schema": "test_kinesis",
"table": "kinesis_table",
"role_arn": "arn::your_role_arn",
"bucket": "aws_region_code",
"prefix": "folder_path",
"json_delivery_mode": "Packed"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
role_arn | The Role ARN required for authentication. | |
bucket | The name of the Kinesis bucket. | |
prefix | Folder path to the Kinesis files within the bucket. | |
json_delivery_mode | Specifies how Fivetran should handle your JSON data. Default value: Packed . | Packed , Unpacked |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
role_arn
andbucket
. - By using the Connect Card or the Fivetran dashboard.
Amazon S3 link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "s3",
"group_id": "target_group_id",
"config": {
"schema": "test_s3",
"table": "table_name",
"bucket": "bucket_name",
"auth_type": "IAM_ROLE",
"external_id": "group_id",
"role_arn": "arn::your_role_arn",
"access_key_id":"access_key_id_value",
"access_key_secret":"access_key_secret_value",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"json_delivery_mode": "Packed",
"compression": "infer",
"on_error": "skip",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0",
"empty_header": "false",
"list_strategy": "complete_listing",
"use_pgp_encryption_options": "true",
"pgp_secret_key": "<secret-key-used>",
"pgp_pass_phrase": "<pass-phrase-used>",
"signer_public_key": "<signer-public-key-used>",
"line_separator": ";"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
bucket | The S3 bucket name. Required for connector creation. | |
auth_type | The S3 Access approach. Required for connector creation. Default value: IAM_ROLE . | IAM_ROLE , ACCESS_KEY , PUBLIC_BUCKET |
external_id | Used for authentication along with the role_arn . If not provided, it uses connector's group_id . Make sure to choose any of the group_id from your Fivetran account as the external_id parameter value. To find the group_id , use the List All Groups endpoint. Required when auth_type is IAM_ROLE . | |
role_arn | The Role ARN. Required for authentication when auth_type is IAM_ROLE . | |
access_key_id | The access key ID. Required for authentication when auth_type is ACCESS_KEY . | |
access_key_secret | The access key secret. Required for authentication when auth_type is ACCESS_KEY . | |
prefix | All files and folders under this folder path will be searched for files to sync. | |
pattern | All files in your search path matching this regular expression will be synced. | |
file_type | If your files are saved with improper extensions, you can force them to be synced as the selected file type. | avro , csv , json , jsonl , log , parquet , tsv |
json_delivery_mode | Specifies how Fivetran should handle your JSON data. Default value: Packed . | Packed , Unpacked |
compression | The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. | bz2 , gz , gzip , tar , tar_bz2 , tar_gz , uncompressed , zip |
on_error | If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option | If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | append_file , upsert_file |
archive_pattern | Files inside compressed archives with filenames matching this regular expression will be synced. | |
null_sequence | If your CSVs use a special value indicating null, you can specify it here. | |
delimiter | You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before | We will skip over the number of lines specified before syncing data. | |
skip_after | We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination. | |
empty_header | If your CSVs are headerless, set this is as true . When true , we will generate generic column names following the convention of column_0 , column_1 , ... column_n to map the rows. Default value: false . | false , true |
list_strategy | The listing strategy you want to use. Default value: complete_listing . | complete_listing , time_based_pattern_listing |
use_pgp_encryption_options | Set to true if files are encrypted using PGP in the S3 bucket. Default value: false . | false , true |
pgp_secret_key | The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true . | |
pgp_pass_phrase | The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true . | |
signer_public_key | The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. | |
line_separator | You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the value for the
bucket
field along with the following fields depending on theauth_type
:- If
IAM_ROLE
, specify values for theexternal_id
androle_arn
fields. - If
ACCESS_KEY
, specify values for theaccess_key_id
andaccess_key_secret
fields.
- If
By using the Connect Card or the Fivetran dashboard.
Amazon Selling Partner Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "amazon_selling_partner",
"group_id": "target_group_id",
"config": {
"schema": "test_amazon_selling_partner",
"region": "NORTH_AMERICA",
"merchant_id" : "test_merchant_id",
"is_vendor" :false
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
region | The region used by the Amazon Selling Partner profile. | NORTH_AMERICA , EUROPE , FAR_EAST |
merchant_id | The Merchant ID or Vendor Code. | |
is_vendor | Whether or not you have a Vendor Account. Default value: false . | true , false |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the following parameters in the
auth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "amazon_selling_partner", "group_id": "target_group_id", "config": { "schema": "test_amazon_selling_partner", "region": "NORTH_AMERICA", "merchant_id" : "test_merchant_id", "is_vendor" : false }, "auth": { "aws_access_key" : "my_aws_access_key", "aws_secret_key" : "my_aws_secret_key", "role_arn" : "my_iam_role_arn", "client_id": "my_client_id", "client_secret": "my_client_secret", "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description aws_access_key
AWS Access Key
of your AWS Account User.aws_secret_key
AWS Secret Key
of your AWS Account User.role_arn
IAM Role ARN
of your AWS Account.client_id
Client ID
of your Amazon Seller/Vendor Central client application.client_secret
Client Secret
of your Amazon Seller/Vendor Central client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Amplitude link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "amplitude",
"group_id": "target_group_id",
"config": {
"schema": "test_amplitude",
"project_credentials": [
{
"project": "projectName1",
"api_key": "apiKey1",
"secret_key": "secretKey1"
},
{
"project": "projectName2",
"api_key": "apiKey2",
"secret_key": "secretKey2"
}
]
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
project | The project name you wish to use with Fivetran. |
api_key | The API key of the project. |
secret_key | The secret key of the project. |
Authorizationlink
There are two ways to authorize this connector type:
- When creating by specifying a value for the following field in the request:
projects
; - After creation using the Connect Card or the Fivetran dashboard.
Anaplan link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "anaplan",
"group_id": "target_group_id",
"config": {
"schema": "test_anaplan",
"auth_mode": "basic",
"username": "username",
"password": "password",
"certificate": "xxxxx-xxxxx-xxxxx-xxxxx",
"private_key": "your_api_secret",
"sync_mode": "SpecificExports",
"selected_exports": [ "8a81b00f68d4b4c50168dc49db4520d4_4CCDDEC7E28C4D3CA4212986182B8EB1_116000000000" ]
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
auth_mode | The Anaplan authentication method. | Basic , Certificate |
username | Your Anaplan user ID. Must be populated if auth_mode is set to Basic . | |
password | Your Anaplan password. Must be populated if auth_mode is set to Basic . | |
certificate | The contents of your PEM certificate file. Must be populated if auth_mode is set to Certificate . | |
private_key | The contents of your private key file. Must be populated if auth_mode is set to Certificate . | |
sync_mode | Whether to sync all exports or specific exports. | AllExports , SpecificExports |
selected_exports | The list of export IDs in the format <workspace_id>_<model_id>_<export_id> that the connector will sync. Must be populated if sync_mode is set to SpecificExports . |
Authorizationlink
There are two ways to authorize this connector type:
When creating, depending on the
auth-mode
:- If
Basic
, by specifying the values for theusername
andpassword
fields. - If
Certificate
, by specifying the values for thecertificate
andprivate_key
fields.
- If
After creation using the Connect Card or the Fivetran dashboard.
Apache Kafka link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "apache_kafka",
"group_id": "target_group_id",
"config": {
"schema": "test_apache_kafka",
"consumer_group": "consumer_group",
"servers": "serveraddress1:8080, serveraddress2:8080",
"message_type": "Json",
"sync_type": "Packed",
"security_protocol": "SSL"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
consumer_group | Kafka consumer group name. | |
servers | Comma-separated list of Kafka servers in the format server:port . | |
message_type | Kafka message type. | Json , Text |
sync_type | Kafka sync type. Unpacked messages must be valid JSON. | Unpacked , Packed |
security_protocol | Security protocol for Kafka interaction. | PLAINTEXT , SSL |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
consumer_group
andservers
. - By using the Connect Card or the Fivetran dashboard.
Appcues Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "appcues",
"group_id": "target_group_id",
"config": {
"schema": "appcues_schema_name",
"api_key": "your_appcues_api_key",
"secret": "your_appcues_secret",
"account_id": "your_appcues_account_id",
"email": "your_appcues_email"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Appcues API key. |
secret | Your Appcues Secret. |
account_id | Your Appcues Account ID. |
email | Your Appcues Email. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_key
,secret
,account_id
andemail
. - By using the Connect Card or the Fivetran dashboard.
Appfigures Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "appfigures",
"group_id": "target_group_id",
"config": {
"schema": "appfigures_schema_name",
"client_key": "your_appfigures_client_key",
"username": "your_appfigures_username",
"password": "your_appfigures_password"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_key | Your Appfigures client key. |
username | Your Appfigures username. |
password | Your Appfigures password. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_key
,username
, andpassword
. - By using the Connect Card or the Fivetran dashboard.
Apple App Store link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "itunes_connect",
"group_id": "target_group_id",
"config": {
"schema": "itunes_connect",
"username": "user",
"password": "password",
"app_specific_password": "your_app_specific_password",
"apps": ["iTunes_app"],
"sales_accounts": ["iTunes_sales_account"],
"finance_accounts": ["iTunes_finance_account"],
"app_sync_mode" : "SpecificApps",
"sales_account_sync_mode": "SpecificSalesAccounts",
"finance_account_sync_mode": "SpecificFinanceAccounts",
"timeframe_months": "THREE"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
username | Your Apple ID | |
password | Your password | |
app_specific_password | Your app-specific password | |
apps | Specific apps to sync. Must be populated if app_sync_mode is set to SpecificApps . | |
sales_accounts | Specific sales account to sync. Must be populated if sales_account_sync_mode is set to SpecificSalesAccounts . | |
finance_accounts | Specific finance accounts to sync. Must be populated if finance_account_sync_mode is set to SpecificFinanceAccounts . | |
app_sync_mode | Whether to sync all apps or specific apps. | AllApps , SpecificApps |
sales_account_sync_mode | Whether to sync all sales accounts or specific sales accounts. | AllSalesAccounts , SpecificSalesAccounts |
finance_account_sync_mode | Whether to sync all finance accounts or specific finance accounts. | AllFinanceAccounts , SpecificFinanceAccounts |
timeframe_months | Historical sync time frame in months. | THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Apple Search Ads link
The following example allows you to create a new connector without authorization. If you want to authorize your connector during its creation, use one of the possible authorization methods in the Authorization section.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "apple_search_ads",
"group_id": "target_group_id",
"config": {
"schema" : "apple_search_ads"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
is_auth2_enabled | The contents of your PEM certificate file. Default value: false | true , false |
pem_certificate | The contents of your PEM certificate file. Must be populated if is_auth2_enabled is set to false . | |
private_key | The contents of your secret key file. Must be populated if is_auth2_enabled is set to false . | |
client_id | Apple Search Ads REST API Client ID. Must be populated if is_auth2_enabled is set to true . | |
team_id | Apple Search Ads REST API Team ID. Must be populated if is_auth2_enabled is set to true . | |
key_id | Apple Search Ads REST API Key ID. Must be populated if is_auth2_enabled is set to true . | |
pem_private_key | The contents of your PEM secret key file. Must be populated if is_auth2_enabled is set to true . | |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE . | THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Authorizationlink
There are three ways to authorize this connector type:
By specifying the values for the
pem_certificate
andprivate_key
fields in the request.POST https://api.fivetran.com/v1/connectors
{ "service": "apple_search_ads", "group_id": "target_group_id", "config": { "schema": "apple_search_ads", "pem_certificate": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "private_key": "your_api_secret" } }
content_copyBy specifying
is_auth2_enabled
astrue
and specifying values for the following fieldsclient_id
,team_id
,key_id
andpem_private_key
.POST https://api.fivetran.com/v1/connectors
{ "service": "apple_search_ads", "group_id": "target_group_id", "config": { "schema": "apple_search_ads", "is_auth2_enabled": true, "pem_private_key": "your_api_secret", "client_id": "your_api_client_id", "team_id": "your_api_team_id", "key_id": "your_api_key_id", "timeframe_months": "TWELVE" } }
content_copyBy using the Connect Card or the Fivetran dashboard.
AppsFlyer link
Requestlink
POST https://api.fivetran.com/v1/connectors
Sync using webhooks and Data Lockerlink
{
"service": "appsflyer",
"group_id": "target_group_id",
"config": {
"schema": "test_appsflyer",
"access_key_id": "your_access_key_id",
"secret_key": "your_secret_key",
"home_folder": "your_home_folder",
"connection_name": "your_connection_name",
"sync_data_locker": true,
"use_customer_bucket": true,
"bucket": "af-datalocker-your-bucket-name",
"role_arn": "role_arn_value"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
access_key_id | Your AWS access key ID. |
secret_key | Your AWS secret key. |
home_folder | Your S3 home folder path of the Data Locker. |
connection_name | Your Data Locker Connection Name. Default value: data-locker-hourly/ . |
sync_data_locker | Select true to sync AppsFlyer data using webhooks and Data Locker. |
use_customer_bucket | Use Custom S3 Bucket. Should be set to true if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket. |
bucket | Customer S3 Bucket. |
role_arn | S3 Role ARN. |
Sync using webhooks and Pull APIlink
{
"service": "appsflyer",
"group_id": "target_group_id",
"config": {
"schema": "test_appsflyer",
"sync_data_locker": false,
"sync_pull_api": true,
"api_token": "your_appsflyer_api_token",
"app_ids": [
{"app_id": "appID1"},
{"app_id": "appID2"}
]
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sync_data_locker | Select false to sync AppsFlyer data using webhooks and Pull API. |
sync_pull_api | Select true to sync AppsFlyer data using webhooks and Pull API. |
api_token | Your AppsFlyer API token. |
app_ids | List of App IDs. |
app_id | Your App ID. |
Sync using only webhookslink
{
"service": "appsflyer",
"group_id": "target_group_id",
"config": {
"schema": "test_appsflyer",
"sync_data_locker": false
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sync_data_locker | Select false to sync AppsFlyer data using only webhooks. |
Authorizationlink
There are three ways to authorize this connector type:
- By specifying the values for the following fields in the request:
access_key_id
,secret_key
,home_folder
andconnection_name
, if you are connecting using webhooks and Data Locker. - By specifying the field
sync_data_locker
asfalse
, if you are connecting using only webhooks. - By using the Connect Card or the Fivetran dashboard.
Asana link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "asana",
"group_id": "target_group_id",
"config": {
"schema": "test_asana",
"sync_mode": "SpecificProjects",
"projects": ["12345678", "23456789"]
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode | Whether to sync all projects or specific projects. | AllProjects , SpecificProjects |
projects | Specific Project IDs to sync. Must be populated if syncMode is set to SpecificProjects . |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "asana", "group_id": "target_group_id", "config": { "schema": "test_asana", "sync_mode": "SpecificProjects", "projects": ["12345678", "23456789"] }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
| Name | Description | |---|---| |
client_id
|Client ID
of your Asana client application. | |client_secret
|Client Secret
of your Asana client application. | |refresh_token
| The long-livedRefresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. |By using the Connect Card or through the Fivetran dashboard.
Assembled Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "assembled",
"group_id": "target_group_id",
"config": {
"schema": "assembled_schema_name",
"api_key": "your_assembled_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Assembled API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key
. - By using the Connect Card or the Fivetran dashboard.
Attentive Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "attentive",
"group_id": "target_group_id",
"config": {
"schema": "attentive_schema_name",
"api_key": "your_attentive_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Attentive API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Attio Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "attio",
"group_id": "target_group_id",
"config": {
"schema": "attio_schema_name",
"access_token": "your_attio_access_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
access_token | Your Attio access token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
access_token
field in the request. - By using the Connect Card or the Fivetran dashboard.
Aumni Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aumni",
"group_id": "target_group_id",
"config": {
"schema": "aumni_schema_name",
"api_key": "your_aumni_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Aumni API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Auth0 Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "auth0",
"group_id": "target_group_id",
"config": {
"schema": "auth0_schema_name",
"client_id": "your_auth0_client_id",
"client_secret": "your_auth0_client_secret",
"domain": "your_auth0_domain",
"audience": "your_auth0_audience"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id | Your Auth0 client ID. |
client_secret | Your Auth0 client Secret. |
domain | Your Auth0 domain. |
audience | Your Auth0 API audience. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id
,client_secret
,domain
andaudience
. - By using the Connect Card or the Fivetran dashboard.
Autodesk BIM 360 Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "autodesk_bim_360",
"group_id": "target_group_id",
"config": {
"schema": "autodesk_bim_360_schema_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
parameter in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "autodesk_bim_360", "group_id": "target_group_id", "config": { "schema": "autodesk_bim_360_schema_name" }, "auth": { "client_access": { "client_id": "autodesk_bim_360_client_id", "client_secret": "autodesk_bim_360_client_secret" }, "refresh_token": "your_refresh_token", "access_token": "your_access_token" } }
content_copyAuth parameterslink
Name Description client_access.client_id
Your Autodesk BIM 360 client ID. client_access.client_secret
Your Autodesk BIM 360 client secret. refresh_token
Your Autodesk BIM 360 refresh token. access_token
Your Autodesk BIM 360 access token. By using the Connect Card or the Fivetran dashboard.
AvantLink Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "avantlink",
"group_id": "target_group_id",
"config": {
"schema": "avantlink_schema_name",
"api_key": "your_avantlink_api_key",
"merchant_id": "your_avantlink_merchant_id"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your AvantLink API key |
merchant_id | Your AvantLink merchant ID. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key
andmerchant_id
. - By using the Connect Card or the Fivetran dashboard.
Awin Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "awin",
"group_id": "target_group_id",
"config": {
"schema": "awin_schema_name",
"api_token": "your_awin_api_token",
"region": "your_awin_region"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_token | Your Awin API token. |
region | Your Awin region. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_token
andregion
. - By using the Connect Card or the Fivetran dashboard.
AWS CloudTrail link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aws_cloudtrail",
"group_id": "1k56c2c4xlti6",
"config": {
"schema": "aws_cloudtrail_1",
"external_id": "1k56c2c4xlti6",
"bucket" : "fivetran-cloudtrail",
"role_arn": "arn:aws:iam::***********",
"prefix" : "test_prefix"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
external_id | This is the same as your group_id , used for authentication along with the role_arn . |
role_arn | The Role ARN required for authentication. |
bucket | The AWS bucket name which is configured for AWS CloudTrail. |
prefix | If prefix is present when configuring the bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
external_id
,role_arn
andbucket
. - By using the Connect Card or the Fivetran dashboard.
AWS Cost Explorer Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aws_cost",
"group_id": "target_group_id",
"config": {
"schema": "aws_cost",
"role_arn": "arn::your_role_arn"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
role_arn | The Role ARN required for authentication. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
role_arn
. - By using the Connect Card or the Fivetran dashboard.
AWS Inventory link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aws_inventory",
"group_id": "target_group_id",
"config": {
"schema": "test_aws_inventory",
"bucket" : "fivetran-config",
"role_arn": "arn:aws:iam::***********",
"prefix" : "test_prefix"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
role_arn | The Role ARN required for authentication. |
bucket | The AWS bucket name that is configured for AWS Config. |
prefix | The prefix if you used one when configuring the bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
role_arn
andbucket
. - By using the Connect Card or the Fivetran dashboard.
AWS Lambda link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aws_lambda",
"group_id": "target_group_id",
"config": {
"schema": "test_lambda",
"function": "function_name",
"sync_method": "DIRECT",
"role_arn": "arn::your_role_arn",
"bucket": "bucket",
"external_id": "group_id",
"region": "aws_region_code",
"is_privatelink_required" : "false",
"secrets_list": [
{"key": "secret1", "value": "xxxxxxx"},
{"key": "secret2", "value": "xxxxxxx"}
],
"custom_payloads": [
{"key": "payload1", "value": "payload_value2"},
{"key": "payload2", "value": "payload_value2"}
]
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
function | The name of your AWS Lambda Function. | |
sync_method | The sync method. Default value: DIRECT . | DIRECT , CLOUD_STORAGE |
role_arn | The Role ARN required for authentication. | |
s3bucket | The S3 bucket name. | |
external_id | This is the same as your group_id , used for authentication along with the role_arn . | |
region | The AWS region code. For example, us-east-1 . | |
is_privatelink_required | Connect using AWS PrivateLink. | true , false |
secrets_list | The list of secrets that should be passed to the function at runtime. | |
custom_payloads | (Optional) The list of key-value pairs that can be used to specify custom information to the function at runtime. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the following fields in the request:
function
,role_arn
andsecrets_list
.By using the Connect Card or the Fivetran dashboard.
AWS MSK link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aws_msk",
"group_id": "target_group_id",
"config": {
"schema": "test_msk",
"consumer_group": "consumer_group",
"servers": ["serveraddress1:8080", "serveraddress2:8080"],
"message_type": "Json",
"sync_type": "Packed",
"security_protocol": "SASL",
"sasl_mechanism" : "SCRAM_SHA_512",
"sasl_scram512_key": "sasl_key",
"sasl_scram512_secret": "sasl_secret",
"external_id": "group_id",
"role_arn": "arn::your_role_arn",
"truststore": "test_truststore",
"keystore": "test_keystore",
"keystore_password": "keystore_password",
"key_password": "key_password",
"connection_method": "direct"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
consumer_group | The name of consumer group created for Fivetran. | |
servers | Comma-separated list of Kafka servers in the server:port format. | |
message_type | The Message type. | Json , Avro , Text , Protobuf |
sync_type | The sync type. Unpacked messages must be valid JSON. | Packed , Unpacked |
security_protocol | The security protocol for Kafka interaction. | PLAINTEXT , TLS , SASL |
sasl_mechanism | If security_protocol is set to SASL , enter the SASL Mechanism. | SCRAM_SHA_512 , IAM |
sasl_scram512_key | If sasl_mechanism is set to SCRAM_SHA_512 , enter your secret's saslScram512Key . | |
sasl_scram512_secret | If sasl_mechanism is set to SCRAM_SHA_512 , enter your secret's saslScram512Key . | |
external_id | Used for authentication along with the role_arn . If not provided, it uses connector's group_id . Make sure to choose any of the group_id from your Fivetran account as the external_id parameter value. To find the group_id , use the List All Groups endpoint. This is required when sasl_mechanism is set to IAM . | |
role_arn | If sasl_mechanism is set to IAM , enter your Role ARN | |
truststore | If security_protocol is set to TLS , add the Truststore File as a Base64-encoded string. | |
keystore | If security_protocol is set to TLS , add the Keystore File as a Base64-encoded string. | |
keystore_password | If security_protocol is set to TLS , enter your Keystore Password . | |
key_password | If security_protocol is set to TLS , enter your Key Password . | |
connection_method | The connection method. Default value: direct . | direct , privatelink |
Authorizationlink
There are two ways to authorize this connector type:
By passing the security protocol secrets:
- If you select
TLS
as Security Protocol, upload theTrusted Certificate
,Client Certificate
, andClient Certificate Key
files. - If you select
SASL
as Security Protocol andSCRAM_SHA_512
as SASL Mechanism, enter your secret'ssaslScram512Key
andsaslScram512Secret
. - If you select
SASL
as Security Protocol andIAM
as SASL Mechanism, enter yourExternal ID
andRole ARN
.
- If you select
By using the Connect Card or the Fivetran dashboard.
Azure Blob Storage link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "azure_blob_storage",
"group_id": "target_group_id",
"config": {
"schema": "test_azure_blob_storage",
"table": "table_name",
"container_name": "container_name",
"connection_string": "BlobEndpoint=https://abc123.blob.core.windows.net/;TableEndpoint=https://abc123.table.core.windows.net/;SharedAccessSignature=xxxxxxxxx",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"json_delivery_mode": "Packed",
"compression": "infer",
"on_error": "skip",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0",
"connection_method": "SSH_TUNNEL",
"container_address": "192.168.0.1",
"host_ip": "192.168.0.2",
"host_user": "host_username",
"use_pgp_encryption_options": "false",
"pgp_secret_key": "<secret-key-used>",
"pgp_pass_phrase": "<pass-phrase-used>",
"signer_public_key": "<signer-public-key-used>",
"line_separator": ";"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
container_name | The name of the blob container. | |
connection_string | The blob storage container connection string. | |
prefix | All files and folders under this folder path will be searched for files to sync. | |
pattern | All files in your search path matching this regular expression will be synced. | |
file_type | If your files are saved with improper extensions, you can force them to by synced as the selected file type. | infer , csv , json , tsv , avro |
json_delivery_mode | Specifies how Fivetran should handle your JSON data. Default value: Packed . | Packed , Unpacked |
compression | The secrets that should be passed to the function at runtime. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error | If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option | If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern | Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence | If your CSVs use a special value indicating null, you can specify it here. | |
delimiter | You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before | We will skip over the number of lines specified before syncing data. | |
skip_after | We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. | |
connection_method | Connection Method. | DIRECT : Fivetran will connect directly to your storage container,SSH_TUNNEL : Fivetran will connect to your storage container using a host machine (commonly used for VPN connections),PRIVATE_LINK : Fivetran will connect to your storage container using PrivateLink. |
container_address | IP Address of Azure Storage Container which is accessible from host machine. | |
host_ip | IP address of host tunnel machine which is used to connect to Storage Container. | |
host_user | Username in the host machine. | |
use_pgp_encryption_options | Set to true if files present in the Azure Blob Storage container are encrypted using PGP. Default value: false . | false , true |
pgp_secret_key | The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true . | |
pgp_pass_phrase | The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true . | |
signer_public_key | The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. | |
line_separator | You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
container_name
andconnection_string
. - By using the Connect Card or the Fivetran dashboard.
Azure Boards Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "azure_boards",
"group_id": "target_group_id",
"config": {
"schema": "azure_boards_schema_name",
"sub_domain": "your_azure_boards_organization_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | Your Azure Boards Organization Name. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
parameter in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "azure_boards", "group_id": "target_group_id", "config": { "schema": "azure_boards_schema_name", "sub_domain": "your_azure_boards_organization_name" }, "auth": { "client_access": { "client_id": "your_azure_boards_client_id", "client_secret": "your_azure_boards_client_secret" } } }
content_copyAuth parameterslink
Name Description client_access.client_id
Your Azure Boards Client ID. client_access.client_secret
Your Azure Boards Client Secret. By using the Connect Card or the Fivetran dashboard.
Azure Devops Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "azure_devops",
"group_id": "target_group_id",
"config": {
"schema": "azure_devops_schema_name",
"sub_domain": "your_azure_devops_organization_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | Your Azure Devops Organization Name. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
parameter in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "azure_devops", "group_id": "target_group_id", "config": { "schema": "azure_devops_schema_name", "sub_domain": "your_azure_devops_organization_name" }, "auth": { "client_access": { "client_id": "your_azure_devops_client_id", "client_secret": "your_azure_devops_client_secret" } } }
content_copyAuth parameterslink
Name Description client_access.client_id
Your Azure Devops Client ID. client_access.client_secret
Your Azure Devops Client Secret. By using the Connect Card or the Fivetran dashboard.
Azure Functions link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "azure_function",
"group_id": "target_group_id",
"config": {
"schema": "test_azure_function",
"function_app": "function_app_name",
"function_name": "function_name",
"function_key": "function_key",
"secrets_list": [
{"key": "secret1", "value": "xxxxxxx"},
{"key": "secret2", "value": "xxxxxxx"}
],
"custom_payloads": [
{"key": "payload1", "value": "payload_value2"},
{"key": "payload2", "value": "payload_value2"}
],
"connection_method": "DIRECT"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
function_app | Function app name in Azure portal. | |
function_name | Name of the function to be triggered. | |
function_key | Function key used for authorization. | |
secrets_list | The list of secrets that should be passed to the function at runtime. | |
custom_payloads | (Optional) The list of key-value pairs that can be used to specify custom information to the function at runtime. | |
connection_method | The Fivetran connection method to your function. | DIRECT : Fivetran connects directly to your function, PRIVATE_LINK : Fivetran connects to your function using PrivateLink. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
function_app
,function_name
,function_key
andsecrets
. - By using the Connect Card or the Fivetran dashboard.
Azure Event Hubs link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "azure_event_hub",
"group_id": "target_group_id",
"config": {
"schema": "test_azure_event_hub",
"consumer_group": "consumer_group",
"connection_string": "connection_string",
"message_type": "Json",
"sync_type": "Packed"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
connection_string | Connection string of the Event Hub Namespace you want to sync. | |
consumer_group | Name of consumer group created for Fivetran. | |
message_type | Message type. | Json , Text |
sync_type | Sync type. Unpacked messages must be valid JSON. | Packed , Unpacked |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the
connection_string
andconsumer_group
fields in the request. - By using the Connect Card or the Fivetran dashboard.
BallotReady Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "ballotready",
"group_id": "target_group_id",
"config": {
"schema": "ballotready_schema_name",
"api_key": "your_ballotready_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your BallotReady GraphQL API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
BambooHR link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "bamboohr",
"group_id": "target_group_id",
"config": {
"schema": "bamboohr_schema_name",
"subdomain": "your_subdomain",
"api_key": "your_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
subdomain | The subdomain used to access your account. If you access BambooHR at mycompany.bamboohr.com , then the subdomain is mycompany . |
api_key | Your API Key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
subdomain
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
BigQuery Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "bigquery_db",
"group_id": "target_group_id",
"config": {
"schema_prefix": "schema_prefix",
"project_id": "projectId",
"data_set_name": "dataSetName",
"secret_key": "secretKey",
"use_service_account": "false"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema_prefix | The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
project_id | BigQuery project ID. |
data_set_name | BigQuery Data set name |
secret_key | Private key of the customer service account. |
use_service_account | BigQuery use service account. |
Initial Configurationlink
Copy the code snippet into the <head>
section of your web page.
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
BigCommerce Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "big_commerce",
"group_id": "target_group_id",
"config": {
"schema": "big_commerce_schema_name",
"store_hash": "your_store_hash",
"access_token": "your_api_access_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
store_hash | The store hash in your API path. |
access_token | Your API access token . |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
store_hash
andaccess_token
. - By using the Connect Card or the Fivetran dashboard.
BillingPlatform Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "billing_platform",
"group_id": "target_group_id",
"config": {
"schema": "billing_platform_schema_name",
"base_url": "your_billing_platform_base_url"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
base_url | Your BillingPlatform base URL. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the following fields:
client_id
andclient_secret
in theconfig
sectionaccess_token
andrefresh_token
in theauth
section
POST https://api.fivetran.com/v1/connectors
{ "service": "billing_platform", "group_id": "target_group_id", "config": { "schema": "billing_platform_schema_name", "base_url": "your_billing_platform_base_url", "client_id": "billing_platform_client_id", "client_secret": "billing_platform_client_secret" }, "auth": { "refresh_token": "your_refresh_token", "access_token": "your_access_token" } }
content_copyAuth parameterslink
Name Description client_id
Your BillingPlatform client ID. client_secret
Your BillingPlatform client secret. refresh_token
Your BillingPlatform refresh token. access_token
Your BillingPlatform access token. By using the Connect Card or the Fivetran dashboard.
Birdeye Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "birdeye",
"group_id": "target_group_id",
"config": {
"schema": "birdeye_schema_name",
"business_id": "your_birdeye_business_id",
"query_param_value": "your_birdeye_query_param_value"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
business_id | Your Birdeye Business ID. |
query_param_value | Your Birdeye API Key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
business_id
andquery_param_value
. - By using the Connect Card or the Fivetran dashboard.
Bitly Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "bitly",
"group_id": "target_group_id",
"config": {
"schema": "bitly_schema_name",
"access_token": "your_bitly_access_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
access_token | Your Bitly access token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
access_token
field in the request. - By using the Connect Card or the Fivetran dashboard.
Box link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
The connector supports two sync strategies:
Magic Folder Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "box",
"group_id": "target_group_id",
"config": {
"schema": "test_box",
"folder_id": "folder_id"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
folder_id | Your Box Folder URL. |
Merge Mode Requestlink
To use the Merge Mode sync strategy, specify the is_single_table_mode
parameter as true
. If you don't specify the parameter, we will use the default Magic Folder strategy to sync files.
POST https://api.fivetran.com/v1/connectors
{
"service": "box",
"group_id": "target_group_id",
"config": {
"schema": "test_box",
"table": "test_table",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"json_delivery_mode": "Packed",
"compression": "infer",
"on_error": "fail",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "|",
"escape_char": "escape_char",
"skip_before": "0",
"skip_after": "0",
"is_single_table_mode": "true",
"line_separator": ";"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema (required) | The connector schema name has to be unique within the group (destination). | |
table (required) | The table name within the schema to which the connector will sync the data. | |
prefix | All files and folders under this folder path will be searched for files to sync. | |
pattern | All files in your search path matching this regular expression will be synced. | |
file_type | If your files are saved with improper extensions, you can force them to be synced as the selected file type. | infer , csv , json , tsv , avro , parquet |
json_delivery_mode | Specifies how Fivetran should handle your JSON data. Default value: Packed . | Packed , Unpacked |
compression | The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error | If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option | If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern | Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence | If your CSVs use a special value indicating null, you can specify it here. | |
delimiter | You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before | We will skip over the number of lines specified before syncing data. | |
skip_after | We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. | |
is_single_table_mode (required as true ) | Allows the creation of connector using Merge Mode strategy. | true , false |
line_separator | You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next. |
Authorizationlink
This type of connector can only be authorised through the Connect Card or the Fivetran dashboard.
Braintree link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "braintree",
"group_id": "target_group_id",
"config": {
"schema": "test_braintree",
"public_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"private_key": "your_api_secret",
"merchant_id": "merchant_id"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
public_key | The contents of your PEM certificate file. |
private_key | The contents of your secret key file. |
merchant_id | Your Braintree merchant ID. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
public_key
,private_key
andmerchant_id
. - By using the Connect Card or the Fivetran dashboard.
Branch link
NOTE: You will need to register the Fivetran-generated webhooks URL in your Branch dashboard. See the Branch setup guide for more details.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "branch",
"group_id": "target_group_id",
"config": {
"schema": "test_branch"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
This type of connector does not require authorization and can be created using the Create a Connector endpoint.
Braze link
Requestlink
POST https://api.fivetran.com/v1/connectors
AWS S3link
{
"service": "braze",
"group_id": "target_group_id",
"config": {
"schema": "test_braze",
"api_url": "test_api_url",
"api_key": "test_api_key",
"cloud_storage_type": "AWS_S3",
"s3bucket": "your_s3_bucket",
"s3role_arn": "arn:aws:iam::XXXXXXXXXXXX:role/your_test_bucket",
"s3external_id": "_moonbeam",
"s3folder": "your_s3_folder"
}
}
content_copy
GCSlink
{
"service": "braze",
"group_id": "target_group_id",
"config": {
"schema": "test_braze",
"api_url": "test_api_url",
"api_key": "test_api_key",
"cloud_storage_type": "GCS",
"gcs_bucket": "your_gcs_bucket",
"gcs_folder": "your_gcs_folder"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
api_url | Your Braze API URL. | |
api_key | Your Braze API Key. | |
cloud_storage_type | Cloud storage type Braze Current is connected to. | AWS_S3 , GCS |
s3bucket | Your S3 bucket required if AWS_S3 is the cloud_storage_type | |
s3role_arn | The Role ARN required for authentication required if AWS_S3 is the cloud_storage_type | |
s3external_id | This is the same as your group_id , used for authentication along with the role_arn required if AWS_S3 is the cloud_storage_type | |
s3folder | Your S3 folder name required if AWS_S3 is the cloud_storage_type | |
gcs_bucket | Your GCS bucket. Required if GCS is the cloud_storage_type | |
gcs_folder | Your GCS folder name. Required if GCS is the cloud_storage_type |
NOTE: If
GCS
cloud storage type is being used, then you will need to grant Fivetran access to your Google Cloud Storage bucket.
Authorizationlink
There are three ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_url
,api_key
,s3bucket
,s3role_arn
,s3external_id
ands3folder
, ifcloud_storage_type
is set toAWS_S3
. - By specifying the values for the following fields in the request:
api_url
,api_key
,gcs_bucket
andgcs_folder
, ifcloud_storage_type
is set toGCS
. - By using the Connect Card or the Fivetran dashboard.
Brevo Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "brevo",
"group_id": "target_group_id",
"config": {
"schema": "brevo_schema_name",
"api_key": "your_brevo_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Brevo API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Brex Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "brex",
"group_id": "target_group_id",
"config": {
"schema": "brex_schema_name",
"api_token": "your_brex_api_token",
"base_url": "your_brex_base_url"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_token | Your Brex API token |
base_url | Your Brex Base URL |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_token
andbase_url
. - By using the Connect Card or the Fivetran dashboard.
Buzzsprout Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "buzzsprout",
"group_id": "target_group_id",
"config": {
"schema": "buzzsprout_schema_name",
"api_token": "your_buzzsprout_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_token | Your Buzzsprout API token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_token
field in the request. - By using the Connect Card or the Fivetran dashboard.
Calabrio Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "calabrio",
"group_id": "target_group_id",
"config": {
"schema": "calabrio_schema_name",
"domain_name": "your_calabrio_domain_name",
"access_token": "your_calabrio_access_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
domain_name | Your Calabrio domain name. |
access_token | Your Calabrio access token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
domain_name
andaccess_token
. - By using the Connect Card or the Fivetran dashboard.
Calendly Lite link
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
auth
section:client_access
,refresh_token
andaccess_token
POST https://api.fivetran.com/v1/connectors
{ "service": "calendly", "group_id": "target_group_id", "config": { "schema": "calendly_schema_name" }, "auth": { "client_access": { "client_id": "your_calendly_client_id", "client_secret": "your_calendly_client_secret" }, "refresh_token": "calendly_refresh_token", "access_token": "calendly_access_token" } }
content_copyAuth parameterslink
Name Description client_id
Your Calendly Client ID. client_secret
Your Calendly Client Secret. refresh_token
Your Calendly refresh token. access_token
Your Calendly access token. By using the Connect Card or the Fivetran dashboard.
Canny Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "canny",
"group_id": "target_group_id",
"config": {
"schema": "canny_schema_name",
"api_key": "your_canny_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Canny API key. |
Authorizationlink
- By specifying the value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Care Quality Commission Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "care_quality_commission",
"group_id": "target_group_id",
"config": {
"schema": "care_quality_commission_schema_name",
"partner_code": "your_care_quality_commission_partner_code"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
partner_code | Your Care Quality Commission partner code. |
Authorizationlink
- By specifying a value for the
partner_code
field in the request. - By using the Connect Card or the Fivetran dashboard.
Castor EDC Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "castor_edc",
"group_id": "target_group_id",
"config": {
"schema": "castor_edc_schema_name",
"server": "your_castor_edc_server",
"client_id": "your_castor_edc_client_id",
"client_secret": "your_castor_edc_client_secret"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
server | Your Castor EDC server. |
client_id | Your Castor EDC client ID. |
client_secret | Your Castor EDC client secret. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the following fields in the request:
server
,client_id
, andclient_secret
.By using the Connect Card or the Fivetran dashboard.
Ceridian Dayforce Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "ceridian_dayforce",
"group_id": "target_group_id",
"config": {
"schema": "ceridian_dayforce_schema_name",
"client_namespace": "your_ceridian_dayforce_client_namespace",
"client_host": "your_ceridian_dayforce_client_host",
"username": "your_ceridian_dayforce_username",
"password": "your_ceridian_dayforce_password"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_namespace | Your Ceridian Dayforce client namespace. |
client_host | Your Ceridian Dayforce client host. |
username | Your Ceridian Dayforce username. |
password | Your Ceridian Dayforce password. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_namespace
,client_host
,username
, andpassword
. - By using the Connect Card or the Fivetran dashboard.
ChannelAdvisor link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "channel_advisor",
"group_id": "target_group_id",
"config": {
"schema": "channel_advisor_schema_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
parameter in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "channel_advisor", "group_id": "target_group_id", "config": { "schema": "channel_advisor_schema_name" }, "auth": { "client_access": { "client_id": "your_channel_advisor_client_id", "client_secret": "your_channel_advisor_client_secret" } } }
content_copyAuth parameterslink
Name Description client_access.client_id
Your ChannelAdvisor Client ID. client_access.client_secret
Your ChannelAdvisor Client Secret. By using the Connect Card or the Fivetran dashboard.
Chargebee Product Catalog 1.0 Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "chargebee_product_catalog_1",
"group_id": "target_group_id",
"config": {
"schema": "chargebee_schema_name",
"sub_domain": "http://your.sub.domain/",
"api_key": "your_chargebee_API_key",
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | Your Chargebee Product Catalog 1 subdomain. |
api_key | Your Chargebee Product Catalog 1 API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
sub_domain
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Chargebee Product Catalog 2.0 Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "chargebee_product_catalog_2",
"group_id": "target_group_id",
"config": {
"schema": "chargebee_schema_name",
"sub_domain": "http://your_chargebee_subdomain/",
"api_key": "your_chargebee_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | Your Chargebee subdomain. |
api_key | Your Chargebee API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
sub_domain
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
ChargeDesk Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "chargedesk",
"group_id": "target_group_id",
"config": {
"schema": "chargedesk_schema_name",
"token_id": "your_chargedesk_token_id"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
token_id | Your ChargeDesk token ID. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
token_id
field in the request. - By using the Connect Card or the Fivetran dashboard.
Checkout.com Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "checkout",
"group_id": "target_group_id",
"config": {
"schema": "checkoutcom_schema_name",
"environment": "your_checkoutcom_environment",
"access_key_id": "your_checkoutcom_access_key_id",
"access_key_secret": "your_checkoutcom_access_key_secret",
"entity_id": "your_checkoutcom_entity_id"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
environment | Your Checkout.com Environment. |
access_key_id | Your Checkout.com Access key ID. |
access_key_secret | Your Checkout.com Access key secret. |
entity_id | Your Checkout.com Entity ID. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
environment
,access_key_id
,access_key_secret
andentity_id
. - By using the Connect Card or the Fivetran dashboard.
Churnkey Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "churnkey",
"group_id": "target_group_id",
"config": {
"schema": "churnkey_schema_name",
"api_key": "your_churnkey_api_key",
"app_id": "your_churnkey_app_id"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Churnkey API Key. |
app_id | Your Churnkey APP ID. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_key
andapp_id
. - By using the Connect Card or the Fivetran dashboard.
ChurnZero Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "churnzero",
"group_id": "target_group_id",
"config": {
"schema": "churnzero_schema_name",
"subdomain": "your_churnzero_subdomain",
"username": "your_churnzero_username",
"api_key": "your_churnzero_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
subdomain | Your ChurnZero subdomain. |
username | Your ChurnZero username. |
api_key | Your ChurnZero API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
subdomain
,username
, andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Cimis Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "cimis",
"group_id": "target_group_id",
"config": {
"schema": "cimis_schema_name",
"api_key": "your_cimis_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Cimis API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key
. - By using the Connect Card or the Fivetran dashboard.
Cin7 Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "cin7",
"group_id": "target_group_id",
"config": {
"schema": "cin7_schema_name",
"username": "your_cin7_api_username",
"password": "your_cin7_api_password"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
username | Your Cin7 API Username. |
password | Your Cin7 API Key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username
andpassword
. - By using the Connect Card or the Fivetran dashboard.
CircleCI Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "circleci",
"group_id": "target_group_id",
"config": {
"schema": "circleci_schema_name",
"api_key": "your_circleci_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your CircleCI API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Clari Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "clari",
"group_id": "target_group_id",
"config": {
"schema": "clari_schema_name",
"forecast_id": "your_clari_forecast_id",
"api_token": "your_clari_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
forecast_id | Your Clari forecast ID. |
api_token | Your Clari API token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_token
andforecast_id
. - By using the Connect Card or the Fivetran dashboard.
ClickUp Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "clickup",
"group_id": "target_group_id",
"config": {
"schema": "clickup_schema_name",
"api_key": "your_clickup_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your ClickUp API token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
CloudFront link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "cloudfront",
"group_id": "target_group_id",
"config": {
"schema": "test_cloudfront",
"external_id": "group_id",
"role_arn": "arn::your_role_arn",
"bucket": "bucket_name",
"prefix": "cloudfront_folder"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
external_id | This is the same as your group_id , used for authentication along with the role_arn . |
role_arn | The Role ARN required for authentication. |
bucket | The bucket name for CloudFront. |
prefix | The name of the CloudFront folder in the bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
external_id
,role_arn
,bucket
andprefix
. - By using the Connect Card or the Fivetran dashboard.
Codefresh Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "codefresh",
"group_id": "target_group_id",
"config": {
"schema": "codefresh_schema_name",
"api_key": "your_codefresh_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Codefresh API Key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Collibra Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "collibra",
"group_id": "target_group_id",
"config": {
"schema": "collibra_schema_name",
"username": "your_collibra_username",
"password": "your_collibra_password",
"sub_domain": "your_collibra_subdomain"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
username | Your Collibra username. |
password | Your Collibra password. |
sub_domain | Your Collibra subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
user_name
,password
andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
Coassemble Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "coassemble",
"group_id": "target_group_id",
"config": {
"schema": "coassemble_schema_name",
"api_key": "your_coassemble_api_key",
"user_id": "your_coassemble_user_id",
"host_name": "your_coassemble_host_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Coassemble API key. |
user_id | Your Coassemble user ID. |
host_name | Your Coassemble hostname. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values of following fields in the request:
api_key
,user_id
andhost_name
. - By using the Connect Card or the Fivetran dashboard.
Confluence Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "confluence",
"group_id": "target_group_id",
"config": {
"schema": "confluence_schema_name",
"username": "your_email",
"sub_domain": "your_organization_name",
"password": "your_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
username | Your Confluence email address. |
sub_domain | Your Confluence Organization name. |
password | The Confluence API token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username
,sub_domain
andpassword
. - By using the Connect Card or the Fivetran dashboard.
Confluent Cloud link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "confluent_cloud",
"group_id": "target_group_id",
"config": {
"schema": "test_confluent_cloud",
"consumer_group": "consumer_group",
"servers": "serveraddress1:8080, serveraddress2:8080",
"message_type": "Json",
"sync_type": "Packed",
"security_protocol": "SASL"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
consumer_group | Confluent Cloud consumer group name. | |
servers | Comma-separated list of Confluent Cloud servers in the format server:port . | |
message_type | Confluent Cloud message type. | Json , Avro , Text |
sync_type | Kafka sync type. Unpacked messages must be valid JSON. | Unpacked , Packed |
security_protocol | Security protocol for Confluent Cloud interaction. | PLAINTEXT , SASL_SSL |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
consumer_group
andservers
. - By using the Connect Card or the Fivetran dashboard.
Contrast Security Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "contrast_security",
"group_id": "target_group_id",
"config": {
"schema": "contrast_security_schema_name",
"username": "your_contrast_security_username",
"password": "your_contrast_security_password",
"api_key": "your_contrast_security_api_key",
"sub_domain": "your contrast_security_subdomain"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
username | Your Contrast Security username. |
password | Your Contrast Security password. |
api_key | Your Contrast Security API key. |
sub_domain | Your Contrast Security subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username
,password
,api_key
andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
Copper Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "copper",
"group_id": "target_group_id",
"config": {
"schema": "copper_schema_name",
"email": "your_copper_email",
"api_key": "your_copper_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
email | Your Copper email. |
api_key | Your Copper API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
email
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Cosmos DB link
Request with account_key
link
POST https://api.fivetran.com/v1/connectors
{
"service": "cosmos",
"group_id": "target_group_id",
"config": {
"schema_prefix":"schema_prefix",
"uri":"cosmos_host_uri",
"data_access_method":"ACCOUNT_KEY",
"account_key": "account_key",
"sync_pack_mode":"sync_pack_mode"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema_prefix | The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
uri | The base host URI of the database account. Required for connector creation. |
data_access_method | The source data access method. Supported values:ACCOUNT_KEY - Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.RESOURCE_TOKEN - Fine-grained permission model based on native Azure Cosmos DB users and permissions.Learn more in our Cosmos DB Data Access Methods documentation. |
account_key | The read-only primary or secondary account key for the database account. Required for the ACCOUNT_KEY data access method. |
sync_pack_mode | The packing mode type. Supported values:STANDARD_UNPACKED_MODE - Unpacks one layer of nested fields and infers types.PACKED_MODE - Delivers packed data as a single destination column value.Learn more in our Cosmos DB Sync Pack Mode Options documentation. Required for connector creation. |
Request with resource_token
link
POST https://api.fivetran.com/v1/connectors
{
"service": "cosmos",
"group_id": "target_group_id",
"config": {
"schema_prefix":"schema_prefix",
"uri":"cosmos_host_uri",
"data_access_method":"RESOURCE_TOKEN",
"resource_token":"resource_token",
"token_authenticated_database":"token_authenticated_database",
"token_authenticated_container":"token_authenticated_container",
"sync_pack_mode":"sync_pack_mode"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema_prefix | The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
uri | The base host URI of the database account. |
data_access_method | The source data access method. Supported values:ACCOUNT_KEY - Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.RESOURCE_TOKEN - Fine-grained permission model based on native Azure Cosmos DB users and permissions.Learn more in our Cosmos DB Data Access Methods documentation. |
resource_token | A token that provides access to a specific Cosmos DB resource. Required for the RESOURCE_TOKEN data access method. |
token_authenticated_database | The database name. Required for the RESOURCE_TOKEN data access method. |
token_authenticated_container | The container name. Required for the RESOURCE_TOKEN data access method. |
sync_pack_mode | The packing mode type. Supported values:STANDARD_UNPACKED_MODE - Unpacks one layer of nested fields and infers types.PACKED_MODE - Delivers packed data as a single destination column value.Learn more in our Cosmos DB Sync Pack Mode Options documentation. |
Coupa link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "coupa",
"group_id": "target_group_id",
"config": {
"schema": "coupa_schema",
"instance": "instance",
"client_id": "client_id",
"client_secret": "client_secret"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
instance | The instance name of your Coupa account in the URL. |
client_id | Your Coupa client_id. |
client_secret | Your Coupa client_secret. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
instance
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Criteo link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "criteo",
"group_id": "target_group_id",
"config": {
"schema": "test_criteo",
"client_id": "xxxxx-xxxxxx-x-xxxx",
"client_secret": "your_api_secret"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id | Your Criteo Client ID. |
client_secret | Your Criteo client secret key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id
andclient_secret
. - By using the Connect Card or the Fivetran dashboard.
Crossbeam Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "crossbeam",
"group_id": "target_group_id",
"config": {
"schema": "crossbeam_schema_name"
},
"auth": {
"client_access": {
"client_id": "my_client_id",
"client_secret": "my_client_secret"
}
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id | Your Crossbeam Client ID. |
client_secret | Your Crossbeam Client secret. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
parameter in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "crossbeam", "group_id": "target_group_id", "config": { "schema": "crossbeam_schema_name" }, "auth": { "client_access": { "client_id": "crossbeam_client_id", "client_secret": "crossbeam_client_secret" } } }
content_copyAuth parameterslink
Name Description client_access.client_id
Your Crossbeam Client ID
.client_access.client_secret
Your Crossbeam Client Secret
.By using the Connect Card or the Fivetran dashboard.
crowd.dev Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "crowddev",
"group_id": "target_group_id",
"config": {
"schema": "crowddev_schema_name",
"bearer_token": "your_crowddev_auth_token",
"tenant_id": "your_crowddev_tenant_id"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
bearer_token | Your crowd.dev Auth Token. |
tenant_id | Your crowd.dev Tenant ID. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
bearer_token
andtenant_id
. - By using the Connect Card or the Fivetran dashboard.
Customer.io Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "customerio",
"group_id": "target_group_id",
"config": {
"schema": "customerio_schema_name",
"bearer_token": "your_customerio_app_api_key",
"sub_domain": "your_customerio_subdomain (api or api-eu)"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
bearer_token | Your Customer.io App API Key. |
sub_domain | Your Customer.io subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
bearer_token
andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
Cvent Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "cvent",
"group_id": "target_group_id",
"config": {
"schema": "cvent_schema_name",
"client_id": "your_cvent_client_id",
"client_secret": "your_cvent_client_secret",
"sub_domain": "your_cvent_sub_domain"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id | Your Cvent Client ID. |
client_secret | Your Cvent Client Secret. |
sub_domain | Your Cvent Subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id
,client_secret
andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
D2L Brightspace Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "d2l_brightspace",
"group_id": "target_group_id",
"config": {
"schema": "d2l_brightspace_schema_name",
"target_host": "your_d2l_brightspace_target_host",
"client_id": "your_d2l_brightspace_client_id",
"client_secret": "your_d2l_brightspace_client_secret"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
target_host | Your D2L Brightspace target host. |
client_id | Your D2L Brightspace client ID. |
client_secret | Your D2L Brightspace client secret. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
target_host
,client_id
andclient_secret
. - By using the Connect Card or the Fivetran dashboard.
dbt Cloud Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dbt_cloud",
"group_id": "target_group_id",
"config": {
"schema": "dbt_cloud_schema_name",
"sub_domain": "your_dbt_cloud_api_server_region",
"api_key": "your_dbt_cloud_service_token"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
api_key | Your dbt Cloud service token. | |
sub_domain | Your dbt Cloud API server region. | US region , Europe region , AU region |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the following parameters:
sub_domain
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
DCL Logistics Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dcl_logistics",
"group_id": "target_group_id",
"config": {
"schema": "dcl_logistics_schema_name",
"api_key": "your_dcl_logistics_api_key",
"username": "your_dcl_logistics_username"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your DCL Logistics API key. |
username | Your DCL Logistics username. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_key
andusername
. - By using the Connect Card or the Fivetran dashboard.
DEAR Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dear",
"group_id": "target_group_id",
"config": {
"schema": "dear_schema_name",
"account_id": "your_dear_account_id",
"application_key": "your_dear_application_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
account_id | Your DEAR account ID. |
application_key | Your DEAR application key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
account_id
andapplication_key
. - By using the Connect Card or the Fivetran dashboard.
Delighted link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service" : "delighted",
"group_id" : "target_group_id",
"config" : {
"schema" : "test_delighted",
"api_key" : "******"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | API Key for your Delighted account |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key
. - By using the Connect Card or the Fivetran dashboard.
Deputy Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "deputy",
"group_id": "target_group_id",
"config": {
"schema": "deputy_schema_name",
"access_token": "your_deputy_access_token",
"sub_domain": "your_deputy_subdomain"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
access_token | Your Deputy access token. |
sub_domain | Your Deputy subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
access_token
andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
Destini Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "destini",
"group_id": "target_group_id",
"config": {
"schema": "destini_schema_name",
"client_name": "your_destini_client_name",
"api_key": "your_destini_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_name | Your Destini client name. |
api_key | Your Destini API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_name
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Dixa Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dixa",
"group_id": "target_group_id",
"config": {
"schema": "dixa_schema_name",
"api_token": "your_dixa_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_token | Your Dixa API token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
api_token
field in the request. - By using the Connect Card or the Fivetran dashboard.
Docebo Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "docebo",
"group_id": "target_group_id",
"config": {
"schema": "docebo_schema_name",
"sub_domain": "your_docebo_domain_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | Your Docebo subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
parameter in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "docebo", "group_id": "target_group_id", "config": { "schema": "docebo_schema_name", "sub_domain": "your_docebo_domain_name" }, "auth": { "client_access": { "client_id": "docebo_client_id", "client_secret": "docebo_client_secret" }, "refresh_token": "my_refresh_token", "access_token": "my_access_token" } }
content_copyAuth parameterslink
Name Description client_access.client_id
Your Docebo Client ID. client_access.client_secret
Your Docebo Client Secret. refresh_token
Your Docebo Refresh Token. access_token
Your Docebo Access Token. By using the Connect Card or the Fivetran dashboard.
DocumentDB link
Fivetran supports the following DocumentDB configuration:
To learn more, see the setup guide for your DocumentDB connector type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "documentdb",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_documentdb",
"host": "documentdbinstance.mycompany.com",
"port": 27017,
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"sync_pack_mode":"sync_pack_mode"
}
}
content_copy
Config parameterslink
Name | Description | Notes |
---|---|---|
schema_prefix | Connector schema prefix has to be unique within the group (destination). Required for connector creation. | |
host | A host/IP address of the primary node. | |
port | A port of the primary node. | |
user | The user name. | |
password | The user's password. | |
tunnel_host | SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). | |
tunnel_port | SSH port, specify only to connect via an SSH tunnel. | |
tunnel_user | SSH user, specify only to connect via an SSH tunnel. | |
connection_type | Possible values:SshTunnel , PrivateLink . SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values is specified: tunnel_host , tunnel_port , tunnel_user . | |
sync_pack_mode | The packing mode type. Supported values:UNPACKED_MODE - Unpacks one layer of nested fields and infers types.PACKED_MODE - Delivers packed data as a single destination column value.Learn more in our DocumentDB Sync Pack Mode Options documentation. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host
,port
,user
andpassword
. - By using the Connect Card or the Fivetran dashboard.
Drata Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "drata",
"group_id": "target_group_id",
"config": {
"schema": "drata_schema_name",
"api_key": "your_drata_api_key",
"sub_domain": "your_drata_api_server_region"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
api_key | Your Drata API key. | |
sub_domain | Your Drata API server region. | https://public-api.drata.com , https://public-api.eu.drata.com |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the following parameters:
api_key
andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
Drift Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "drift",
"group_id": "target_group_id",
"config": {
"schema": "drift_schema_name",
"sub_domain": "your_drift_subdomain"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | Your Drift subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the following parameter in the
auth
section:client_access
,refresh_token
, andaccess_token
.POST https://api.fivetran.com/v1/connectors
{ "service": "drift", "group_id": "target_group_id", "config": { "schema": "drift_schema_name", "sub_domain": "your_drift_domain_name" }, "auth": { "client_access": { "client_id": "drift_client_id", "client_secret": "drift_client_secret" }, "refresh_token": "my_refresh_token", "access_token": "my_access_token" } }
content_copyAuth parameterslink
Name Description client_id
Your Drift client ID. client_secret
Your Drift client secret. refresh_token
Your Drift refresh token. access_token
Your Drift access token. By using the Connect Card or the Fivetran dashboard.
Drip Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "drip",
"group_id": "target_group_id",
"config": {
"schema": "drip_schema_name",
"api_key": "your_drip_API_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Drip API Token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_token
field in the request. - By using the Connect Card or the Fivetran dashboard.
Dropbox link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
The connector supports two sync strategies:
Magic Folder Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dropbox",
"group_id": "target_group_id",
"config": {
"schema": "test_dropbox",
"folder": "folder_url"
}
}
content_copy
NOTE: For Magic Folder mode, ensure that the
"schema"
name doesn't contain a.
If you are switching from Merge mode, don't include a"table"
name in the"config"
parameter.
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
folder | Your Dropbox Folder URL. |
Merge Mode Requestlink
To use the Merge Mode sync strategy, specify the is_single_table_mode
parameter as true
. If you don't specify the parameter, we will use the default Magic Folder strategy to sync files.
POST https://api.fivetran.com/v1/connectors
{
"service": "dropbox",
"group_id": "target_group_id",
"config": {
"schema": "test_dropbox",
"table": "dest_table",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"json_delivery_mode": "Packed",
"compression": "infer",
"on_error": "fail",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "|",
"escape_char": "escape_char",
"skip_before": "0",
"skip_after": "0",
"is_single_table_mode": "true",
"line_separator": ";"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema (required) | The connector schema name has to be unique within the group (destination). | |
table (required) | The table name within the schema to which the connector will sync the data. | |
prefix | All files and folders under this folder path will be searched for files to sync. | |
pattern | All files in your search path matching this regular expression will be synced. | |
file_type | If your files are saved with improper extensions, you can force them to be synced as the selected file type. | infer , csv , json , tsv , avro , parquet |
json_delivery_mode | Specifies how Fivetran should handle your JSON data. Default value: Packed . | Packed , Unpacked |
compression | The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error | If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option | If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern | Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence | If your CSVs use a special value indicating null, you can specify it here. | |
delimiter | You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before | We will skip over the number of lines specified before syncing data. | |
skip_after | We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. | |
is_single_table_mode (required as true ) | Allows the creation of connector using Merge Mode strategy. | true , false |
line_separator | You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "dropbox", "group_id": "target_group_id", "config": { "schema": "test_dropbox", "folder": "folder_url" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Dropbox client application.client_secret
Client Secret
of your Dropbox client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Dropbox Sign Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dropbox_sign",
"group_id": "target_group_id",
"config": {
"schema": "dropbox_sign_schema_name",
"api_key": "dropbox_sign_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Dropbox Sign API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
DynamoDB link
Before creating a DynamoDB connection, you must first follow the DynamoDB setup guide
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dynamodb",
"group_id": "target_group_id",
"config": {
"schema": "test_dynamodb",
"external_id": "external_id",
"role_arn": "arn::your_role_arn",
"aws_region_code": "aws_region_code",
"sync_mode": "UseUnpackedModeOnly",
"packed_mode_tables": []
}
}
content_copy
Config parameterslink
Name | Description | Notes |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
external_id | This is the same as your group_id , used for authentication along with the role_arn . | |
role_arn | The Role ARN required for authentication. | |
aws_region_code | The AWS region code for the DynamoDB instance, e.g. us-east-1 . | |
sync_mode | Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: UseUnpackedModeOnly . | UseUnpackedModeOnly , SelectTablesForPackedMode . |
packed_mode_tables | Specific tables to sync. Must be populated if sync_mode is set to SelectTablesForPackedMode . | Use the following format: <db>.<table> (case-sensitive). |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
external_id
,role_arn
andaws_region_code
. - By using the Connect Card or the Fivetran dashboard.
EasyPost Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "easypost",
"group_id": "target_group_id",
"config": {
"schema": "easypost_schema_name",
"api_key": "your_easypost_API_Key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your EasyPost API Key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the following field in the request:
api_key
. - By using the Connect Card or the Fivetran dashboard.
e-conomic Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "e-conomic",
"group_id": "target_group_id",
"config": {
"schema": "e-conomic_schema_name",
"agreement_grant_token": "your_agreement_grant_token",
"app_secret_token": "your_app_secret_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
agreement_grant_token | Your e-conomic AgreementGrantToken. |
app_secret_token | Your e-conomic AppSecretToken. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
agreement_grant_token
andapp_secret_token
fields in the request. - By using the Connect Card or the Fivetran dashboard.
Eloqua link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "eloqua",
"group_id": "target_group_id",
"config": {
"schema": "test_eloqua"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Email link
After configuring an Email connector, you'll send your emails to group_id.schema.table_name@email-connector.fivetran.com
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "email",
"group_id": "target_group_id",
"config": {
"schema": "test_email",
"table": "table_name",
"pattern": "file_pattern",
"file_type": "infer",
"json_delivery_mode": "Packed",
"compression": "infer",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0",
"line_separator": ";"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
pattern | All files in your search path matching this regular expression will be synced. | |
file_type | If your files are saved with improper extensions, you can force them to by synced as the selected file type. | infer , csv , json , tsv , avro |
json_delivery_mode | Specifies how Fivetran should handle your JSON data. Default value: Packed . | Packed , Unpacked |
compression | The secrets that should be passed to the function at runtime. | infer , uncompressed , tar , tar_bz2 , tar_gz |
archive_pattern | Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence | If your CSVs use a special value indicating null, you can specify it here. | |
delimiter | You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before | We will skip over the number of lines specified before syncing data. | |
skip_after | We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. | |
line_separator | You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the required fields in the request.
- By using the Connect Card or the Fivetran dashboard.
Employment Hero Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "employment_hero",
"group_id": "target_group_id",
"config": {
"schema": "employment_hero_schema_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
auth
section:client_access
,refresh_token
, andaccess_token
.POST https://api.fivetran.com/v1/connectors
{ "service": "employment_hero", "group_id": "target_group_id", "config": { "schema": "employment_hero_schema_name" }, "auth": { "client_access": { "client_id": "employment_hero_client_id", "client_secret": "employment_hero_client_secret" }, "refresh_token": "employment_hero_refresh_token", "access_token": "employment_hero_access_token" } }
content_copyAuth parameterslink
Name Description client_id
Your Employment Hero client ID. client_secret
Your Employment Hero client secret. refresh_token
Your Employment Hero refresh token. access_token
Your Employment Hero access token. By using the Connect Card or the Fivetran dashboard.
Eventbrite Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "eventbrite",
"group_id": "target_group_id",
"config": {
"schema": "eventbrite_schema_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
field in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "eventbrite", "group_id": "target_group_id", "config": { "schema": "eventbrite_schema_name" }, "auth": { "client_access": { "client_id": "your_eventbrite_client_id", "client_secret": "your_eventbrite_client_secret" } } }
content_copyAuth parameterslink
Name Description client_access.client_id
Your Eventbrite Client ID. client_access.client_secret
Your Eventbrite Client Secret. By using the Connect Card or the Fivetran dashboard.
Everhour Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "everhour",
"group_id": "target_group_id",
"config": {
"schema": "everhour_schema_name",
"api_key": "your_everhour_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Everhour API Token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Expensify Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "expensify",
"group_id": "target_group_id",
"config": {
"schema": "expensify_schema_name",
"partner_user_id": "your_expensify_partner_user_id",
"partner_user_secret": "your_expensify_partner_user_secret"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
partner_user_id | Your Expensify Partner User ID. |
partner_user_secret | Your Expensify Partner User Secret. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request
partner_user_id
andpartner_user_secret
- By using the Connect Card or the Fivetran dashboard.
EZOfficeInventory Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "ezofficeinventory",
"group_id": "target_group_id",
"config": {
"schema": "ezofficeinventory_schema_name",
"secret_key": "your_ezofficeinventory_api_secret_key",
"sub_domain": "your_ezofficeinventory_subdomain"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
secret_key | Your EZOfficeInventory API secret key. |
sub_domain | Your EZOfficeInventory subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
secret_key
andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
Facebook Ads link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "facebook_ads",
"group_id": "target_group_id",
"config": {
"schema": "facebook_ads",
"sync_mode": "SpecificAccounts",
"accounts": ["act_123"],
"custom_tables": [
{
"table_name": "table_1",
"fields": ["ad_id","clicks", "actions"],
"breakdowns": ["frequency_value", "device_platform"],
"action_breakdowns": ["action_type","action_device"],
"aggregation": "Week",
"action_report_time": "impression",
"click_attribution_window": "DAY_7",
"view_attribution_window": "DAY_7"
}
],
"timeframe_months": "THREE",
"sync_metadata": "true"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode | Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. | |
accounts | List of accounts of which connector will sync the data. | |
custom_tables | List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data. | |
table_name | The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with Fivetran's naming conventions. | |
fields | List of fields which connector will sync. Possible field values. | |
breakdowns | List of breakdowns which connector will sync. Possible breakdowns values. | |
action_breakdowns | List of action_breakdowns which connector will sync. Possible action_breakdowns values. | |
aggregation | Options to select aggregation duration. Possible aggregation values. | |
action_report_time | The report time of action stats. Possible action_report time values. | |
click_attribution_window | Time period to attribute conversions based on clicks. Possible click_attribution_window values. | |
view_attribution_window | Time period to attribute conversions based on views. Possible view_attribution_window values. | |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: THREE . | THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
sync_metadata | Parameter defining whether to enable or disable metadata synchronisation. Default value: TRUE . | TRUE , FALSE |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andaccess_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "facebook_ads", "group_id": "target_group_id", "config": { "schema": "facebook_ads", "sync_mode": "SpecificAccounts", "accounts": ["act_123"], "custom_tables": [ { "table_name": "table_1", "fields": ["ad_id","clicks", "actions"], "breakdowns": ["frequency_value", "device_platform"], "action_breakdowns": ["action_type","action_device"], "aggregation": "Week", "action_report_time": "impression", "click_attribution_window": "DAY_7", "view_attribution_window": "DAY_7" } ], "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Facebook client application.client_secret
Client Secret
of your Facebook client application.access_token
The long-lived Access token
along with theclient_id
andclient_secret
parameters carry the information necessary to query the Facebook Ads APIBy using the Connect Card or through the Fivetran dashboard.
Facebook Pages link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "facebook_pages",
"group_id": "target_group_id",
"config": {
"schema": "facebook_pages",
"sync_mode" : "SpecificPages",
"pages" : ["page1","page2"]
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode | Whether to sync all accounts or specific accounts. Default value: AllPages . | AllPages , SpecificPages |
pages | Specific pages to sync. Must be populated if sync_mode is set to SpecificPages . |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andaccess_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "facebook_pages", "group_id": "target_group_id", "config": { "schema": "facebook_pages", "sync_mode" : "SpecificPages", "pages" : ["page1","page2"] }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Facebook client application.client_secret
Client Secret
of your Facebook client application.access_token
The Access Token
carries the information necessary for API resources to fetch dataBy using the Connect Card or through the Fivetran dashboard.
Financial Force Betalink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "financial_force",
"group_id": "target_group_id",
"config": {
"schema": "financial_force",
"base_url": "https://base_url.salesforce.com"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
base_url | (Optional) The custom Salesforce domain. Make sure that the base_url starts with https:// . |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "financial_force", "group_id": "target_group_id", "config": { "schema": "financial_force", "base_url": "https://base_url.salesforce.com" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Salesforce client application.client_secret
Client Secret
of your Salesforce client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Firebase Betalink
Before creating a Firebase connection, you must first follow our setup guide.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "firebase",
"group_id": "target_group_id",
"config": {
"schema": "test_firebase",
"service_account_key": "your_service_account_key",
"packing_mode": "UseUnpackedModeOnly",
"packed_mode_tables": "[]"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
service_account_key | The contents of your service account key file. Required for authentication. |
packing_mode | Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: UseUnpackedModeOnly . |
packed_mode_tables | Specific tables to sync. Must be populated if packing_mode is set to SelectTablesForPackedMode . |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
service_account_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Fivetran Platform Connector link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "fivetran_log",
"group_id": "target_group_id",
"config": {
"schema": "fivetran_log_schema",
"group_name" : "group_name",
"is_account_level_connector": true
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
group_name | (Optional) The group name of the target_group_id . | |
is_account_level_connector | (Optional) Retrieve account-level logs. | true , false |
Authorizationlink
To authorize this connector, we reuse the access rights that you use to access the API.
Flexport Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "flexport",
"group_id": "target_group_id",
"config": {
"schema": "flexport"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
parameter in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "flexport", "group_id": "target_group_id", "config": { "schema": "flexport" }, "auth": { "client_access": { "client_id": "your_flexport_client_id", "client_secret": "your_flexport_client_secret" }, "access_token": "my_access_token" } }
content_copyAuth parameterslink
Name Description client_access.client_id
Your Flexport Client ID. client_access.client_secret
Your Flexport Client Secret. By using the Connect Card or the Fivetran dashboard.
Fone Dynamics Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "fone_dynamics",
"group_id": "target_group_id",
"config": {
"schema": "fone_dynamics_schema_name",
"account_sid": "your_fone_dynamics_account_sid",
"api_token": "your_fone_dynamics_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
account_sid | Your Fone Dynamics Account SID. |
api_token | Your Fone Dynamics API Token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
account_sid
andapi_token
. - By using the Connect Card or the Fivetran dashboard.
Forj Community Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "forj_community",
"group_id": "target_group_id",
"config": {
"schema": "forj_community_schema_name",
"api_key": "your_forj_community_api_application_key",
"api_secret": "your_forj_community_secret_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Forj Community API application key. |
api_secret | Your Forj Community secret key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key
andapi_secret
. - By using the Connect Card or the Fivetran dashboard.
Float Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "float",
"group_id": "target_group_id",
"config": {
"schema": "float_schema_name",
"api_key": "your_float_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Float API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Fountain Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "fountain",
"group_id": "target_group_id",
"config": {
"schema": "fountain_schema_name",
"sub_domain": "your_fountain_subdomain",
"api_token": "your_fountain_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | Your Fountain subdomain. |
api_token | Your Fountain API token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_token
field in the request. - By using the Connect Card or the Fivetran dashboard.
FreshBooks Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "freshbooks",
"group_id": "target_group_id",
"config": {
"schema": "freshbooks_schema_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
auth
section:client_access
,refresh_token
, andaccess_token
.POST https://api.fivetran.com/v1/connectors
{ "service": "freshbooks", "group_id": "target_group_id", "config": { "schema": "freshbooks_schema_name" }, "auth": { "client_access": { "client_id": "freshbooks_client_id", "client_secret": "freshbooks_client_secret" }, "refresh_token": "freshbooks_refresh_token", "access_token": "freshbooks_access_token" } }
content_copyAuth parameterslink
Name Description client_id
Your FreshBooks client ID. client_secret
Your FreshBooks client secret. refresh_token
Your FreshBooks refresh token. access_token
Your FreshBooks access token. By using the Connect Card or the Fivetran dashboard.
Freshchat Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "freshchat",
"group_id": "target_group_id",
"config": {
"schema": "freshchat",
"sub_domain": "sub_domain",
"bearer_token": "your_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | Your Freshchat subdomain. |
bearer_token | Your Freshchat API token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain
andapi_token
. - By using the Connect Card or the Fivetran dashboard.
Freshdesk link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "freshdesk",
"group_id": "target_group_id",
"config": {
"schema": "freshdesk",
"subdomain": "company_name",
"api_key": "your_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
subdomain | Your company's freshdesk subdomain (usually company.freshdesk.com). |
api_key | Your Freshdesk API Key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
subdomain
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Freshservice link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "freshservice",
"group_id": "target_group_id",
"config": {
"schema": "freshservice",
"subdomain": "company_name",
"api_key": "your_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
subdomain | Your company's freshservice subdomain (usually company.freshservice.com). |
api_key | Your Freshservice API Key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
subdomain
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Friendbuy Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "friendbuy",
"group_id": "target_group_id",
"config": {
"schema": "friendbuy_schema_name",
"api_key": "your_friendbuy_api_key",
"api_secret": "your_friendbuy_api_secret"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Friendbuy API key. |
api_secret | Your Friendbuy API secret. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key
andapi_secret
. - By using the Connect Card or the Fivetran dashboard.
Freshteam Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "freshteam",
"group_id": "target_group_id",
"config": {
"schema": "freshteam",
"base_domain": "your_base_domain",
"api_key": "your_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
domain_name | Your company's Freshteam base domain name (usually company.freshteam.com). |
api_key | Your Freshteam API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
domain_name
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Front link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "front",
"group_id": "target_group_id",
"config": {
"schema": "front"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "front", "group_id": "target_group_id", "config": { "schema": "front" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Front client application.client_secret
Client Secret
of your Front client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
NOTE: You can opt to sync private resources using API tokens.
FTP link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "ftp",
"group_id": "target_group_id",
"config": {
"schema": "test_ftp",
"table": "table_name",
"host": "ftp.company.com",
"port": "21",
"user": "user_name",
"password": "password",
"is_secure": "false",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"json_delivery_mode": "Packed",
"compression": "infer",
"on_error": "skip",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0",
"line_separator": ""
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
host | FTP host address. | |
port | FTP port. | |
user | FTP user. | |
password | FTP password. | |
is_secure | Whether the server supports FTPS. | true , false |
prefix | All files and folders under this folder path will be searched for files to sync. | |
pattern | All files in your search path matching this regular expression will be synced. | |
file_type | If your files are saved with improper extensions, you can force them to by synced as the selected file type. | infer , csv , json , tsv , avro |
json_delivery_mode | Specifies how Fivetran should handle your JSON data. Default value: Packed . | Packed , Unpacked |
compression | The secrets that should be passed to the function at runtime. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error | If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option | If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern | Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence | If your CSVs use a special value indicating null, you can specify it here. | |
delimiter | You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before | We will skip over the number of lines specified before syncing data. | |
skip_after | We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. | |
line_separator | You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
user
,password
,host
andport
. - By using the Connect Card or the Fivetran dashboard.
FullStory Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "fullstory",
"group_id": "target_group_id",
"config": {
"schema": "fullstory",
"api_key": "your_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your FullStory API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Gainsight Customer Success link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "gainsight_customer_success",
"group_id": "target_group_id",
"config": {
"schema": "testing_gainsight",
"sub_domain": "test_sub_domain",
"access_key": "test_access_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | The subdomain of your Gainsight account. |
access_key | The access key for API authentication. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the following fields in the request:
sub_domain
andaccess_key
.By using the Connect Card or through the Fivetran dashboard.
Gem Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "gem",
"group_id": "target_group_id",
"config": {
"schema": "gem_schema_name",
"api_key": "your_gem_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Gem API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - After creating the connector, by using the Connect Card or the Fivetran dashboard.
GetFeedback Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "getfeedback",
"group_id": "target_group_id",
"config": {
"schema": "getfeedback_schema_name",
"access_token": "your_getfeedback_access_token",
"region": "your_getfeedback_region"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
access_token | Your GetFeedback access token. |
region | Your GetFeedback region. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
access_token
andregion
. - After creating the connector, by using the Connect Card or the Fivetran dashboard.
GitHub link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "github",
"group_id": "target_group_id",
"config": {
"schema": "test_github",
"sync_mode": "SpecificRepositories",
"repositories": ["12345678", "23456789"],
"use_webhooks": false
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode | Whether to sync all repositories or specific repositories. | AllRepositories , SpecificRepositories |
repositories | Specific Repository IDs to sync. Must be populated if syncMode is set to SpecificRepositories . | |
use_webhooks | Whether to use webhook payloads from GitHub to perform incremental updates. | true , false |
Authorizationlink
There are two ways to authorize this connector type:
By specifying username, pat and auth_mode in the auth section.
POST https://api.fivetran.com/v1/connectors
{ "service": "github", "group_id": "target_group_id", "config": { "schema": "test_github", "sync_mode": "SpecificRepositories", "repositories": ["12345678", "23456789"], "use_webhooks": false, "username": "github-login", "pat": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "auth_mode": "PersonalAccessToken" } }
content_copyAuth parameterslink
Name Description username
Login
of your GitHub profile.pat
The Personal Access Token
generated in Github.auth_mode
Authorization type. By using the Connect Card or through the Fivetran dashboard.
GitLab Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "gitlab",
"group_id": "target_group_id",
"config": {
"schema": "gitlab_schema_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
auth
section:client_access
,refresh_token
, andaccess_token
.POST https://api.fivetran.com/v1/connectors
{ "service": "gitlab", "group_id": "target_group_id", "config": { "schema": "gitlab_schema_name" }, "auth": { "client_access": { "client_id": "gitlab_client_id", "client_secret":"gitlab_client_secret" }, "refresh_token": "gitlab_refresh_token", "access_token": "gitlab_access_token" } }
content_copyAuth parameterslink
Name Description client_id
Your GitLab client ID. client_secret
Your GitLab client secret. refresh_token
Your GitLab refresh token. access_token
Your GitLab access token. By using the Connect Card or the Fivetran dashboard.
Gladly Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "gladly",
"group_id": "target_group_id",
"config": {
"schema": "gladly_schema_name",
"username": "your_gladly_username",
"api_token": "your_gladly_api_token",
"organization": "your_gladly_organization_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
username | Your Gladly Username. |
api_token | Your Gladly API Token. |
organization | Your Gladly Organization Name. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username
andapi_token
. - By using the Connect Card or the Fivetran dashboard.
GlobalMeet Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "globalmeet",
"group_id": "target_group_id",
"config": {
"schema": "globalmeet_schema_name",
"username": "your_globalmeet_username",
"password": "your_globalmeet_password"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
username | Your GlobalMeet username. |
password | Your GlobalMeet password. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username
andpassword
. - By using the Connect Card or the Fivetran dashboard.
GoCardless Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "gocardless",
"group_id": "target_group_id",
"config": {
"schema": "gocardless_schema_name",
"sandbox_account": "your_gocardless_account_type",
"access_token": "your_gocardless_access_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sandbox_account | Your GoCardless account type. |
access_token | Your GoCardless access token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sandbox_account
andaccess_token
. - By using the Connect Card or the Fivetran dashboard.
Gong link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "gongio",
"group_id": "target_group_id",
"config": {
"schema": "gong_schema_name",
"access_key": "your_gong_api_access_key",
"access_key_secret": "your_gong_api_access_key_secret",
"base_url": "your_gong_api_base_url"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
access_key | Your Gong API access key. |
access_key_secret | Your Gong API access key secret. |
base_url | Your Gong API base URL. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the following fields in the request:
access_key
,access_key_secret
andbase_url
. - By using the Connect Card or the Fivetran dashboard.
Google Ad Manager link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "double_click_publishers",
"group_id": "target_group_id",
"config": {
"schema": "test_google_ad_manager",
"table": "test_table",
"dimensions": ["DATE", "LINE_ITEM_ID", "LINE_ITEM_NAME"],
"dimension_attributes": ["LINE_ITEM_PRIORITY"],
"columns": ["TOTAL_LINE_ITEM_LEVEL_CLICKS"],
"custom_field_ids": [432432, 545345],
"ad_unit_view": "TOP_LEVEL",
"network_code": "0"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
dimensions | Report dimensions to include in the sync. The date dimension is mandatory for all the report types. | See Ad Manager dimensions documentation |
dimension_attributes | Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions. | See Ad Manager dimension attributes documentation |
columns | Columns provide all trafficking statistics and revenue information available for the chosen Dimensions. | See Ad Manager column documentation |
custom_field_ids | Custom field IDs to include in the sync. Custom fields can only be selected with their corresponding Dimensions. | See Ad Manager custom field ids documentation |
ad_unit_view | The ad unit view for the report. Defaults to TOP_LEVEL. | See Ad Manager ad unit view documentation |
network_code | Network code is a unique, numeric identifier for your Ad Manager network. | See Find Ad Manager account information |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "double_click_publishers", "group_id": "target_group_id", "config": { "schema": "test_google_ad_manager", "table": "test_table", "dimensions": ["DATE", "LINE_ITEM_ID", "LINE_ITEM_NAME"], "dimension_attributes": ["LINE_ITEM_PRIORITY"], "columns": ["TOTAL_LINE_ITEM_LEVEL_CLICKS"], "custom_field_ids": [432432, 545345], "ad_unit_view": "TOP_LEVEL", "network_code": "0" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Ad Manager client application.client_secret
Client Secret
of your Google Ad Manager client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Ads link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_ads",
"group_id": "target_group_id",
"config": {
"schema": "google_ads",
"customer_id": "xxx-xxx-xxxx",
"sync_mode": "SpecificAccounts",
"timeframe_months": "SIX",
"accounts": [],
"manager_accounts": [],
"reports": [
{
"table": "table_1",
"report_type": "customer",
"fields": [ "segments.date", "customer.id", "segments.ad_network_type", "segments.device", "metrics.clicks", "metrics.cost_micros" ]
},
{
"table": "table_2",
"report_type": "campaign",
"fields": [ "segments.date", "campaign.id", "customer.id", "segments.click_type", "segments.ad_network_type", "metrics.clicks", "metrics.impressions" ]
}
],
"conversion_window_size": 30
}
}
content_copy
Config parameterslink
Name | Description | Supported Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
customer_id | ID of the customer, can be retrieved from your Google Ads dashboard. | |
sync_mode | Whether to sync all accounts or specific accounts. | AllAccounts , SpecificAccounts , ManagerAccounts |
timeframe_months | The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: TWELVE . | THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
accounts | The list of Account IDs to sync. Must be populated if sync_mode is set to SpecificAccounts . | |
manager_accounts | The list of the Manager Account IDs whose clients will be synced. Must be populated if sync_mode is set to ManagerAccounts . | |
reports | The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. | |
table | The table name within the schema to which connector will sync the data of the specific report. | |
report_type | The name of the Google Ads report from which the connector will sync the data. You can use all report_type values that support segmenting by date as report types. | |
fields | A list of the fields to sync. | |
conversion_window_size | The time frame of the rollback sync to capture conversions. | From 1 to 90 days, or 0 for automatic detection. |
NOTE: The
segments.date
field is required for incremental syncs. Make sure thesegments.date
field is present for every table.
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andrefresh_token
in theauth
section.We use a Fivetran developer token to access the Google Ads API. If this is your first Google Ads connector with custom authorization, you should create a new Google API Console project. Each Google API Console project can be associated with the developer token from only one manager account. Once you make a Google Ads API request, the developer token is permanently paired to the Google API Console project. Otherwise, we can't bind the Fivetran developer token to your client. You can reuse the same project to create other Google Ads connectors.
POST https://api.fivetran.com/v1/connectors
{ "service": "google_ads", "group_id": "target_group_id", "config": { "schema": "google_ads", "customer_id": "xxx-xxx-xxxx", "sync_mode": "SpecificAccounts", "accounts": [], "manager_accounts": [], "reports": [ { "table": "table_1", "report_type": "customer", "fields": [ "segments.date", "customer.id", "segments.ad_network_type", "segments.device", "metrics.clicks", "metrics.cost_micros" ] }, { "table": "table_2", "report_type": "campaign", "fields": [ "segments.date", "campaign.id", "customer.id", "segments.click_type", "segments.ad_network_type", "metrics.clicks", "metrics.impressions" ] } ], "conversion_window_size": 30 }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret", "user_agent": "my_company_name" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Ads client application.client_secret
Client Secret
of your Google Ads client application.user_agent
Your company's name in your Google Ads client application. refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Analytics link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics",
"sync_mode": "SpecificAccounts",
"accounts": ["0123456789"],
"profiles": ["0123456789", "9876543210"],
"reports": [
{
"table": "table_1",
"config_type": "Custom",
"dimensions": ["date", "dimension1", "pagePath", "browser"],
"metrics": ["pageviews", "sessions", "timeOnPage", "users"],
"segments": ["Bounced Sessions", "Direct Traffic"],
"filter": "ga:browser==Chrome"
},
{
"table": "table_2",
"config_type": "Prebuilt",
"prebuilt_report": "CHANNEL_TRAFFIC"
}
],
"timeframe_months": "SIX"
}
}
content_copy
Legacy Requestlink
The following request is deprecated and will be removed in the future:
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics",
"table": "test_table",
"sync_mode": "SpecificAccounts",
"accounts": ["0123456789"],
"profiles": ["0123456789", "9876543210"],
"config_type": "Custom",
"dimensions": ["date", "dimension1", "pagePath", "browser"],
"metrics": ["pageviews", "sessions", "timeOnPage", "users"],
"segments": ["Bounced Sessions", "Direct Traffic"],
"filter": "ga:browser==Chrome",
"timeframe_months": "SIX"
}
}
content_copy
Config parameterslink
Name | Description | Supported Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode | Whether to sync all accounts or specific accounts. | AllAccounts , SpecificAccounts |
accounts | The list of specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts . | |
profiles | Specific User Profile IDs to sync. Must be populated if syncMode is set to SpecificAccounts . | |
reports | The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. | |
table | The table name within the schema to which connector will sync the data of the specific report. | |
config_type | Whether to use the Prebuilt Reports or Custom Reports. | Prebuilt , Custom |
prebuilt_report | The name of the Prebuilt Report from which the connector will sync the data. | See the list of supported prebuilt_reports. |
dimensions | The report dimensions to include into a sync. The date dimension is mandatory for all the report types. | See Google Analytics Dimensions & Metrics Explorer |
metrics | The report metrics to include into a sync. | See Google Analytics Dimensions & Metrics Explorer |
segments | A segment is a subset of your Analytics data that is made up of one or more non-destructive filters (filters that do not alter the underlying data). Those filters isolate subsets of users, sessions, and hits. | See Google Analytics Dimensions & Metrics Explorer |
filter | String parameter restricts the data returned for your report. To use the filters parameter, specify a dimension or metric on which to filter, followed by the filter expression | See Google Analytics Core Reporting API |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE . | THREE , SIX , TWELVE , TWENTY_FOUR , and ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_analytics", "group_id": "target_group_id", "config": { "schema": "test_google_analytics", "sync_mode": "SpecificAccounts", "accounts": ["0123456789"], "profiles": ["0123456789", "9876543210"], "reports": [ { "table": "table_1", "config_type": "Custom", "dimensions": ["date", "dimension1", "pagePath", "browser"], "metrics": ["pageviews", "sessions", "timeOnPage", "users"], "segments": ["Bounced Sessions", "Direct Traffic"], "filter": "ga:browser==Chrome" }, { "table": "table_2", "config_type": "Prebuilt", "prebuilt_report": "CHANNEL_TRAFFIC" } ], "timeframe_months": "SIX" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Analytics client application.client_secret
Client Secret
of your Google Analytics client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Analytics 4 link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics_4",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics",
"timeframe_months": "SIX",
"sync_mode": "SPECIFIC_ACCOUNTS",
"accounts": ["0123456789"],
"properties": ["0123456789", "9876543210"],
"reports": [
{
"table": "table_1",
"config_type": "CUSTOM",
"dimensions": ["date", "firstUserMedium"],
"metrics": ["newUsers", "totalRevenue", "sessions"],
"filter_field_name": "browser",
"filter_field_value": "chrome",
"rollback_window": 15
},
{
"table": "table_2",
"config_type": "PREBUILT",
"prebuilt_report": "USER_ACQUISITION_FIRST_USER_MEDIUM_REPORT"
}
]
}
}
content_copy
Config parameterslink
Name | Description | Supported Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
timeframe_months | The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE . | THREE , SIX , TWELVE , TWENTY_FOUR , and ALL_TIME |
sync_mode | Whether to sync all accounts or specific accounts. | ALL_ACCOUNTS , SPECIFIC_ACCOUNTS |
accounts | The list of specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS . | |
properties | The list of specific Google Analytics 4 property IDs. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS . | |
reports | The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. | |
table | The table name within the schema to which connector will sync the data of the specific report. | |
config_type | Whether to use the Prebuilt Reports or Custom Reports. | PREBUILT , CUSTOM |
prebuilt_report | The name of the Prebuilt Report from which the connector will sync the data. | See the list of supported prebuilt_reports. |
dimensions | The report dimensions to include into a sync. | See Google Analytics APIs Explorer |
metrics | The report metrics to include into a sync. | See Google Analytics APIs Explorer |
filter_field_name | The dimension name to filter on. | |
filter_field_value | The dimension value to filter on. It is case-insensitive. | |
rollback_window | The window size for a rollback sync. The default value is 30. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_analytics_4", "group_id": "target_group_id", "config": { "schema": "test_google_analytics", "timeframe_months": "SIX", "sync_mode": "SPECIFIC_ACCOUNTS", "accounts": ["0123456789"], "properties": ["0123456789", "9876543210"], "reports": [ { "table": "table_1", "config_type": "CUSTOM", "dimensions": ["date", "firstUserMedium"], "metrics": ["newUsers", "totalRevenue", "sessions"], "filter_field_name": "browser", "filter_field_value": "chrome", "rollback_window": 15 }, { "table": "table_2", "config_type": "PREBUILT", "prebuilt_report": "USER_ACQUISITION_FIRST_USER_MEDIUM_REPORT" } ] }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Analytics client application.client_secret
Client Secret
of your Google Analytics client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Analytics 4 Export Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics_4_export",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics_4_export",
"project_id": "test_project_id",
"dataset_id": "test_dataset_id",
"bucket_name": "test_bucket_name",
"list_sync_mode": "COLUMNS"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
project_id | The Project ID. | |
dataset_id | The Dataset ID. | |
bucket_name | The name of the bucket. | |
list_sync_mode | The sync mode. | COLUMNS , JSON |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
project_id
,dataset_id
, andbucket_name
. - By using the Connect Card or the Fivetran dashboard.
Initial Configurationlink
To provide Fivetran access perform the following steps:
- Add the email address in the format
g-[group-id]@fivetran-production.iam.gserviceaccount.com
as a new member, where[group_id]
is the connector's group ID. - Assign the following roles:
BigQuery Data Viewer
for DatasetId,Storage Object Admin
for BucketName, andBigQuery Job User
for Project.
Google Analytics 360 link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics_360",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics_360",
"project_id": "test_project_id",
"dataset_id": "test_dataset_id",
"bucket_name": "test_bucket_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
project_id | The project ID. |
dataset_id | The dataset ID. |
bucket_name | The name of the bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
project_id
,dataset_id
andbucket_name
. - By using the Connect Card or the Fivetran dashboard.
Initial Configurationlink
To provide Fivetran access perform the following steps:
- Add the email address in the format
g-[group-id]@fivetran-production.iam.gserviceaccount.com
as a new member, where [group_id] is the connector's group ID. - Assign
BigQuery Data Viewer
,BigQuery Job User
, andBigQuery User
roles.
Google Analytics (MCF) Betalink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics_mcf",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics_mcf",
"sync_mode": "SPECIFIC_ACCOUNTS",
"accounts": ["0123456789"],
"profiles": ["0123456789", "9876543210"],
"timeframe_months": "SIX"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode | Whether to sync all accounts or specific accounts. Default value: ALL_ACCOUNTS | ALL_ACCOUNTS , SPECIFIC_ACCOUNTS |
accounts | Specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS . | |
profiles | Specific User Profile IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS . | |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE . | THREE , SIX , TWELVE , TWENTY_FOUR and ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_analytics_mcf", "group_id": "target_group_id", "config": { "schema": "test_google_analytics_mcf", "sync_mode": "SPECIFIC_ACCOUNTS", "accounts": ["0123456789"], "profiles": ["0123456789", "9876543210"], "timeframe_months": "SIX" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Analytics client application.client_secret
Client Secret
of your Google Analytics client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Calendar Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_calendar",
"group_id": "target_group_id",
"config": {
"schema": "google_calendar_schema_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
auth
section:client_access
,refresh_token
, andaccess_token
.POST https://api.fivetran.com/v1/connectors
{ "service": "google_calendar", "group_id": "target_group_id", "config": { "schema": "google_calendar_schema_name" }, "auth": { "client_access": { "client_id": "google_calendar_client_id", "client_secret": "google_calendar_client_secret" }, "refresh_token": "google_calendar_refresh_token", "access_token": "google_calendar_access_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Calendar client application.client_secret
Client ID
of your Google Calendar client application.refresh_token
The long-lived Refresh token
of your Google Calendar client application.access_token
The Access Token
that carries the information necessary for API resources to fetch data.By using the Connect Card or the Fivetran dashboard.
Google Campaign Manager 360 link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "double_click_campaign_manager",
"group_id": "target_group_id",
"config": {
"schema": "test_double_click_campaign_manager",
"table": "test_table",
"sync_mode": "SPECIFIC_PROFILES",
"user_profiles": ["1234567", "8901234"],
"timeframe_months": "SIX",
"report_type": "FLOODLIGHT",
"dimensions": ["date", "activity"],
"metrics": ["activeViewPercentAudibleImpressions"],
"report_configuration_ids": ["12", "34", "56"],
"enable_all_dimension_combinations": true,
"conversion_dimensions": ["activityGroup", "activityGroupId"],
"per_interaction_dimensions": ["advertiserGroup"],
"custom_floodlight_variables": ["customVariable"]
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
sync_mode | Whether to sync all user profiles or specific ones. Default value: ALL_PROFILES . | ALL_PROFILES , SPECIFIC_PROFILES |
user_profiles | IDs of specific User Profiles to sync. Must be populated if sync_mode is set to SPECIFIC_PROFILES . | |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE . | THREE , SIX , TWELVE , TWENTY_FOUR and ALL_TIME |
report_type | Type of reporting data to sync. Default value: STANDARD . | FLOODLIGHT , REACH and STANDARD |
dimensions | Report dimensions to include into a sync. The date dimension is mandatory for all the report types. The advertiser dimension is mandatory for REACH report type | See Google Campaign Manager 360 documentation |
metrics | Report metrics to include into a sync. | See Google Campaign Manager 360 documentation |
report_configuration_ids | You can select only one Floodlight Configuration ID per account. | |
enable_all_dimension_combinations | Whether to enable all reach dimension combinations in the report. Default value: false | |
conversion_dimensions | Conversion Dimensions. | See Google Campaign Manager 360 documentation |
per_interaction_dimensions | Per Interaction Dimensions. | See Google Campaign Manager 360 documentation |
custom_floodlight_variables | Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "double_click_campaign_manager", "group_id": "target_group_id", "config": { "schema": "test_double_click_campaign_manager", "table": "test_table", "sync_mode": "SPECIFIC_PROFILES", "user_profiles": ["1234567", "8901234"], "timeframe_months": "SIX", "report_type": "FLOODLIGHT", "dimensions": ["date", "activity"], "metrics": ["activeViewPercentAudibleImpressions"], "report_configuration_ids": ["12", "34", "56"], "enable_all_dimension_combinations": true }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Campaign Manager 360 client application.client_secret
Client Secret
of your Google Campaign Manager 360 client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Cloud Functions link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_cloud_function",
"group_id": "target_group_id",
"config": {
"schema": "test_google_cloud_function",
"function_trigger": "https://us-east1-b.projectname.cloudfunctions.net/function_name",
"secrets_list": [
{"key": "secret1", "value": "xxxxxxx"},
{"key": "secret2", "value": "xxxxxxx"}
],
"custom_payloads": [
{"key": "payload1", "value": "payload_value2"},
{"key": "payload2", "value": "payload_value2"}
]
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
function_trigger | The trigger URL of the cloud function. |
secrets_list | The list of secrets that should be passed to the function at runtime. |
custom_payloads | (Optional) The list of key-value pairs that can be used to specify custom information to the function at runtime. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
function_trigger
andsecrets
. - By using the Connect Card or the Fivetran dashboard.
Google Cloud Storage link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "gcs",
"group_id": "target_group_id",
"config": {
"schema": "test_gcs",
"table": "table_name",
"bucket": "bucket_name",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"json_delivery_mode": "Packed",
"compression": "infer",
"on_error": "skip",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0",
"auth_type": "auth_type",
"secret_key": "secret_key",
"line_separator": ";"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
bucket | The name of the GCS bucket. | |
prefix | All files and folders under this folder path will be searched for files to sync. | |
pattern | All files in your search path matching this regular expression will be synced. | |
file_type | If your files are saved with improper extensions, you can force them to by synced as the selected file type. | infer , csv , json , tsv , avro |
json_delivery_mode | Specifies how Fivetran should handle your JSON data. Default value: Packed . | Packed , Unpacked |
compression | The secrets that should be passed to the function at runtime. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error | If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option | If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern | Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence | If your CSVs use a special value indicating null, you can specify it here. | |
delimiter | You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before | We will skip over the number of lines specified before syncing data. | |
skip_after | We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. | |
auth_type | Authorization type. Required for storage bucket authentication. | FIVETRAN_SERVICE_ACCOUNT , CUSTOM_SERVICE_ACCOUNT |
secret_key | Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket. | |
line_separator | You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the
bucket
,auth_type
andsecret_key
fields in the request. - By using the Connect Card or the Fivetran dashboard.
Google Display & Video 360 link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_display_and_video_360",
"group_id": "target_group_id",
"config": {
"schema": "test_google_display_and_video_360",
"table": "table_name",
"config_method": "CREATE_NEW",
"partners": ["1234567", "123456789"],
"advertisers": ["1234567", "123456789"],
"report_type": "TYPE_GENERAL",
"dimensions": ["FILTER_ADVERTISER", "FILTER_DATE"],
"metrics": ["METRIC_CLICKS"],
"query_id": "123456789",
"update_config_on_each_sync": true
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
config_method | The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is CREATE_NEW . | CREATE_NEW , REUSE_EXISTING |
partners | The list of partners to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW . | |
advertisers | The list of advertisers to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW . | |
report_type | The type of the report to create. This is a required parameter when config_method is set to CREATE_NEW . | See Google Display & Video 360 Report Types |
dimensions | The report dimensions (filters) to include into a sync. The dimension names are provided in the API format. This is a required parameter when config_method is set to CREATE_NEW . | See Google Display & Video 360 Dimensions |
metrics | The report metrics to include into a sync. The metric names are provided in the API format. This is a required parameter when config_method is set to CREATE_NEW . | See Google Display & Video 360 Metrics |
query_id | The ID of the query whose configuration you want to reuse. This is a required parameter when config_method is set to REUSE_EXISTING . | |
update_config_on_each_sync | Specifies whether the configuration is updated before each sync or only when the connector settings are saved. This parameter only takes effect when config_method is set to REUSE_EXISTING . The default value is true . | true , false |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_display_and_video_360", "group_id": "target_group_id", "config": { "schema": "test_google_display_and_video_360", "table": "table_name", "config_method": "CREATE_NEW", "partners": ["1234567", "123456789"], "advertisers": ["1234567", "123456789"], "report_type": "TYPE_GENERAL", "dimensions": ["FILTER_ADVERTISER", "FILTER_DATE"], "metrics": ["METRIC_CLICKS"], "query_id": "123456789", "update_config_on_each_sync": true }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Display & Video 360 client application.client_secret
Client Secret
of your Google Display & Video 360 client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Drive link
The connector supports two sync strategies:
Magic Folder Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_drive",
"group_id": "target_group_id",
"config": {
"schema": "test_google_drive",
"folder_id": "folder_id"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
folder_id | Your Google Drive Folder URL. |
Merge Mode Requestlink
To use the Merge Mode sync strategy, specify the is_single_table_mode
parameter as true
. If you don't specify the parameter, we will use the default Magic Folder strategy to sync files.
POST https://api.fivetran.com/v1/connectors
{
"service": "google_drive",
"group_id": "target_group_id",
"config": {
"schema": "test_google_drive",
"table": "test_table",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"json_delivery_mode": "Packed",
"compression": "infer",
"on_error": "fail",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "|",
"escape_char": "escape_char",
"skip_before": "0",
"skip_after": "0",
"is_single_table_mode": "true",
"line_separator": ";"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema (required) | The connector schema name has to be unique within the group (destination). | |
table (required) | The table name within the schema to which the connector will sync the data. | |
prefix (required) | All files and folders under this folder path will be searched for files to sync, this can be the entire drive link or a folder URL | |
pattern | All files in your search path matching this regular expression will be synced. | |
file_type | If your files are saved with improper extensions, you can force them to be synced as the selected filetype. | infer , csv , json , tsv , avro , parquet |
json_delivery_mode | Specifies how Fivetran should handle your JSON data. Default value: Packed . | Packed , Unpacked |
compression | The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error | If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option | If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern | Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence | If your CSVs use a special value indicating null, you can specify it here. | |
delimiter | You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before | We will skip over the number of lines specified before syncing data. | |
skip_after | We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. | |
is_single_table_mode (required as true ) | Allows the creation of connector using Merge Mode strategy. | true , false |
line_separator | You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next. |
Authorizationlink
- The created connector can use authentication via the service account. You must share your Google Drive folder with Fivetran's service account using the account's auto-generated email address.The Google drive folder needs to be shared with Fivetran's service account named g-[group_id]@fivetran-production.iam.gserviceaccount.com where [group_id] is the connector's group ID.
- By using the Connect Card or the Fivetran dashboard.
Google Play link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_play",
"group_id": "target_group_id",
"config": {
"schema": "test_google_play",
"bucket": "bucket_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
bucket | The Google Cloud Storage source bucket. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_play", "group_id": "target_group_id", "config": { "schema": "test_google_play", "bucket": "bucket_name" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Play client application.client_secret
Client Secret
of your Google Play client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Search Ads 360 Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_search_ads_360",
"group_id": "target_group_id",
"config": {
"schema": "test_google_search_ads_360",
"advertisers_sync_mode": "SPECIFIC_ADVERTISERS",
"advertisers": ["111111"],
"accounts_sync_mode": "SPECIFIC_ACCOUNTS",
"accounts": ["222222", "333333"],
"reports": [
{
"table": "account_report",
"report_type": "ACCOUNT",
"attributes": [
"STATUS",
"CREATION_TIMESTAMP",
"LAST_MODIFIED_TIMESTAMP"
],
"metrics": [
"CLICKS",
"COST",
"IMPR"
]
}
],
"timeframe_months": "SIX"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
advertisers_sync_mode | Whether to sync all advertisers or specific advertisers. | ALL_ADVERTISERS , SPECIFIC_ADVERTISERS |
advertisers | Specific advertisers to sync. Must be populated if advertisers_sync_mode is set to SPECIFIC_ADVERTISERS . | |
accounts_sync_mode | Whether to sync all accounts or specific accounts. | ALL_ACCOUNTS , SPECIFIC_ACCOUNTS |
accounts | Specific accounts to sync. Must be populated if accounts_sync_mode is set to SPECIFIC_ACCOUNTS . | |
reports | The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. | |
table | The name of a table within the schema to which connector syncs the data of a given report. | |
report_type | The type of report | See the Google Search Ads 360 Types of Reports documentation for details. |
attributes | The report dimensions included to sync. | See the list of attributes for each report type in the Google Search Ads 360 Type of Reports documentation. |
metrics | The report dimensions included to sync. | See the list of metrics for each report type in the Google Search Ads 360 Type of Reports documentation. |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. | THREE , SIX , TWELVE , TWENTY_FOUR , and ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_search_ads_360", "group_id": "target_group_id", "config": { "schema": "test_google_search_ads_360", "advertisers_sync_mode": "SPECIFIC_ADVERTISERS", "advertisers": ["111111"], "accounts_sync_mode": "SPECIFIC_ACCOUNTS", "accounts": ["222222", "333333"], "reports": [ { "table": "account_report", "report_type": "ACCOUNT", "attributes": [ "STATUS", "CREATION_TIMESTAMP", "LAST_MODIFIED_TIMESTAMP" ], "metrics": [ "CLICKS", "COST", "IMPR" ] } ], "timeframe_months": "SIX" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Search Ads 360 client application.client_secret
Client Secret
of your Google Search Ads 360 client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Search Console link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_search_console",
"group_id": "target_group_id",
"config": {
"schema": "test_google_search_console",
"sync_mode": "SpecificSites",
"site_urls": ["https://fivetran.com", "https://support.fivetran.com"],
"reports": [
{
"table": "search_report",
"report_type": "SEARCH_RESULTS",
"search_types": [
"WEB",
"IMAGE",
"VIDEO",
"NEWS"
],
"dimensions": [
"DATE",
"COUNTRY",
"DEVICE"
],
"aggregation": "BY_PAGE"
}
],
"timeframe_months": "SIX"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode | Whether to sync all sites or specific sites. | AllSites , SpecificSites |
site_urls | Specific Site URLs to sync. Must be populated if sync_mode is set to SpecificSites . | |
reports | The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. | |
table | The name of a table within the schema to which connector syncs the data of a given report. | |
report_type | The type of report | SEARCH_RESULTS , DISCOVER , GOOGLE_NEWS |
search_types | Search types included to sync. Supported only for the SEARCH_RESULTS report type | WEB , IMAGE , VIDEO , NEWS |
dimensions | The report dimensions included to sync. | DATE , COUNTRY , DEVICE , QUERY , PAGE |
aggregation | (Optional) Aggregation type. Supported only for the SEARCH_RESULTS report type | BY_PAGE , BY_PROPERTY |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. | THREE , SIX , TWELVE , TWENTY_FOUR , and ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_search_console", "group_id": "target_group_id", "config": { "schema": "test_google_search_console", "sync_mode": "SpecificSites", "site_urls": ["https://fivetran.com", "https://support.fivetran.com"], "timeframe_months": "SIX" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Google Search Console client application.client_secret
Client Secret
of your Google Search Console client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Sheets link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_sheets",
"group_id": "target_group_id",
"config": {
"schema": "google_sheets",
"table": "table"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group. Required for connector creation. |
table | The table name within the schema for which the connector will sync the data. Required for connector creation. |
Authorizationlink
There are three ways to authorize this connector type:
By specifying the values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_sheets", "group_id": "target_group_id", "config": { "schema": "google_sheets", "table": "table", "sheet_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "named_range": "range" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyConfig parameterslink
Name Description sheet_id
The URL of the sheet that can be copied from the browser address bar, or the ID of the sheet that can be found in the sheet's URL between /d/ and /edit. named_range
The name of the named data range on the sheet that contains the data to be synced. Auth parameterslink
Name Description client_id
Client ID
of your Google Sheets client application.client_secret
Client Secret
of your Google Sheets client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By specifying the values for the
sheet_id
andnamed_range
parameters in the request.POST https://api.fivetran.com/v1/connectors
{ "service": "google_sheets", "group_id": "target_group_id", "config": { "schema": "google_sheets", "table": "table", "sheet_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "named_range": "range", "auth_type": "ServiceAccount" } }
content_copyConfig parameterslink
Name Description sheet_id
The URL of the sheet that can be copied from the browser address bar, or the ID of the sheet that can be found in the sheet's URL between /d/ and /edit. named_range
The name of the named data range on the sheet that contains the data to be synced. auth_type
The ServiceAccount
value must be specified for this type of authorization.NOTE: The connector uses service account authentication. You must share the sheet with Fivetran's service account named
g-[group_id]@fivetran-production.iam.gserviceaccount.com
, where[group_id]
is the connector's group ID.By using the Connect Card or the Fivetran dashboard.
Gorgias Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "gorgias",
"group_id": "target_group_id",
"config": {
"schema": "gorgias_schema_name",
"username": "your_gorgias_username",
"subdomain": "your_gorgias_subdomain",
"api_key": "your_gorgias_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
username | Your Gorgias username. |
subdomain | Your Gorgias subdomain. |
api_key | Your Gorgias API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
subdomain
,username
, andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Greenhouse link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "greenhouse",
"group_id": "target_group_id",
"config": {
"schema": "greenhouse",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Greenhouse API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
GreenPowerMonitor Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "green_power_monitor",
"group_id": "target_group_id",
"config": {
"schema": "green_power_monitor_schema_name",
"username": "your_green_power_monitor_username",
"password": "your_green_power_monitor_password",
"sub_domain": "your_green_power_monitor_subdomain"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
username | Your GreenPowerMonitor username. |
password | Your GreenPowerMonitor password. |
sub_domain | Your GreenPowerMonitor subdomain. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username
,password
, andsub_domain
. - By using the Connect Card or the Fivetran dashboard.
Grepsr Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "grepsr",
"group_id": "target_group_id",
"config": {
"schema": "grepsr_schema_name",
"api_key": "your_grepsr_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Grepsr API Key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key
. - By using the Connect Card or the Fivetran dashboard.
GRIN Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "grin",
"group_id": "target_group_id",
"config": {
"schema": "grin_schema_name",
"api_key": "your_grin_api_key"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your GRIN API key. |
Authorizationlink
There are two ways to authorize this connector type:
- When creating the connector, by specifying the following field in the request:
api_key
. - By using the Connect Card or the Fivetran dashboard.
Guru Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "guru",
"group_id": "target_group_id",
"config": {
"schema": "guru_schema_name",
"username": "your_guru_username",
"password": "your_guru_password"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
username | Your Guru username. |
password | Your Guru password. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
user_name
andpassword
. - By using the Connect Card or the Fivetran dashboard.
HappyFox Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "happyfox",
"group_id": "target_group_id",
"config": {
"schema": "happyfox_schema_name",
"sub_domain": "your_happyfox_sub_domain",
"api_key": "your_happyfox_api_key",
"auth_code": "your_happyfox_auth_code",
"account_name": "your_happyfox_account_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain | Your HappyFox Subdomain. |
api_key | Your HappyFox API Key. |
auth_code | Your HappyFox Auth Code. |
account_name | Your HappyFox Account Name. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
sub_domain
,api_key
,auth_code
andaccount_name
. - By using the Connect Card or the Fivetran dashboard.
Harvest Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "harvest",
"group_id": "target_group_id",
"config": {
"schema": "harvest_schema_name",
"account_id": "your_harvest_account_id",
"personal_access_token": "your_harvest_personal_access_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
account_id | Your Harvest Account ID. |
personal_access_token | Your Harvest Personal Access Token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
account_id
andpersonal_access_token
. - By using the Connect Card or the Fivetran dashboard.
Heap link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "heap",
"group_id": "target_group_id",
"config": {
"schema": "heap",
"bucket": "http://your_test_bucket.s3.amazonaws.com",
"role_arn": "arn:aws:s3:::your_test_bucket"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
bucket | The S3 bucket name. |
role_arn | The Role ARN required for authentication. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
bucket
androle_arn
. - By using the Connect Card or the Fivetran dashboard.
Height link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "height",
"group_id": "target_group_id",
"config": {
"schema": "height",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Height API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Help Scout link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "helpscout",
"group_id": "target_group_id",
"config": {
"schema": "test_helpscout"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
By specifying the values for
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "helpscout", "group_id": "target_group_id", "config": { "schema": "test_helpscout" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
content_copyAuth parameterslink
Name Description client_id
Client ID
of your Help Scout client application.client_secret
Client Secret
of your Help Scout client application.refresh_token
The long-lived refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Helpshift Lite Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "helpshift",
"group_id": "target_group_id",
"config": {
"schema": "helpshift_schema_name",
"api_key": "your_helpshift_api_key",
"domain_name": "your_helpshift_domain_name"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Helpshift API key. |
domain_name | Your Helpshift domain name. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key
anddomain_name
. - By using the Connect Card or the Fivetran dashboard.
Heroku Kafka link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "heroku_kafka",
"group_id": "target_group_id",
"config": {
"schema": "test_heroku_kafka",
"consumer_group": "consumer_group",
"servers": "serveraddress1:8080, serveraddress2:8080",
"message_type": "Json",
"sync_type": "Packed",
"security_protocol": "TLS",
"trusted_cert": "trusted_certificate_value",
"client_cert": "client_certificate_value",
"client_cert_key": "client_certificate_key",
"trust_store_type": "PKCS12",
"key_store_type": "PKCS12"
}
}
content_copy
Config parameterslink
Name | Description | Possible Values |
---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
consumer_group | Heroku Kafka consumer group name. | |
servers | Comma-separated list of Heroku Kafka servers in the format server:port . | |
message_type | Heroku Kafka message type. | Json , Text |
sync_type | Heroku Kafka sync type. Unpacked messages must be valid JSON. | Unpacked , Packed |
security_protocol | Security protocol for Heroku Kafka interaction. | PLAINTEXT , SSL , TLS |
trusted_cert | Heroku Kafka trusted certificate. Required for TLS security protocol. | |
client_cert | Heroku Kafka client certificate. Required for TLS security protocol. | |
client_cert_key | Heroku Kafka client certificate key. Required for TLS security protocol. | |
trust_store_type | Heroku Kafka trust store type. Default value: PKCS12 . Required for TLS security protocol. | |
key_store_type | Heroku Kafka key store type. Default value: PKCS12 . Required for TLS security protocol. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
consumer_group
andservers
. - By using the Connect Card or the Fivetran dashboard.
HiBob Lite link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "hibob",
"group_id": "target_group_id",
"config": {
"schema": "hibob_schema_name",
"api_token": "your_hibob_api_token"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_token | Your HiBob API token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying a value for the
api_token
in the request. - By using the Connect Card or the Fivetran dashboard.
High-Volume Agent Db2 for i Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "db2i_hva",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_db2i",
"host": "host.com",
"port": 8471,
"database": "db2i",
"user": "test_user",
"password": "test_password",
"log_journal_schema": "test_log_journal_schema",
"log_journal": "test_log_journal",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"connection_type": "SshTunnel",
"always_encrypted": true,
"agent_host": "host.com",
"agent_port": 4343,
"agent_user": "hvr",
"agent_password": "agent_password",
"agent_public_cert": "CERTIFICATE"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema_prefix | The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The username. |
password | The user's password. |
database | The database name. |
log_journal_schema | The log journal schema. |
log_journal | The log journal name. |
tunnel_host | SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect via an SSH tunnel. |
tunnel_user | SSH user, specify only to connect via an SSH tunnel. |
connection_type | Possible values:SshTunnel . SshTunnel is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: tunnel_host , tunnel_port , tunnel_user . |
agent_host | The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database. |
agent_port | The port number of the agent. |
agent_user | The agent's user. |
agent_password | The agent user's password. It must have a minimum length of 10 characters. |
agent_public_cert | The agent public certificate. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the
config
section of the request:host
,port
,user
,password
,agent_host
,agent_port
,agent_public_cert
,agent_user
, andagent_password
. - By using the Connect Card or the Fivetran dashboard.
High-Volume Agent Oracle link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "oracle_hva",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_oracle",
"host": "host.com",
"port": 1521,
"database": "oracledb",
"pdb_name": "pdb_name",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"connection_type": "SshTunnel",
"update_method": "TELEPORT",
"always_encrypted": true,
"agent_host": "host.com",
"agent_port": 4343,
"agent_user": "hvr",
"agent_password": "agent_password",
"agent_public_cert": "CERTIFICATE",
"tns": "localhost:1521/TNS",
"use_oracle_rac": false,
"asm_option": false,
"agent_ora_home": "/opt/oracle/product/19c/dbhome_1",
"asm_user": "asm_user",
"asm_password": "asm_password",
"asm_oracle_home": "/asm/oracle/home",
"asm_tns": "localhost:1521/ASM_TNS"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema_prefix | The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The username. |
password | The user's password. |
database | The database name. This is the SID or Service Name provided by your Oracle DBA. |
pdb_name | (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases. |
tunnel_host | SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect via an SSH tunnel. |
tunnel_user | SSH user, specify only to connect via an SSH tunnel. |
connection_type | Possible values:Directly , PrivateLink , SshTunnel . SshTunnel is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: tunnel_host , tunnel_port , tunnel_user . Otherwise, Directly is used as a value if the parameter is omitted. |
update_method | The method used to detect new or changed rows. Supported values: > - LOGMINER - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. This is the default value. - TELEPORT - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes. |
agent_host | The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database. |
agent_port | The port number of the agent. |
agent_user | The agent's user. |
agent_password | The agent user's password. It must have a minimum length of 10 characters. |
agent_public_cert | The agent public certificate. |
agent_ora_home | The home directory of the Oracle database. |
tns | Single-tenant database: The database SID. Multi-tenant database: The database TNS. |
use_oracle_rac | Default value: false . Set to true if you're using a RAC instance. |
asm_option | Default value: false . Set to true if you are using ASM on a non-RAC instance. |
asm_user | The ASM user. Mandatory if use_oracle_rac or asm_option is set to true . |
asm_password | Th ASM user's password. Mandatory if use_oracle_rac or asm_option is set to true . |
asm_oracle_home | The Oracle ASM home directory. |
asm_tns | ASM TNS. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the
config
section of the request:host
,port
,user
,password
,agent_host
,agent_port
,agent_public_cert
,agent_user
, andagent_password
. - By using the Connect Card or the Fivetran dashboard.
High-Volume Agent SAP ECC on Db2 for i Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "db2i_sap_hva",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_db2i_sap",
"host": "host.com",
"port": 8471,
"database": "db2i",
"user": "test_user",
"password": "test_password",
"log_journal_schema": "test_log_journal_schema",
"log_journal": "test_log_journal",
"sap_schema": "test_sap_schema",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"connection_type": "SshTunnel",
"always_encrypted": true,
"agent_host": "host.com",
"agent_port": 4343,
"agent_user": "hvr",
"agent_password": "agent_password",
"agent_public_cert": "CERTIFICATE"
}
}
content_copy
Config parameterslink
Name | Description |
---|---|
schema_prefix | The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The username. |
password | The user's password. |
database | The database name. |
log_journal_schema | The log journal schema. |
log_journal | The log journal name. |
sap_schema | SAP schema name. |
tunnel_host | SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect via an SSH tunnel. |
tunnel_user | SSH user, specify only to connect via an SSH tunnel. |
connection_type | Possible values:SshTunnel . SshTunnel is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: tunnel_host , tunnel_port , tunnel_user . |
agent_host | The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database. |
agent_port | The port number of the agent. |
agent_user | The agent's user. |
agent_password | The agent user's password. It must have a minimum length of 10 characters. |