Connector Config
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:
schematableschema_prefixtimeframe_months
The following connectors can be managed through the Fivetran REST API:
- 15Five
- 360Learning
- 7shifts
- Absorb LMS
- Acculynx
- ActiveCampaign
- Ada
- Adjust
- Adobe Analytics
- Adobe Analytics Data Feed
- Adobe Commerce
- Adobe Workfront
- ADP Workforce Now
- AdRoll
- Adyen
- Affinity
- Afterpay
- Aha!
- Aircall
- Airtable
- Akeneo
- Alchemer
- Algolia
- Amazon Ads
- Amazon Attribution
- Amazon DSP
- Amazon DynamoDB
- Amazon Kinesis Firehose
- Amazon S3
- Amazon Selling Partner
- Amplitude
- Anaplan
- Anvyl
- Apache Kafka
- Appcues
- Appfigures
- Apple App Store
- Apple Search Ads
- AppsFlyer
- Asana
- Assembled
- Attentive
- Attio
- Aumni
- Auth0
- Autodesk BIM 360
- AvantLink
- AVEVA PI
- Awin
- AWS CloudTrail
- AWS Cost And Usage Report
- AWS Inventory
- AWS Lambda
- AWS MSK
- Azure Blob Storage
- Azure Boards
- Azure Cosmos DB for MongoDB
- Azure Cosmos DB for NoSQL
- Azure DevOps
- Azure Functions
- Azure Event Hubs
- Azure Service Bus
- Backbone PLM
- BallotReady
- BambooHR
- Bazaarvoice
- Betterworks
- BigCommerce
- Bigin by Zoho CRM
- BigMarker
- BigQuery
- BillingPlatform
- Birdeye
- Bitly
- Bizzabo
- Boostr
- Box
- Braintree
- Branch
- Brave Ads
- Braze
- Brevo
- Brex
- Brightcove
- Brigntpearl
- Buildium
- Buildkite
- Buzzsprout
- Calabrio
- Calendly
- CallRail
- Campaign Monitor
- Canny
- Canvas by Instructure
- Care Quality Commission
- Castor EDC
- Centra
- Ceridian Dayforce
- Chameleon
- Chargebee Product Catalog 1.0
- Chargebee Product Catalog 2.0
- ChargeDesk
- ChartMogul
- Checkout.com
- Checkr
- Chorus
- Churnkey
- ChurnZero
- Cimis
- Cin7
- CircleCI
- CJ Commission Detail
- Clari
- Clazar
- ClickUp
- Clockify
- Clockodo
- Close
- Cloudbeds
- CloudFront
- Clubspeed
- Coassemble
- CockroachDB
- Codefresh
- Collibra
- Column
- commercetools
- Compliance Checkpoint
- Concord
- Confluence
- Confluent Cloud
- Constant Contact
- Contrast Security
- Convex
- Copper
- Cornerstone
- Coupa
- Criteo
- Criteo Retail Media
- Crossbeam
- crowd.dev
- Culture Amp
- Customer.io
- Cvent
- D2L Brightspace
- Databricks
- Datadog
- dbt Cloud
- DCL Logistics
- Delighted
- Deposco
- Deputy
- Destini
- Dialpad
- Dixa
- Docebo
- DocumentDB
- Donus
- DoorLoop
- Drata
- Drift
- Drip
- Dropbox
- Dropbox Sign
- DSV
- Duoplane
- EasyPost
- Ebay
- e-conomic
- Elasticsearch
- Electronic Tenant Solutions
- Eloqua
- Employment Hero
- Eventbrite
- Eventsforce
- Everflow
- Everhour
- Exact Online
- ExpenseIn
- Expensify
- EZOfficeInventory
- Facebook Ads
- Facebook Pages
- Factbird
- Factorial
- Fillout
- Firebase
- FireHydrant
- Fivetran Platform Connector
- Flexport
- Flywheel Digital
- Fone Dynamics
- Float
- Forj Community
- Formstack
- Fountain
- FourKites
- Freightview
- FreshBooks
- Freshchat
- Freshdesk
- Freshdesk Contact Center
- Freshsales
- Freshservice
- Freshsuccess
- Friendbuy
- Front
- Freshteam
- FTP/FTPS
- FullStory
- G2
- Gainsight Customer Success
- Gainsight Product Experience
- Gem
- Genesys
- GetFeedback
- GitHub
- GitLab
- Gladly
- GlobalMeet
- Gmail
- GoCardless
- Gong
- Google Ad Manager
- Google Ads
- Google Analytics 4
- Google Analytics 4 Export
- Google Business Profile
- Google Calendar
- Google Campaign Manager 360
- Google Classroom
- Google Cloud Functions
- Google Cloud Storage
- Google Display & Video 360
- Google Drive
- Google Play
- Google Search Ads 360
- Google Search Console
- Google Sheets
- Google Tasks
- Gorgias
- Greenhouse
- GreenPowerMonitor
- Grepsr
- GRIN
- Guru
- HappyFox
- Harvest
- Healthie
- 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 Oracle
- High-Volume Agent SAP ECC on Oracle With NetWeaver
- High-Volume Agent SQL Server
- Hilti On!Track
- Hopin
- HubSpot
- iLevel
- Impact
- incident.io
- Infobip
- Insightly
- Instagram Business
- Integral Ad Science
- Integrate
- Intercom
- Invoiced
- Ironclad
- ironSource
- Iterable
- Ivanti
- Jama Software
- Jamf
- Jibble
- Jira
- Jira Align
- JobNimbus
- Jotform
- JustCall
- Kandji
- Kantata
- Katana
- Kevel
- KeyPay
- Khoros Care
- Khoros Communities
- Kisi
- Kissmetrics
- Klarna
- Klaviyo
- Konnect Insights
- Kustomer
- Lattice
- LaunchDarkly
- Leap CRM
- LearnUpon
- Lemlist
- Lessonly
- Lever
- Liftoff
- Lightspeed Retail
- LINE Ads
- Linear
- LinkedIn Ad Analytics
- LinkedIn Company Pages
- LinkSquares
- LiveChat Partner
- Lob
- Looker
- Loop
- Loopio
- Lucca
- Luma
- Mailchimp
- Mailgun
- Mailjet
- Malomo
- Mambu
- Mandrill
- MariaDB
- Marin Software
- Marketo
- Matomo
- Maxio Chargify
- Maxio SaaSOptics
- Medallia
- Medallia Agile Research
- Megaphone
- Mention
- Microsoft Advertising
- Microsoft Dynamics 365 Business Central
- Microsoft Dynamics 365 CRM
- Microsoft Dynamics 365 Finance and Operations
- Microsoft Lists
- Microsoft Entra ID
- Missive
- Mixmax
- Mixpanel
- MNTN
- Mode
- Moloco
- Monday.com
- MongoDB
- Mux
- myosh
- MySQL
- Namely
- Navan
- Nice
- Notion
- NetSuite SuiteAnalytics
- Nylas
- Okendo
- Okta
- Ometria
- ON24
- OnceHub
- OneDrive
- Open Data DC
- Open Exchange Rates
- OpenSearch
- Opsgenie
- Optimizely
- Oracle
- Oracle Business Intelligence Publisher
- Oracle Fusion CRM
- Oracle Fusion FSCM
- Oracle Fusion HCM
- Oracle Moat Analytics
- Orbit
- Ordway
- Ortto
- Outbrain
- Outreach
- Packiyo
- PagerDuty
- PandaDoc
- Papershift
- Pardot
- Partnerize
- PartnerStack Vendor
- Paychex
- PayPal
- Pendo
- Persona
- Personio
- Phoenix Ads
- Picqer
- Pigment
- Pingdom
- Pinpoint
- Pinterest Ads
- Pinterest Organic
- Pipedrive
- Pivotal Tracker
- Piwik PRO
- Placer.ai
- Planful
- PlanetScale
- Planhat
- Playvox
- Playvox Workforce Management
- Podio
- PostgreSQL
- PostHog
- Postmark
- PowerReviews Enterprise
- Prisma Cloud
- Prive
- Procore
- Productboard
- Productive
- Proofpoint Security Awareness
- Qualaroo
- Qualtrics
- QuickBooks
- Quora Ads
- Quorum
- Rakuten Advertising
- Ramp
- Rarible
- ReBound Returns
- Recharge
- Recurly
- Reddit Ads
- ReferralHero
- Reltio
- Reply.io
- Resource Management by Smartsheet
- RetailNext
- Retently
- Revel Systems
- RevenueCat
- REVIEWS.ai
- REVIEWS.io
- RevOps
- RevX
- Ricochet360
- RingCentral
- Ringover
- Rippling
- Rithum
- Rocketlane
- Rokt
- Rollbar
- Rootly
- RTB House
- Ruddr
- Rundeck
- SafeBase
- SafetyCulture
- Sage HR
- Sage Intacct
- Sailthru
- Salesforce
- Salesforce Commerce Cloud
- Salesforce Marketing Cloud
- Salesloft
- Salsify
- Samsara
- Sana
- SAP Business ByDesign
- SAP Concur
- SAP HANA
- SAP SuccessFactors
- SAP S/4
- SCORM
- Security Journey
- Segment
- SendGrid
- ServiceNow
- ServiceTitan
- Sensor Tower
- SFTP
- SharePoint
- Sharetribe
- ShipHero
- ShipNetwork
- ShipStation
- Shopify
- Shopware
- Short.io
- Shortcut
- Sigma Computing
- Simplecast
- Simplesat
- SingleStore
- SISTRIX
- Skilljar
- SkillsTX
- Skuvault
- Slab
- Slack
- Smadex
- SmartHR
- SmartRecruiters
- Smartwaiver
- Snapchat Ads
- Snyk
- Snowflake
- Snowplow
- SolarWinds Service Desk
- SonarQube
- SparkPost
- Splash
- Split
- Splunk
- Spotify Ads
- Sprout Social
- SQL Server
- Square
- Squarespace
- StackAdapt
- Standard Metrics
- StarRez
- Statistics Netherlands CBS
- Statsig
- Statuspage
- sticky.io
- Stripe
- Stylight
- Subscript
- SugarCRM
- SurveyMonkey
- Survicate
- Swoogo
- Tableau
- Taboola
- Talkdesk
- Talkwalker
- Teads
- Teamtailor
- Teamwork
- Tempo
- TestRail
- TextUs
- The Movie Database
- The Trade Desk
- Thinkific
- Ticket Tailor
- TikTok Ads
- Tive
- Toggl Track
- Totango
- Transcend
- Trelica
- Trello
- Tremendous
- Triple Whale
- Trisolute
- Twilio
- Twitter Organic
- Twitter Ads
- Tymeshift
- Typeform
- Udemy Business
- UKG Pro
- Unicommerce
- Upland Software
- UpPromote
- UserVoice
- Veeva Vault
- Vimeo
- Visit by GES
- Visma
- Vitally
- Vonage
- Vonage Contact Center
- VTS
- VWO
- Walmart DSP
- Walmart Marketplace
- Wasabi Cloud Storage
- Webconnex
- Webhooks
- Web Scraper
- When I Work
- Wherefour
- Wicked Reports
- WooCommerce
- WordPress
- Workable
- Workday Financial Management
- Workday HCM
- Workday RaaS
- Workday Strategic Sourcing
- Workleap Officevibe
- WorkRamp
- Wrike
- Xactly
- Xandr
- Xero
- Xray
- Xsolla
- Yahoo DSP
- Yahoo Search Ads on Yahoo Japan
- Yotpo
- Younium
- YouTube Analytics
- Zendesk Chat
- Zendesk Sell
- Zendesk Sunshine
- Zendesk Support
- Zenefits
- Zingtree
- Zip
- Zoho Books
- Zoho Campaigns
- Zoho CRM
- Zoho Desk
- Zoho Inventory
- Zonka Feedback
- Zoom
- Zuora
- Zuora Sandbox
15Five Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your 15Five API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
360Learning Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your 360Learning API key. |
company_id | Your 360Learning company ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandcompany_id. - By using the Connect Card or the Fivetran dashboard.
7shifts Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "7shifts",
"group_id": "target_group_id",
"config": {
"schema": "7shifts_schema_name",
"access_token": "your_7shifts_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your 7shifts access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Absorb LMS Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "absorb_lms",
"group_id": "target_group_id",
"config": {
"schema": "absorb_lms_schema_name",
"username": "your_absorb_lms_username",
"password": "your_absorb_lms_password",
"sub_domain": "your_absorb_lms_subdomain",
"private_key": "your_absorb_lms_rest_api_private_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Absorb LMS username. |
password | Your Absorb LMS password. |
sub_domain | Your Absorb LMS subdomain. |
private_key | Your Absorb LMS REST API private key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,password,sub_domain, andprivate_key. - By using the Connect Card or the Fivetran dashboard.
Acculynx Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "acculynx",
"group_id": "target_group_id",
"config": {
"schema": "acculynx_schema_name",
"api_key": "your_acculynx_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Acculynx API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
ActiveCampaign Lite
Request
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/"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your ActiveCampaign API key. |
sub_domain | Your ActiveCampaign subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Ada Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
bearer_token | Your Ada API access token. |
sub_domain | Your Ada bot handle. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
bearer_tokenandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Adjust
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "adjust",
"group_id": "target_group_id",
"config": {
"schema": "adjust"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
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 theauthsection.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" } }Auth parameters
Name Description Possible Values csv_definitionCSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition). export_storage_typeYour cloud storage. GCS,AWS_S3bucket_nameYour AWS S3 or GCS bucket. s3_role_arnUsed if the export_storage_typeisAWS_S3, the Role ARN required for authentication.NOTE: If
export_storage_typeisGCSis, 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
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics",
"authentication_method": "OAUTH2",
"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"
]
}
]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
authentication_method | Authentication method of your Adobe Project. | OAUTH2, JWT_TOKEN |
client_id | Client ID from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. | |
client_secret | Client Secret from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. | |
technical_account_id | Technical Account ID from the Service Account (JWT) credentials of your Adobe Project. Must be populated if authentication_method is set to JWT_TOKEN. | |
organization_id | Organization ID from the Service Account (JWT) credentials of your Adobe Project. Must be populated if authentication_method is set to JWT_TOKEN. | |
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----). Must be populated if authentication_method is set to JWT_TOKEN. | |
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. |
Authorization
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Adobe Analytics Data Feed
The Adobe Analytics Data Feed connector supports the following cloud file storage services as a source:
The API requests are source-specific.
Amazon S3 Request
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",
"folder_path": "folder/path"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
s3bucket | The S3 bucket name. |
s3role_arn | The Role ARN required for authentication. |
source | The data source. |
folder_path | The location to search for and sync data feeds. |
Amazon S3 Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
s3bucket,s3role_arn,sourceandfolder_path. - By using the Connect Card or the Fivetran dashboard.
Azure Blob Request
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",
"folder_path": "folder/path",
"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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | |
folder_path | The location to search for and sync data feeds. |
Azure Blob Authorization
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,sourceandfolder_path. - By using the Connect Card or the Fivetran dashboard.
FTP(S) Request
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,
"folder_path": "folder/path"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | |
folder_path | The location to search for and sync data feeds. |
FTP(S) Authorization
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,sourceandfolder_path. - By using the Connect Card or the Fivetran dashboard.
SFTP Request
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",
"folder_path": "folder/path",
"sftp_host": "host",
"sftp_port": 22,
"sftp_user": "user",
"sftp_password": "password",
"sftp_is_key_pair": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | |
folder_path | The location to search for and sync data feeds. |
SFTP Authorization
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,sourceandfolder_path. - By using the Connect Card or the Fivetran dashboard.
Adobe Commerce Private Preview
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
host_url | Your Adobe Commerce host url. |
username | Your Adobe Commerce username. |
password | Your Adobe Commerce password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host_url,usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Adobe Workfront Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_workfront",
"group_id": "target_group_id",
"config": {
"schema": "adobe_workfront_schema_name",
"organization_domain": "your_adobe_workfront_organization_domain",
"client_id": "your_adobe_workfront_client_id",
"client_secret": "your_adobe_workfront_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
organization_domain | Your Adobe Workfront organization domain. |
client_id | Your Adobe Workfront client ID. |
client_secret | Your Adobe Workfront client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
organization_domain,client_id, andclient_secret. - By using the Connect Card or the Fivetran dashboard.
ADP Workforce Now
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
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_certificateandprivate_key. - By using the Connect Card or the Fivetran dashboard.
AdRoll
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.
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your AdRoll client application.client_secretClient Secretof your AdRoll client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or through the Fivetran dashboard.
Adyen Beta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "adyen",
"group_id": "target_group_id",
"config": {
"schema": "adyen_schema_name",
"web_service_api_key": "adyen_web_service_api_key",
"report_service_api_key": "adyen_report_service_api_key",
"is_test_account": false
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
web_service_api_key | Your Adyen web service API key. | |
report_service_api_key | Your report service API key. | |
is_test_account | Specifies if your Adyen account is a test account. Default value: false. | true, false |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
web_service_api_key,report_service_api_key, andis_test_account. - By using the Connect Card or the Fivetran dashboard.
Affinity Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Affinity API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Afterpay Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_environment | Your Afterpay API environment. |
merchant_id | Your Afterpay merchant ID. |
secret_key | Your Afterpay secret key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_environment,merchant_idandsecret_key. - By using the Connect Card or the Fivetran dashboard.
Aha! Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "aha",
"group_id": "target_group_id",
"config": {
"schema": "aha_schema_name",
"base_url": "your_aha_subdomain",
"api_token": "your_aha_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your Aha! subdomain. |
api_key | Your Aha! API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
subdomainandapi_key. - By using the Connect Card or the Fivetran dashboard.
Aircall Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_id | Your Aircall API ID. |
api_token | Your Aircall API Token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_idandapi_token. - By using the Connect Card or the Fivetran dashboard.
Airtable
Request
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.
POST https://api.fivetran.com/v1/connectors
{
"service": "airtable",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_airtable",
"base_id": "airtable_base_id",
"table_name": "airtable_table_name"
}
}
NOTE: For Airtable non-enterprise accounts, add the
base_id,table_namefields underconfigsection.
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
base_id | ID of base in Airtable |
table_name | Name of table in Airtable |
Authorization
There are two ways to authorize this connector type:
By specifying values for the
client_accessandrefresh_tokenparameters in theauthsection of the request.POST https://api.fivetran.com/v1/connectors{ "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" } }Auth parameters
Name Description client_idClient ID of your Airtable client application. client_secretClient Secret of your Airtable client application. refresh_tokenThe long-lived refresh token along with the client ID and client secret carry the information necessary to get a new access token for API resources. By using the Connect Card or the Fivetran dashboard.
Akamai Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "akamai",
"group_id": "akamai_group_id",
"config": {
"schema": "akamai_schema_name",
"hostname": "your_akamai_hostname",
"type_name": "your_akamai_type_name",
"client_id": "your_akamai_client_id",
"client_secret": "your_akamai_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
hostname | Your Akamai hostname. |
type_name | Your Akamai type name. |
client_id | Your Akamai client ID. |
client_secret | Your Akamai client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
hostname,type_name,client_id, andclient_secret. - By using the Connect Card or the Fivetran dashboard.
Akeneo Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "akeneo",
"group_id": "target_group_id",
"config": {
"schema": "akeneo_schema_name",
"base_url": "your_akeneo_base_url",
"client_id": "your_akeneo_client_id",
"client_secret": "your_akeneo_client_secret",
"username": "your_akeneo_username",
"password": "your_akeneo_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your Akeneo base URL. |
client_id | Your Akeneo client ID. |
client_secret | Your Akeneo client secret. |
username | Your Akeneo username. |
password | Your Akeneo password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
base_url,client_id,client_secret,username, andpassword. - By using the Connect Card or the Fivetran dashboard.
Alchemer
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
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_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Algolia Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "algolia",
"group_id": "target_group_id",
"config": {
"schema": "algolia_schema_name",
"region": "your_algolia_analytics_region",
"application_id": "your_algolia_application_id",
"api_key": "your_algolia_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
region | Your Algolia analytics region. |
application_id | Your Algolia application ID. |
api_key | Your Algolia API key. |
Authorization
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
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Amazon Ads client application.client_secretClient Secretof your Amazon Ads client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters 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
Request
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",
"region_token_url": "your_amazon_attribution_region",
"region_auth_url": "your_amazon_attribution_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
region_api_url | The region corresponding to your Amazon marketplace. |
region_token_url | The region corresponding to your Amazon marketplace. |
region_auth_url | The region corresponding to your Amazon marketplace. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
region_api_url,region_token_url, andregion_auth_url. - By using the Connect Card or the Fivetran dashboard.
Amazon DSP Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "amazon_dsp",
"group_id": "target_group_id",
"config": {
"schema": "amazon_dsp_schema_name",
"api_url_region": "your_amazon_dsp_api_url_region",
"token_url_region": "your_amazon_dsp_token_url_region",
"auth_url_region": "your_amazon_dsp_auth_grant_url_region",
"profiles": "your_amazon_dsp_profiles"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
api_url_region | Your Amazon DSP API URL region. | |
token_url_region | Your Amazon DSP token URL region. | |
auth_url_region | Your Amazon DSP auth grant URL region. | |
profiles | Comma-separated list of your Amazon DSP profiles. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessparameter in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "amazon_dsp", "group_id": "target_group_id", "config": { "schema": "amazon_dsp_schema_name", "api_url_region": "your_amazon_dsp_api_url_region", "token_url_region": "your_amazon_dsp_token_url_region", "auth_url_region": "your_amazon_dsp_auth_url_region", "profiles": "your_amazon_dsp_profiles_with_comma_separated" }, "auth": { "client_access": { "client_id": "your_amazon_dsp_client_id", "client_secret": "your_amazon_dsp_client_secret" }, "refresh_token": "your_amazon_dsp_refresh_token", "access_token": "your_amazon_dsp_access_token" } }Auth parameters
Name Description client_access.client_idYour Amazon DSP client ID. client_access.client_secretYour Amazon DSP client secret. refresh_tokenYour Amazon DSP refresh token. access_tokenYour Amazon DSP access token. By using the Connect Card or the Fivetran dashboard.
Amazon DynamoDB
Before creating a Amazon DynamoDB connection, you must first follow the Amazon DynamoDB setup guide.
Request
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": []
}
}
Config parameters
| 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 Amazon 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). |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
external_id,role_arnandaws_region_code. - By using the Connect Card or the Fivetran dashboard.
Amazon Kinesis Firehose
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
role_arnandbucket. - By using the Connect Card or the Fivetran dashboard.
Amazon S3
Request
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",
"non_standard_escape_char": "false",
"escape_char_options": "CUSTOM_ESCAPE_CHAR",
"escape_char": "",
"delimiter": "",
"null_sequence": "",
"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": ";"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | csv, json, tsv, avro, jsonl, log, parquet, xml, infer |
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 overwrites 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. | |
non_standard_escape_char | Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false. | false, true |
escape_char_options | Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. Required for CSV parsing when non_standard_escape_char is true. Select the CUSTOM_ESCAPE_CHAR option if your file uses custom escape characters to escape quotation marks. Select the DELIMITED_ONLY option if your file doesn't use escape characters to escape quotation marks, and you want your file to be processed with delimiter only. | CUSTOM_ESCAPE_CHAR, DELIMITED_ONLY |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. Required for CSV parsing if escape_char_options is CUSTOM_ESCAPE_CHAR | |
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. | |
null_sequence | If your CSVs use a special value indicating null, you can specify it 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. |
Upsert with custom primary key
1. Create a connector with custom primary key
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "s3",
"group_id": "target_group_id",
"paused": "true",
"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_with_primary_keys",
"archive_pattern": "regex_pattern",
"non_standard_escape_char": "false",
"escape_char_options": "CUSTOM_ESCAPE_CHAR",
"escape_char": "",
"delimiter": "",
"null_sequence": "",
"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": ";"
}
}
| Name | Description | Possible Values |
|---|---|---|
paused | To build a connector with custom primary key enabled, the value must be set to true . | true |
append_file_option | If you select upsert_file_with_primary_keys, you can keep the most recent version of every record and your files will have a combination of the old and new data or data that is updated periodically. You can choose the primary keys you want to use after you save and test. | upsert_file_with_primary_keys |
2. Reload the schema using API call
Request
POST http://api.fivetran.com/v1/connectors/{connector_id}/schemas/reload
Response
{
"code": "Success",
"data": {
"enable_new_by_default": true,
"schemas": {
"schema_1": {
"name_in_destination": "schema_1",
"enabled": true,
"tables": {
"table_1": {
"name_in_destination": "table_1",
"enabled": true,
"columns": {
"column_1": {
"name_in_destination": "column_1",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
},
"column_2": {
"name_in_destination": "column_2",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
},
"column_3": {
"name_in_destination": "column_3",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
},
"column_4": {
"name_in_destination": "column_4",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
},
"_file": {
"name_in_destination": "_file",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
},
"_line": {
"name_in_destination": "_line",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
},
"_modified": {
"name_in_destination": "_modified",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
}
},
"enabled_patch_settings": {
"allowed": true
},
"supports_columns_config": true
}
}
}
},
"schema_change_handling": "ALLOW_ALL"
}
}
3. Modify the connector schema config
To assign a column as the primary key, copy the schema details from the response and set the is_primary_key value as true.
Request
PATCH http://api.fivetran.com/v1/connectors/{connector_id}/schemas
{
"schema_change_handling": "ALLOW_ALL",
"schemas": {
"schema_1": {
"enabled": true,
"tables": {
"table_1": {
"enabled": true,
"columns": {
"column_1": {
"is_primary_key": true
},
"column_3":{
"is_primary_key": true
}
}
}
}
}
}
}
Response
{
"code": "Success",
"data": {
"enable_new_by_default": true,
"schemas": {
"schema_1": {
"name_in_destination": "schema_1",
"enabled": true,
"tables": {
"table_1": {
"name_in_destination": "table_1",
"enabled": true,
"columns": {
"column_1": {
"name_in_destination": "column_1",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": false,
"reason_code": "SYSTEM_COLUMN",
"reason": "Column is selected as a Primary Key"
},
"is_primary_key": true
},
"column_2": {
"name_in_destination": "column_2",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
},
"column_3": {
"name_in_destination": "column_3",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": false,
"reason_code": "SYSTEM_COLUMN",
"reason": "Column is selected as a Primary Key"
},
"is_primary_key": true
},
"column_4": {
"name_in_destination": "column_4",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
},
"_file": {
"name_in_destination": "_file",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
},
"_line": {
"name_in_destination": "_line",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
},
"_modified": {
"name_in_destination": "_modified",
"enabled": true,
"hashed": false,
"enabled_patch_settings": {
"allowed": true
}
}
},
"enabled_patch_settings": {
"allowed": true
},
"supports_columns_config": true
}
}
}
},
"schema_change_handling": "ALLOW_ALL"
}
}
NOTE: You can confirm your primary key selection on the Schema tab of your connector details page.
Authorization
There are two ways to authorize this connector type:
By specifying the value for the
bucketfield along with the following fields depending on theauth_type:- If
IAM_ROLE, specify values for theexternal_idandrole_arnfields. - If
ACCESS_KEY, specify values for theaccess_key_idandaccess_key_secretfields.
- If
By using the Connect Card or the Fivetran dashboard.
Amazon Selling Partner
Request
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
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
By specifying the following parameters in the
authsection.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" } }Auth parameters
Name Description aws_access_keyAWS Access Keyof your AWS Account User.aws_secret_keyAWS Secret Keyof your AWS Account User.role_arnIAM Role ARNof your AWS Account.client_idClient IDof your Amazon Seller/Vendor Central client application.client_secretClient Secretof your Amazon Seller/Vendor Central client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Amplitude
Request
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"
}
]
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
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
Request
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" ]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
When creating, depending on the
auth-mode:- If
Basic, by specifying the values for theusernameandpasswordfields. - If
Certificate, by specifying the values for thecertificateandprivate_keyfields.
- If
After creation using the Connect Card or the Fivetran dashboard.
Anvyl Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "anvyl",
"group_id": "target_group_id",
"config": {
"schema": "anvyl_schema_name",
"api_key": "your_anvyl_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Anvyl API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Apache Kafka
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
consumer_groupandservers. - By using the Connect Card or the Fivetran dashboard.
Appcues Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_key,secret,account_idandemail. - By using the Connect Card or the Fivetran dashboard.
Appfigures Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_key | Your Appfigures client key. |
username | Your Appfigures username. |
password | Your Appfigures password. |
Authorization
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
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "apple_search_ads",
"group_id": "target_group_id",
"config": {
"schema" : "apple_search_ads"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are three ways to authorize this connector type:
By specifying the values for the
pem_certificateandprivate_keyfields 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" } }By specifying
is_auth2_enabledastrueand specifying values for the following fieldsclient_id,team_id,key_idandpem_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" } }By using the Connect Card or the Fivetran dashboard.
AppsFlyer
Request
POST https://api.fivetran.com/v1/connectors
Request when using webhooks and Data Locker
{
"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",
"rollback_window": "rollback_window_size"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | |
rollback_window | The time frame of the rollback sync to capture data. Default value: 2 | From 1 to 90 days. |
Request when using webhooks and Pull API
{
"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"}
]
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Request when using only webhooks
{
"service": "appsflyer",
"group_id": "target_group_id",
"config": {
"schema": "test_appsflyer",
"sync_data_locker": false
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sync_data_locker | Select false to sync AppsFlyer data using only webhooks. |
Authorization
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_folderandconnection_name, if you are connecting using webhooks and Data Locker. - By specifying the field
sync_data_lockerasfalse, if you are connecting using only webhooks. - By using the Connect Card or the Fivetran dashboard.
Asana
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "asana",
"group_id": "target_group_id",
"config": {
"schema": "test_asana",
"sync_mode": "SpecificProjects",
"projects": ["12345678", "23456789"]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Asana client application.client_secretClient Secretof your Asana client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or through the Fivetran dashboard.
Assembled
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Assembled API key. |
Authorization
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
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Attentive API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Attio Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "attio",
"group_id": "target_group_id",
"config": {
"schema": "attio_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessfield in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "attio", "group_id": "target_group_id", "config": { "schema": "attio_schema_name" }, "auth": { "client_access": { "client_id": "your_attio_client_id", "client_secret": "your_attio_client_secret" } } }Auth parameters
| Name | Description |
|---|---|
client_id | Your Attio client ID. |
client_secret | Your Attio client secret. |
- By using the Connect Card or the Fivetran dashboard.
Aumni Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Aumni API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Auth0 Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,domainandaudience. - By using the Connect Card or the Fivetran dashboard.
Autodesk BIM 360 Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "autodesk_bim_360",
"group_id": "target_group_id",
"config": {
"schema": "autodesk_bim_360_schema_name",
"client_id": "your_autodesk_bim_360_client_id",
"client_secret": "your_autodesk_bim_360_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Autodesk BIM 360 client ID. |
client_secret | Your Autodesk BIM 360 client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret. - By using the Connect Card or the Fivetran dashboard.
AvantLink Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your AvantLink API key |
merchant_id | Your AvantLink merchant ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandmerchant_id. - By using the Connect Card or the Fivetran dashboard.
AVEVA PI Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "aveva_pi",
"group_id": "target_group_id",
"config": {
"schema": "aveva_pi_schema_name",
"ip_address": "af_server_host",
"port": 443,
"database_name": "af_database_name",
"username": "your_username",
"password": "your_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
ip_address | IP address of the AF server. |
port | Port number on which the AF Server is running. |
database_name | Your AF database name. |
username | The username you use to authenticate with the AF server. |
password | The password you use to authenticate with the AF server. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Awin Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Awin API token. |
region | Your Awin region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_tokenandregion. - By using the Connect Card or the Fivetran dashboard.
AWS CloudTrail
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
external_id,role_arnandbucket. - By using the Connect Card or the Fivetran dashboard.
AWS Cost And Usage Report Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "aws_cost_report",
"group_id": "target_group_id",
"config": {
"schema": "test_aws_cost_report",
"table": "aws_cost_report_table",
"role_arn": "arn::your_role_arn",
"bucket": "aws_region_code",
"prefix": "folder_path"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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 AWS S3 bucket. |
prefix | The path prefix specified during report creation. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
role_arnandbucket. - By using the Connect Card or the Fivetran dashboard.
AWS Inventory
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
role_arnandbucket. - By using the Connect Card or the Fivetran dashboard.
AWS Lambda
Request
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"}
]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following fields in the request:
function,role_arnandsecrets_list.By using the Connect Card or the Fivetran dashboard.
AWS MSK
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
By passing the security protocol secrets:
- If you select
TLSas Security Protocol, upload theTrusted Certificate,Client Certificate, andClient Certificate Keyfiles. - If you select
SASLas Security Protocol andSCRAM_SHA_512as SASL Mechanism, enter your secret'ssaslScram512KeyandsaslScram512Secret. - If you select
SASLas Security Protocol andIAMas SASL Mechanism, enter yourExternal IDandRole ARN.
- If you select
By using the Connect Card or the Fivetran dashboard.
Azure Blob Storage
Request
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": ";"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | csv, json, tsv, avro, jsonl, log, parquet, xml, infer |
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 overwrites 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. | |
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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
container_nameandconnection_string. - By using the Connect Card or the Fivetran dashboard.
Azure Boards Lite Private Preview
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Azure Boards Organization Name. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessparameter in theauthsection.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" } } }Auth parameters
Name Description client_access.client_idYour Azure Boards Client ID. client_access.client_secretYour Azure Boards Client Secret. By using the Connect Card or the Fivetran dashboard.
Azure Cosmos DB for MongoDB
POST https://api.fivetran.com/v1/connectors
{
"service": "azure_cosmos_for_mongo",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_cosmos_for_mongo",
"hosts": ["mongodb://cosmos-for-mongo-db.mongo.cosmos.azure.com:10255"],
"user": "test_user",
"password": "test_password",
"packing_mode": "UseUnpackedModeOnly",
"database": "admin"
}
}
Config parameters
| Name | Description | Notes |
|---|---|---|
schema_prefix | The connector schema prefix has to be unique within the group (destination). Required for connector creation. | |
hosts | A list of host addresses of the primary node and all replicas. Each list item is either a DB instance host/IP address with a port number or SRV host record. | |
user | The user name. | |
password | The user's password. | |
packing_mode | The pack mode type. Supported values:UseUnpackedModeOnly- Unpacks one layer of nested fields and infers types.UsePackedModeOnly- Delivers packed data as a single destination column value. Learn more in our Azure Cosmos DB Pack Mode Options documentation. | |
database | The source database used for authentication. Typically, the admin database. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
userandpassword. - By using the Connect Card or the Fivetran dashboard.
Azure Cosmos DB for NoSQL
Request with account_key
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"
}
}
Config parameters
| 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 Azure 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 pack 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 Azure Cosmos DB Sync Pack Mode Options documentation. Required for connector creation. |
Request with resource_token
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"
}
}
Config parameters
| 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 Azure Cosmos DB Data Access Methods documentation. |
resource_token | A token that provides access to a specific Azure 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 pack 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 Azure Cosmos DB Pack Mode Options documentation. |
Authorization
There are three ways to authorize this connector type:
- By specifying
"data_access_method":"ACCOUNT_KEY"and the value for theaccount_keyfield in the request. - By specifying
"data_access_method":"RESOURCE_TOKEN"and the values for the following fields in the request:resource_token,token_authenticated_database, andtoken_authenticated_container. - By using the Connect Card or the Fivetran dashboard.
Azure DevOps Beta
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Azure DevOps Organization Name. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessparameter in theauthsection.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" } } }Auth parameters
Name Description client_access.client_idYour Azure DevOps Client ID. client_access.client_secretYour Azure DevOps Client Secret. By using the Connect Card or the Fivetran dashboard.
Azure Functions
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
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_keyandsecrets. - By using the Connect Card or the Fivetran dashboard.
Azure Event Hubs
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
connection_stringandconsumer_groupfields in the request. - By using the Connect Card or the Fivetran dashboard.
Azure Service Bus
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 using ssh. Required if connection_method is sshTunnel | |
host_user | The username on the host machine which we use to connect to ASB using ssh. Required if connection_method is sshTunnel |
Auth parameters
| 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 |
Authorization
There are three ways to authorize this connector type:
- By providing the connection string in the
authfield whenauth_typeisConnectionString. - By specifying values for
access_token,refresh_token, andscopewhenauth_typeisAzureActiveDirectory. - By using the Connect Card or the Fivetran dashboard when
auth_typeisAzureActiveDirectory.
Backbone PLM Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "backbone_plm",
"group_id": "target_group_id",
"config": {
"schema": "backbone_plm_schema_name",
"api_token": "backbone_plm_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Backbone PLM API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
BallotReady Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your BallotReady GraphQL API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
BambooHR
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Bazaarvoice Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "bazaarvoice",
"group_id": "target_group_id",
"config": {
"schema": "bazaarvoice_schema_name",
"environment": "your_bazaarvoice_environment",
"api_key": "your_bazaarvoice_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
environment | Your Bazaarvoice environment. |
api_key | Your Bazaarvoice API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
environmentandapi_key. - By using the Connect Card or the Fivetran dashboard.
Betterworks Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "betterworks",
"group_id": "target_group_id",
"config": {
"schema": "betterworks_schema_name",
"sub_domain": "your_betterworks_subdomain",
"api_key": "your_betterworks_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Betterworks subdomain. |
api_key | Your Betterworks API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
sub_domainandapi_keyfields in the request. - By using the Connect Card or the Fivetran dashboard.
BigQuery
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "bigquery_db",
"group_id": "target_group_id",
"config": {
"schema_prefix": "schema_prefix",
"project_id": "projectId",
"quota_project_id": "quotaProjectId",
"data_set_name": "dataSetName",
"secret_key": "secretKey",
"use_service_account": "false"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
project_id | BigQuery project ID. |
quota_project_id | (Optional) Quota 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. |
Authorization
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
BigCommerce
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
store_hash | The store hash in your API path. |
access_token | Your API access token . |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
store_hashandaccess_token. - By using the Connect Card or the Fivetran dashboard.
Bigin by Zoho CRM Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "bigin_by_zoho_crm",
"group_id": "target_group_id",
"config": {
"schema": "bigin_by_zoho_crm_schema_name",
"client_id": "your_bigin_by_zoho_crm_client_id",
"client_secret": "your_bigin_by_zoho_crm_client_secret",
"edition": "your_bigin_by_zoho_crm_pricing_plan",
"region": "your_bigin_by_zoho_crm_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Bigin by Zoho CRM client ID. |
client_secret | Your Bigin by Zoho CRM client secret. |
edition | Your Bigin by Zoho CRM pricing plan. |
region | Your Bigin by Zoho CRM region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,edition, andregion. - By using the Connect Card or the Fivetran dashboard.
BigMarker Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "bigmarker",
"group_id": "target_group_id",
"config": {
"schema": "bigmarker_schema_name",
"api_key": "your_bigmarker_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your BigMarker API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
BillingPlatform Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your BillingPlatform base URL. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following fields:
client_idandclient_secretin theconfigsectionaccess_tokenandrefresh_tokenin theauthsection
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" } }Auth parameters
Name Description client_idYour BillingPlatform client ID. client_secretYour BillingPlatform client secret. refresh_tokenYour BillingPlatform refresh token. access_tokenYour BillingPlatform access token. By using the Connect Card or the Fivetran dashboard.
Birdeye Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
business_id | Your Birdeye Business ID. |
query_param_value | Your Birdeye API Key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
business_idandquery_param_value. - By using the Connect Card or the Fivetran dashboard.
Bitly Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your Bitly access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Bizzabo Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "bizzabo",
"group_id": "target_group_id",
"config": {
"schema": "bizzabo_schema_name",
"api_key": "your_bizzabo_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Bizzabo API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Boostr Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "boostr",
"group_id": "target_group_id",
"config": {
"schema": "boostr_schema_name",
"base_url": "your_boostr_base_url",
"email": "your_boostr_username",
"password": "your_boostr_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your Boostr base URL. |
email | Your Boostr username. |
password | Your Boostr password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
base_url,email, andpassword. - By using the Connect Card or the Fivetran dashboard.
Box
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 Request
POST https://api.fivetran.com/v1/connectors
{
"service": "box",
"group_id": "target_group_id",
"config": {
"schema": "test_box",
"folder_id": "folder_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
folder_id | Your Box Folder URL. |
Merge Mode Request
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": ";"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema (required) | The connector schema name has to be unique within the 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. | csv, json, tsv, avro, jsonl, log, parquet, xml, spreadsheet, infer |
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 overwrites 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. |
Authorization
This type of connector can only be authorized through the Connect Card or the Fivetran dashboard.
Braintree
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
public_key,private_keyandmerchant_id. - By using the Connect Card or the Fivetran dashboard.
Branch
NOTE: You will need to register the Fivetran-generated webhooks URL in your Branch dashboard. See the Branch setup guide for more details.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "branch",
"group_id": "target_group_id",
"config": {
"schema": "test_branch"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
This type of connector does not require authorization and can be created using the Create a Connector endpoint.
Brave Ads
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "brave_ads",
"group_id": "target_group_id",
"config": {
"schema": "brave_ads_schema_name",
"api_key": "your_brave_ads_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Brave Ads API key |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Braze
Request
POST https://api.fivetran.com/v1/connectors
AWS S3 Current
{
"service": "braze",
"group_id": "target_group_id",
"config": {
"schema": "test_braze",
"api_url": "test_api_url",
"api_key": "test_api_key",
"historic_sync_time_frame": "THREE_MONTHS",
"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"
}
}
GCS Current
{
"service": "braze",
"group_id": "target_group_id",
"config": {
"schema": "test_braze",
"api_url": "test_api_url",
"api_key": "test_api_key",
"historic_sync_time_frame": "THREE_MONTHS",
"cloud_storage_type": "GCS",
"gcs_bucket": "your_gcs_bucket",
"gcs_folder": "your_gcs_folder"
}
}
Azure Blob Storage Current
{
"service": "braze",
"group_id": "target_group_id",
"config": {
"schema": "test_braze",
"api_url": "test_api_url",
"api_key": "test_api_key",
"historic_sync_time_frame": "THREE_MONTHS",
"cloud_storage_type": "AZURE_BLOB_STORAGE",
"abs_connection_string": "your_abs_connection_string",
"abs_container_name": "your_abs_container_name",
"abs_prefix": "your_abs_prefix"
}
}
User Export with Default Braze Public URL
{
"service": "braze",
"group_id": "target_group_id",
"config": {
"schema": "test_braze",
"api_url": "test_api_url",
"api_key": "test_api_key",
"cloud_storage_type": "NONE",
"enable_exports": true,
"export_storage_type": "NONE"
}
}
User Export with AWS S3
{
"service": "braze",
"group_id": "target_group_id",
"config": {
"schema": "test_braze",
"api_url": "test_api_url",
"api_key": "test_api_key",
"cloud_storage_type": "NONE",
"enable_exports": true,
"export_storage_type": "AWS_S3",
"s3_export_bucket": "your_s3_bucket",
"s3_export_role_arn": "arn:aws:iam::XXXXXXXXXXXX:role/your_test_bucket",
"s3_export_external_id": "_moonbeam",
"s3_export_folder": "your_s3_folder"
}
}
User Export with GCS
{
"service": "braze",
"group_id": "target_group_id",
"config": {
"schema": "test_braze",
"api_url": "test_api_url",
"api_key": "test_api_key",
"enable_exports": true,
"export_storage_type": "GCS",
"gcs_export_bucket": "your_gcs_bucket",
"gcs_export_folder": "your_gcs_folder"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
api_url | Your Braze API URL. | |
api_key | Your Braze API Key. | |
historic_sync_time_frame | Range of data in history you would like to include in the initial sync. | THREE_MONTHS, SIX_MONTHS, ONE_YEAR, TWO_YEARS, FIVE_YEARS, and ALL_TIME |
cloud_storage_type | Cloud storage type the Braze Current is connected to. Default Value: NONE. | AWS_S3, GCS, AZURE_BLOB_STORAGE, NONE |
s3external_id | This is same as your group_id, used for authentication along with the role_arn. 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. | |
s3bucket | Your S3 bucket. 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. | |
abs_connection_string | Your Azure Blob Storage connection string. Required if AZURE_BLOB_STORAGE is the cloud_storage_type. | |
abs_container_name | Your Azure Blob Storage bucket. Required if AZURE_BLOB_STORAGE is the cloud_storage_type. | |
abs_prefix | Your Azure Blob Storage bucket folder name. Required if AZURE_BLOB_STORAGE is the cloud_storage_type. | |
enable_exports | Enable User Profile Exports. Default Value: false. | true, false |
export_storage_type | Export storage type configured in Braze. Required if enable_exports is true. Default Value: NONE. | AWS_S3, GCS, NONE |
s3_export_external_id | This is same as your group_id, used for authentication along with the role_arn required if AWS_S3 is the export_storage_type. | |
s3_export_role_arn | The Role ARN required for authentication. Required if AWS_S3 is the export_storage_type. | |
s3_export_bucket | Your S3 bucket. Required if AWS_S3 is the export_storage_type. | |
s3_export_folder | Your S3 folder name. Required if AWS_S3 is the export_storage_type. | |
gcs_export_bucket | Your GCS bucket. Required if GCS is the export_storage_type. | |
gcs_export_folder | Your GCS folder name. Required if GCS is the export_storage_type. |
NOTE: If
GCScloud storage type is being used, then you wmust grant Fivetran access to your Google Cloud Storage bucket.
Authorization
There are three ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_url,api_key,enable_exportsand the following optional fields depending on thecloud_storage_typevalue:- for
AWS_S3:s3bucket,s3role_arn,s3external_idands3folder - for
GCS:gcs_bucketandgcs_folder - for
AZURE_BLOB_STORAGE:abs_connection_string,abs_container_nameandabs_prefix
- for
- If the
enable_exportsfield is set totrue, by specifying the values for theexport_storage_typefield and the following optional fields depending on theexport_storage_typevalue:- for
AWS_S3:s3_export_bucket,s3_export_role_arn,s3_export_external_idands3_export_folder - for
GCS:gcs_export_bucketandgcs_export_folder
- for
- By using the Connect Card or the Fivetran dashboard.
Brevo Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Brevo API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Brex Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Brex API token |
base_url | Your Brex Base URL |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_tokenandbase_url. - By using the Connect Card or the Fivetran dashboard.
Brightcove Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "brightcove",
"group_id": "target_group_id",
"config": {
"schema": "brightcove_schema_name",
"account_id": "your_brightcove_account_id",
"client_id": "your_brightcove_client_id",
"client_secret": "your_brightcove_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
account_id | Your Brightcove account ID. |
client_id | Your Brightcove client ID. |
client_secret | Your Brightcove client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
account_id,client_id, andclient_secret. - By using the Connect Card or the Fivetran dashboard.
Brightpearl Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "brightpearl",
"group_id": "target_group_id",
"config": {
"schema": "brightpearl_schema_name",
"client_id": "your_brightpearl_client_id",
"client_secret" : "your_brightpearl_client_secret",
"developer_reference": "your_brightpearl_developer_reference",
"app_reference": "your_brightpearl_app_reference",
"data_center": "your_brightpearl_data_center",
"organization_name": "your_brightpearl_organization_name"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
client_id | Your Brightpearl client ID. | |
client_secret | Your Brightpearl client secret. | |
developer_reference | Your Brightpearl dev reference. | |
app_reference | Your Brightpearl app reference. | |
data_center | Your Brightpearl data center. | EU, US |
organization_name | Your Brightpearl organization name. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,developer_reference,app_reference,data_center, andorganization_name. - By using the Connect Card or the Fivetran dashboard.
Buildium Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "buildium",
"group_id": "target_group_id",
"config": {
"schema": "buildium_schema_name",
"environment": "your_buildium_environment",
"client_id": "your_buildium_client_id",
"secret": "your_buildium_secret"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
environment | Your Buildium environment. | production and sandbox |
client_id | Your Buildium API client ID. | |
secret | Your Buildium API secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
environment,client_id, andsecret. - By using the Connect Card or the Fivetran dashboard.
Buildkite Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "buildkite",
"group_id": "target_group_id",
"config": {
"schema": "buildkite_schema_name",
"api_token": "your_buildkite_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Buildkite API token. |
Authorization
- By specifying the value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Buzzsprout Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Buzzsprout API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Calabrio Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
domain_name | Your Calabrio domain name. |
access_token | Your Calabrio access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
domain_nameandaccess_token. - By using the Connect Card or the Fivetran dashboard.
Calendly Lite
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
authsection:client_access,refresh_tokenandaccess_tokenPOST 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" } }Auth parameters
Name Description client_idYour Calendly Client ID. client_secretYour Calendly Client Secret. refresh_tokenYour Calendly refresh token. access_tokenYour Calendly access token. By using the Connect Card or the Fivetran dashboard.
CallRail Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "callrail",
"group_id": "target_group_id",
"config": {
"schema": "callrail_schema_name",
"api_key": "your_callrail_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your CallRail API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Campaign Monitor Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "campaignmonitor",
"group_id": "target_group_id",
"config": {
"schema": "campaignmonitor_schema_name",
"api_key": "your_campaignmonitor_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Campaign Monitor API key. |
Authorization
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Canny Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Canny API key. |
Authorization
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Canvas by Instructure Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "canvas_by_instructure",
"group_id": "target_group_id",
"config": {
"schema": "canvas_by_instructure_schema_name",
"client_id": "your_canvas_by_instructure_client_id",
"client_secret": "your_canvas_by_instructure_client_secret",
"sub_domain": "your_canvas_by_instructure_account_domain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id | Your Canvas by Instructure client ID. |
client_secret | Your Canvas by Instructure client secret. |
sub_domain | Your Canvas by Instructure account domain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secretandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Care Quality Commission Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "care_quality_commission",
"group_id": "target_group_id",
"config": {
"schema": "care_quality_commission_schema_name",
"primary_key": "your_care_quality_commission_primary_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
primary_key | Your Care Quality Commission primary key. |
Authorization
- By specifying a value for the
primary_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Castor EDC Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
server | Your Castor EDC server. |
client_id | Your Castor EDC client ID. |
client_secret | Your Castor EDC client secret. |
Authorization
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.
Centra Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "centra",
"group_id": "target_group_id",
"config": {
"schema": "centra_schema_name",
"base_url": "centra_base_url",
"api_token": "centra_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your Centra base URL. |
api_token | Your Centra API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
base_urlandapi_token. - By using the Connect Card or through the Fivetran dashboard.
Ceridian Dayforce Lite Private Preview
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
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.
Chameleon Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "chameleon",
"group_id": "target_group_id",
"config": {
"schema": "chameleon_schema_name",
"api_token": "your_chameleon_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Chameleon API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_token. - By using the Connect Card or the Fivetran dashboard.
Chargebee Product Catalog 1.0 Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Chargebee Product Catalog 1 subdomain. |
api_key | Your Chargebee Product Catalog 1 API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
sub_domainandapi_key. - By using the Connect Card or the Fivetran dashboard.
Chargebee Product Catalog 2.0 Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Chargebee subdomain. |
api_key | Your Chargebee API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
sub_domainandapi_key. - By using the Connect Card or the Fivetran dashboard.
ChargeDesk Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
token_id | Your ChargeDesk token ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
token_idfield in the request. - By using the Connect Card or the Fivetran dashboard.
ChartMogul Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "chartmogul",
"group_id": "target_group_id",
"config": {
"schema": "chartmogul_schema_name",
"api_key": "your_chartmogul_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your ChartMogul API key. |
Authorization
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Checkout.com Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
environment,access_key_id,access_key_secretandentity_id. - By using the Connect Card or the Fivetran dashboard.
Checkr Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "checkr",
"group_id": "target_group_id",
"config": {
"schema": "checkr_schema_name",
"sub_domain": "your_checkr_sub_domain",
"secret_key": "your_checkr_secret_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Checkr subdomain. |
secret_key | Your Checkr secret key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domainandsecret_key. - By using the Connect Card or the Fivetran dashboard.
Chorus Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "chorusai",
"group_id": "target_group_id",
"config": {
"schema": "chorus_schema_name",
"api_key": "your_chorus_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Chorus API key. |
Authorization
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Churnkey Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Churnkey API Key. |
app_id | Your Churnkey APP ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_keyandapp_id. - By using the Connect Card or the Fivetran dashboard.
ChurnZero Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your ChurnZero subdomain. |
username | Your ChurnZero username. |
api_key | Your ChurnZero API key. |
Authorization
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
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Cimis API key. |
Authorization
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
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Cin7 API Username. |
password | Your Cin7 API Key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Cin7 Core Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "cin7core",
"group_id": "target_group_id",
"config": {
"schema": "cin7core_schema_name",
"account_id": "your_cin7core_account_id",
"application_key": "your_cin7core_application_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
account_id | Your Cin7 Core account ID. |
application_key | Your Cin7 Core application key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
account_idandapplication_key. - By using the Connect Card or the Fivetran dashboard.
CircleCI Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "circleci",
"group_id": "target_group_id",
"config": {
"schema": "circleci_schema_name",
"personal_api_token": "your_circleci_personal_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
personal_api_token | Your CircleCI Personal API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
personal_api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
CJ Commission Detail Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "cj_commission_detail",
"group_id": "target_group_id",
"config": {
"schema": "cj_commission_detail_schema_name",
"personal_access_token": "your_cj_commission_detail_personal_access_token",
"company_ids": "your_cj_commission_detail_company_ids"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
personal_access_token | Your CJ Commission Detail personal access token. |
company_ids | Your CJ Commission Detail company IDs. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
personal_access_tokenandcompany_ids. - By using the Connect Card or the Fivetran dashboard.
Clari Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
forecast_id | Your Clari forecast ID. |
api_token | Your Clari API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_tokenandforecast_id. - By using the Connect Card or the Fivetran dashboard.
Clazar Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "clazar",
"group_id": "target_group_id",
"config": {
"schema": "clazar_schema_name",
"client_id": "your_clazar_client_id",
"client_secret": "your_clazar_client_secret"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
client_id | Your Clazar client ID. | |
client_secret | Your Clazar client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
ClickUp Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your ClickUp API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Clockify Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "clockify",
"group_id": "target_group_id",
"config": {
"schema": "clockify_schema_name",
"server_region": "your_clockify_server_region",
"api_key": "your_clockify_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
server_region | Your Clockify server region. |
api_key | Your Clockify API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
server_regionandapi_key. - By using the Connect Card or the Fivetran dashboard.
Clockodo Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "clockodo",
"group_id": "target_group_id",
"config": {
"schema": "clockodo_schema_name",
"api_key": "your_clockodo_api_key",
"client_identification": "your_clockodo_client_identification",
"email_address": "your_clockodo_email_address"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Clockodo API key. |
client_identification | Your Clockodo client identification. |
email_address | Your Clockodo email address. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key,client_identification, andemail_address. - By using the Connect Card or the Fivetran dashboard.
Close Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "close",
"group_id": "target_group_id",
"config": {
"schema": "close_schema_name",
"api_key": "your_close_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Close API key. |
Authorization
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Cloudbeds Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "cloudbeds",
"group_id": "target_group_id",
"config": {
"schema": "cloudbeds_schema_name",
"client_id": "your_cloudbeds_client_id",
"client_secret": "your_cloudbeds_client_secret",
"property_id": "your_cloudbeds_property_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Cloudbeds client id. |
client_secret | Your Cloudbeds client secret. |
property_id | Your Cloudbeds Property IDs. |
Authorization
- By specifying the values for the following fields in the request:
client_id,client_secret, andproperty_id. - By using the Connect Card or the Fivetran dashboard.
CloudFront
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
external_id,role_arn,bucketandprefix. - By using the Connect Card or the Fivetran dashboard.
Clubspeed Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "clubspeed",
"group_id": "target_group_id",
"config": {
"schema": "clubspeed_schema_name",
"sub_domain": "your_clubspeed_sub_domain",
"api_key": "your_clubspeed_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Clubspeed subdomain. |
api_key | Your Clubspeed private API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domainandapi_key. - By using the Connect Card or the Fivetran dashboard.
CockroachDB Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "cockroachdb",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_cockroachdb",
"host": "cockroachdb.mycompany.com",
"port": 26257,
"database": "cockroach",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"always_encrypted": true
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The user name. |
password | The user's password. |
database | The database name. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
always_encrypted | Default value: true. Set to false if TLS is not required when using an SSH tunnel. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,user,passwordanddatabase. - By using the Connect Card or the Fivetran dashboard.
Codefresh Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Codefresh API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Collibra Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Collibra username. |
password | Your Collibra password. |
sub_domain | Your Collibra subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
user_name,passwordandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Column Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "column",
"group_id": "target_group_id",
"config": {
"schema": "column_schema_name",
"api_key": "your_column_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Column API key with : prefix. For example, :<YOUR_API_KEY>. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Compliance Checkpoint Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "compliance_checkpoint",
"group_id": "compliance_checkpoint_group_id",
"config": {
"schema": "compliance_checkpoint_schema_name",
"sub_domain": "your_compliance_checkpoint_sub_domain",
"password": "your_compliance_checkpoint_api_password",
"username": "your_compliance_checkpoint_api_username"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Compliance Checkpoint subdomain. |
username | Your Compliance Checkpoint account username. |
password | Your Compliance Checkpoint account password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,username, andpassword. - By using the Connect Card or the Fivetran dashboard.
commercetools
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "commercetools",
"group_id": "target_group_id",
"config": {
"schema": "commercetools_schema_name",
"host": "your_commercetools_host",
"client_id": "your_commercetools_client_id",
"client_secret": "your_commercetools_client_secret",
"project_key": "your_commercetools_project_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
host | Your commercetools host. |
client_id | Your commercetools client ID. |
client_secret | Your commercetools client secret. |
project_key | Your commercetools project key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,client_id,client_secretandproject_key. - By using the Connect Card or the Fivetran dashboard.
Coassemble Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Coassemble API key. |
user_id | Your Coassemble user ID. |
host_name | Your Coassemble hostname. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values of following fields in the request:
api_key,user_idandhost_name. - By using the Connect Card or the Fivetran dashboard.
Concord Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "concord",
"group_id": "target_group_id",
"config": {
"schema": "concord_schema_name",
"api_key": "your_concord_api_key",
"environment": "your_concord_environment"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Concord API key. |
environment | Your Concord environment. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandenvironment. - By using the Connect Card or the Fivetran dashboard.
Confluence Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "confluence",
"group_id": "target_group_id",
"config": {
"schema": "confluence_schema_name",
"username": "your_confluence_username",
"domain": "your_domain",
"api_token": "your_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Confluence username. |
domain | Your Confluence domain. |
api_token | Your Confluence API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,domain, andapi_token. - By using the Connect Card or the Fivetran dashboard.
Confluent Cloud
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
consumer_groupandservers. - By using the Connect Card or the Fivetran dashboard.
Constant Contact Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "constant_contact",
"group_id": "target_group_id",
"config": {
"schema": "constant_contact_schema_name",
"client_id": "your_constant_contact_client_id",
"client_secret": "your_constant_contact_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Constant Contact client ID. |
client_secret | Your Constant Contact client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Contrast Security Lite Private Preview
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,password,api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Convex Beta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "convex",
"group_id": "target_group_id",
"config": {
"schema": "convex_schema_name",
"url": "your_convex_deployment_url",
"key": "your_convex_deployments_deploy_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
url | Your Convex deployment's URL (for example, https://jaded-raven-991.convex.cloud). |
key | Your Convex deployment's deploy key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
urlandkey. - By using the Connect Card or the Fivetran dashboard.
Copper Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "copper",
"group_id": "target_group_id",
"config": {
"schema": "copper_schema_name",
"email": "your_copper_email_address",
"api_key": "your_copper_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
email | The email address that you use to log into your Copper account. |
api_key | Your Copper API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
emailandapi_key. - By using the Connect Card or the Fivetran dashboard.
Cornerstone Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "cornerstone",
"group_id": "target_group_id",
"config": {
"schema": "cornerstone_schema_name",
"base_url": "your_cornerstone_base_url",
"client_id": "your_cornerstone_client_id",
"client_secret": "your_cornerstone_client_secret",
"scopes": "your_cornerstone_scopes"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your Cornerstone base URL. |
client_id | Your Cornerstone client ID. |
client_secret | Your Cornerstone client secret. |
scopes | Your Cornerstone scopes. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for following fields in the request:
base_url,client_id,client_secretandscopes. - By using the Connect Card or the Fivetran dashboard.
Coupa
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
instanceandapi_key. - By using the Connect Card or the Fivetran dashboard.
Criteo
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Criteo Client ID. |
client_secret | Your Criteo client secret key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Criteo Retail Media Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "criteo_retail_media",
"group_id": "target_group_id",
"config": {
"schema": "criteo_retail_media_schema_name",
"client_id": "your_criteo_retail_media_client_id",
"client_secret": "your_criteo_retail_media_client_secret",
"version": "your_criteo_retail_media_version"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Criteo Retail Media client ID. |
client_secret | Your Criteo Retail Media client secret. |
version | Your Criteo Retail Media version. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret, andversion. - By using the Connect Card or the Fivetran dashboard.
Crossbeam Lite
Request
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"
}
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Crossbeam Client ID. |
client_secret | Your Crossbeam Client secret. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessparameter in theauthsection.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" } } }Auth parameters
Name Description client_access.client_idYour Crossbeam Client ID.client_access.client_secretYour Crossbeam Client Secret.By using the Connect Card or the Fivetran dashboard.
crowd.dev Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
bearer_token | Your crowd.dev auth token. |
tenant_id | Your crowd.dev tenant ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
bearer_tokenandtenant_id. - By using the Connect Card or the Fivetran dashboard.
Culture Amp Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "culture_amp",
"group_id": "target_group_id",
"config": {
"schema": "culture_amp_schema_name",
"base_url": "your_culture_amp_base_url",
"client_id": "your_culture_amp_client_id",
"client_secret": "your_culture_amp_client_secret",
"target_entity_id": "your_culture_amp_target_entity_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your Culture Amp base URL. |
client_id | Your Culture Amp client ID. |
client_secret | Your Culture Amp client secret. |
target_entity_id | Your Culture Amp target entity ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
base_url,client_id,client_secret, andtarget_entity_id. - By using the Connect Card or the Fivetran dashboard.
Customer.io
Request
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)"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
bearer_token | Your Customer.io App API Key. |
sub_domain | Your Customer.io subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
bearer_tokenandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Cvent Lite
Request
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",
"region": "your_cvent_account_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Cvent client ID. |
client_secret | Your Cvent client secret. |
region | The region in which your Cvent account is hosted. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secretandsub_domain. - By using the Connect Card or the Fivetran dashboard.
D2L Brightspace Lite Private Preview
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
target_host,client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Databricks Beta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "databricks_db",
"group_id": "target_group_id",
"config": {
"schema_prefix": "schema_prefix",
"catalog": "catalog_name",
"http_path": "/sql/1.0/warehouses/pathofsqlwarehouse",
"port": "443",
"host": "dbc12345.cloud.databricks.com",
"personal_access_token": "personalaccesstoken"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
catalog (Optional) | The name of the catalog you want to sync. |
http_path | The HTTP path of your SQL warehouse. |
port | The port of your SQL warehouse. |
host | The host URL for your Databricks account. |
personal_access_token | The personal access token you created for Fivetran. |
Authorization
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Datadog Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "datadog",
"group_id": "target_group_id",
"config": {
"schema": "datadog_schema_name",
"base_url": "your_datadog_base_url",
"custom_base_url": "your_datadog_base_url",
"application_key": "your_datadog_application_key",
"api_key": "your_datadog_ api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your Datadog base url. |
custom_base_url | Your Datadog custom base url. |
application_key | Your Datadog application key. |
api_key | Your Datadog API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
base_url,custom_base_url,application_key, andapi_key. - By using the Connect Card or the Fivetran dashboard.
dbt Cloud Lite
Request
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",
"custom_url": "your_dbt_cloud_custom_api_base_url"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
custom_url | Your dbt Cloud API base URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the following parameters:
sub_domain,api_key, andcustom_url. - By using the Connect Card or the Fivetran dashboard.
DCL Logistics Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your DCL Logistics API key. |
username | Your DCL Logistics username. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_keyandusername. - By using the Connect Card or the Fivetran dashboard.
Delighted
Request
POST https://api.fivetran.com/v1/connectors
{
"service" : "delighted",
"group_id" : "target_group_id",
"config" : {
"schema" : "test_delighted",
"api_key" : "******"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | API Key for your Delighted account |
Authorization
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.
Deposco Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "deposco",
"group_id": "target_group_id",
"config": {
"schema": "deposco_schema_name",
"environment": "your_deposco_account_environment",
"custom_base_url": "your_deposco_custom_base_url",
"username": "your_deposco_username",
"password": "your_deposco_password",
"tenant_code": "your_deposco_tenant_code",
"business_unit": "your_deposco_business_unit"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
environment | Your Deposco account environment. |
custom_base_url | Your Deposco custom base URL. |
username | Your Deposco username. |
password | Your Deposco password. |
tenant_code | Your Deposco tenant code. |
business_unit | Your Deposco business unit. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
environment,custom_base_url,username,password,tenant_code, andbusiness_unit. - By using the Connect Card or the Fivetran dashboard.
Deputy Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your Deputy access token. |
sub_domain | Your Deputy subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
access_tokenandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Destini Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_name | Your Destini client name. |
api_key | Your Destini API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_nameandapi_key. - By using the Connect Card or the Fivetran dashboard.
Dialpad Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "dialpad",
"group_id": "target_group_id",
"config": {
"schema": "dialpad_schema_name",
"environment": "your_dialpad_environment",
"client_id": "your_dialpad_client_id",
"client_secret": "your_dialpad_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
environment | Your Dialpad environment. |
client_id | Your Dialpad client ID. |
client_secret | Your Dialpad client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the following fields in the request:
environment,client_id, andclient_secret. - By using the Connect Card after creating the connector or the Fivetran dashboard.
Dixa Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Dixa API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Docebo Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Docebo subdomain. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessparameter in theauthsection.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" } }Auth parameters
Name Description client_access.client_idYour Docebo Client ID. client_access.client_secretYour Docebo Client Secret. refresh_tokenYour Docebo Refresh Token. access_tokenYour Docebo Access Token. By using the Connect Card or the Fivetran dashboard.
DocumentDB
Fivetran supports the following DocumentDB configuration:
To learn more, see the setup guide for your DocumentDB connector type.
Request
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"
}
}
Config parameters
| Name | Description | Notes |
|---|---|---|
schema_prefix | Connector schema prefix has to be unique within the 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 using an SSH tunnel (do not use a load balancer). | |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. | |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. | |
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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,userandpassword. - By using the Connect Card or the Fivetran dashboard.
Donus Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "donus",
"group_id": "target_group_id",
"config": {
"schema": "donus_schema_name",
"api_key": "your_donus_api_key"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
api_key | Your Donus API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the following parameters:
api_key. - By using the Connect Card or the Fivetran dashboard.
DoorLoop Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "doorloop",
"group_id": "target_group_id",
"config": {
"schema": "doorloop_schema_name",
"api_key": "your_doorloop_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your DoorLoop API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Drata Lite
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the following parameters:
api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Drift Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "drift",
"group_id": "target_group_id",
"config": {
"schema": "drift_schema_name",
"sub_domain": "your_drift_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Drift subdomain. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following parameter in the
authsection: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" } }Auth parameters
Name Description client_idYour Drift client ID. client_secretYour Drift client secret. refresh_tokenYour Drift refresh token. access_tokenYour Drift access token. By using the Connect Card or the Fivetran dashboard.
Drip Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Drip API Token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Dropbox
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 Request
POST https://api.fivetran.com/v1/connectors
{
"service": "dropbox",
"group_id": "target_group_id",
"config": {
"schema": "test_dropbox",
"folder": "folder_url"
}
}
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 parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
folder | Your Dropbox Folder URL. |
Merge Mode Request
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": ";"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema (required) | The connector schema name has to be unique within the 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. | csv, json, tsv, avro, jsonl, log, parquet, xml, spreadsheet, infer |
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 overwrites 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. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Dropbox client application.client_secretClient Secretof your Dropbox client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters 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
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Dropbox Sign API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
DSV Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "dropbox_sign",
"group_id": "dsv",
"config": {
"schema": "dsv_schema_name",
"service_authentication": "service_authentication",
"subscription_key": "subscription_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
service_authentication | A base64 encoded variant of your username:password string. Required for authentication. |
subscription_key | Your DSV subscription key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
service_authenticationandsubscription_keyfields in the request. - By using the Connect Card or the Fivetran dashboard.
Duoplane Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "duoplane",
"group_id": "target_group_id",
"config": {
"schema": "duoplane_schema_name",
"api_key": "your_duoplane_api_key",
"api_password": "your_duoplane_api_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Duoplane API key. |
api_password | Your Duoplane API password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
api_keyandapi_passwordfields in the request. - By using the Connect Card or the Fivetran dashboard.
EasyPost Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your EasyPost API Key. |
Authorization
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.
eBay Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ebay",
"group_id": "target_group_id",
"config": {
"schema": "ebay_schema_name",
"subdomain": "ebay_subdomain",
"scope": "ebay_scope",
"client_id": "ebay_client_id",
"client_secret": "ebay_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your eBay Environment. |
scope | Your eBay scopes. |
client_id | Your eBay app ID. |
client_secret | Your eBay cert ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for following fields in the request:
subdomain,scope,client_id, andclient_secret. - By using the Connect Card or the Fivetran dashboard.
e-conomic Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
agreement_grant_token | Your e-conomic AgreementGrantToken. |
app_secret_token | Your e-conomic AppSecretToken. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
agreement_grant_tokenandapp_secret_tokenfields in the request. - By using the Connect Card or the Fivetran dashboard.
Elasticsearch Beta
Fivetran supports a few different incarnations of Elasticsearch. Each type of connector has its own service value:
- Elastic Cloud -
"service": "elastic_cloud" - Self Hosted Elasticsearch -
"service": "es_self_hosted"
Check out our setup guide for your type of connector.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "elastic_cloud",
"group_id": "target_group_id",
"config": {
"schema": "test_elasticsearch",
"host": "elasticinstance.mycompany.com",
"port": 443,
"user": "user",
"password": "password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "tunnel_user",
"always_encrypted": true
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema prefix has to be unique within the destination. Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The user name. |
password | The user's password. |
api_key | The Elasticsearch API key. If omitted, then basic user and password authentication apply. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
always_encrypted | Default value: true. Set to false if TLS is not required when using an SSH tunnel. |
Authorization
There are three ways to authorize this connector type:
By specifying the values for the following fields in the request for basic authentication:
userandpassword.POST https://api.fivetran.com/v1/connectors{ "service": "elastic_cloud", "group_id": "target_group_id", "config": { "schema": "test_elasticsearch", "host": "elasticinstance.mycompany.com", "port": 443, "user": "user", "password": "password" } }By specifying a value for
api_keyfield in the request for API key authentication.POST https://api.fivetran.com/v1/connectors{ "service": "elastic_cloud", "group_id": "target_group_id", "config": { "schema": "test_elasticsearch", "host": "elasticinstance.mycompany.com", "port": 443, "api_key": "your_elasticsearch_api_key" } }By using the Connect Card or the Fivetran dashboard.
Electronic Tenant Solutions Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "electronic_tenant_solutions",
"group_id": "target_group_id",
"config": {
"schema": "electronic_tenant_solutions_schema_name",
"api_key": "your_electronic_tenant_solutions_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Electronic Tenant Solutions API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Eloqua
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "eloqua",
"group_id": "target_group_id",
"config": {
"schema": "test_eloqua",
"historical_sync_limit": "ALL_TIME"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
historical_sync_limit | The time range of historical data you want to include in the initial sync. Default value: ALL_TIME. | THREE_MONTHS, SIX_MONTHS, ONE_YEAR, TWO_YEARS, FIVE_YEARS, ALL_TIME |
Authorization
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
After configuring an Email connector, you'll send your emails to group_id.schema.table_name@email-connector.fivetran.com
Request
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": ";"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | csv, json, tsv, avro, jsonl, log, parquet, xml, infer |
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 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. |
Authorization
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
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "employment_hero",
"group_id": "target_group_id",
"config": {
"schema": "employment_hero_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
authsection: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" } }Auth parameters
Name Description client_idYour Employment Hero client ID. client_secretYour Employment Hero client secret. refresh_tokenYour Employment Hero refresh token. access_tokenYour Employment Hero access token. By using the Connect Card or the Fivetran dashboard.
Eventbrite Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "eventbrite",
"group_id": "target_group_id",
"config": {
"schema": "eventbrite_schema_name",
"private_token": "your_eventbrite_private_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
private_token | Your Eventbrite private token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
private_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Eventsforce Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "eventsforce",
"group_id": "target_group_id",
"config": {
"schema": "eventsforce_schema_name",
"api_key": "your_eventsforce_api_key",
"account_name": "your_eventsforce_account_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Eventsforce API key. |
account_name | Your Eventsforce account name. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandaccount_name. - By using the Connect Card or the Fivetran dashboard.
Everflow Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "everflow",
"group_id": "target_group_id",
"config": {
"schema": "everflow_schema_name",
"api_key": "your_everflow_api_key",
"region": "your_everflow_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Everflow API key. |
region | Your Everflow region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandregion. - By using the Connect Card or the Fivetran dashboard.
Everhour Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Everhour API Token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Exact Online Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "exact_online",
"group_id": "target_group_id",
"config": {
"schema": "exact_online_schema_name",
"region": "your_exact_online_region",
"client_id": "your_exact_online_client_id",
"client_secret": "your_exact_online_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
region | Your Exact Online region. |
client_id | The client ID of the production app registered in Exact Online. |
client_secret | The client secret of the production app registered in Exact Online. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
region,client_id, andclient_secret. - By using the Connect Card or the Fivetran dashboard.
ExpenseIn Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "expensein",
"group_id": "target_group_id",
"config": {
"schema": "expensein_schema_name",
"api_key": "your_expensein_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your ExpenseIn API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Expensify Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
partner_user_id | Your Expensify Partner User ID. |
partner_user_secret | Your Expensify Partner User Secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request
partner_user_idandpartner_user_secret - By using the Connect Card or the Fivetran dashboard.
EZOfficeInventory Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
secret_key | Your EZOfficeInventory API secret key. |
sub_domain | Your EZOfficeInventory subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
secret_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Facebook Ads
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.
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | |
engaged_view_attribution_window | Time period to attribute conversions based on engaged 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 |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandaccess_tokenin theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Facebook client application.client_secretClient Secretof your Facebook client application.access_tokenThe long-lived Access tokenalong with theclient_idandclient_secretparameters carry the information necessary to query the Facebook Ads APIBy using the Connect Card or through the Fivetran dashboard.
Facebook Pages
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.
Request
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"]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandaccess_tokenin theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Facebook client application.client_secretClient Secretof your Facebook client application.access_tokenThe Access Tokencarries the information necessary for API resources to fetch dataBy using the Connect Card or through the Fivetran dashboard.
Factbird Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "factbird",
"group_id": "target_group_id",
"config": {
"schema": "factbird",
"api_token": "your_factbird_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Factbird API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Factorial Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "factorial",
"group_id": "target_group_id",
"config": {
"schema": "factorial_schema_name",
"api_key": "your_factorial_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Factorial API key. |
Authorization
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.
Fillout Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "fillout",
"group_id": "target_group_id",
"config": {
"schema": "fillout_schema_name",
"base_url": "your_fillout_base_url",
"client_id": "your_fillout_client_id",
"client_secret": "your_fillout_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your Fillout Base URL. |
client_id | Your Fillout client ID. |
client_secret | Your Fillout client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the following fields in the request:
base_url,client_id, andclient_secret. - By using the Connect Card after creating the connector or the Fivetran dashboard.
Firebase Beta
Before creating a Firebase connection, you must first follow our setup guide.
Request
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": "[]"
}
}
Config parameters
| Name | Description | Notes |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
service_account_key | The contents of your service account key file. Required for authentication. | |
packing_mode | (Optional) Whether to sync all tables in packed mode, unpacked mode or specific tables in packed mode. Default value: UsePackedModeOnly. | Possible values: UsePackedModeOnly, UseUnpackedModeOnly, SelectTablesForPackedMode. |
packed_mode_tables | Specific tables to sync. Must be populated if packing_mode is set to SelectTablesForPackedMode. | Table names are case-sensitive. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
service_account_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
FireHydrant Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "firehydrant",
"group_id": "target_group_id",
"config": {
"schema": "firehydrant_schema_name",
"api_key": "your_firehydrant_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your FireHydrant API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyin the request. - By using the Connect Card or the Fivetran dashboard.
Fivetran Platform Connector
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "fivetran_log",
"group_id": "target_group_id",
"config": {
"schema": "fivetran_log_schema",
"is_account_level_connector": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
is_account_level_connector | (Optional) Retrieve account-level logs. | true, false |
Authorization
To authorize this connector, we reuse the access rights that you use to access the API.
Flexport Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "flexport",
"group_id": "target_group_id",
"config": {
"schema": "flexport"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessparameter in theauthsection.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" } }Auth parameters
Name Description client_access.client_idYour Flexport Client ID. client_access.client_secretYour Flexport Client Secret. By using the Connect Card or the Fivetran dashboard.
Flywheel Digital Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "flywheel_digital",
"group_id": "target_group_id",
"config": {
"schema": "flywheel_digital_schema_name",
"api_access_token": "your_flywheel_api_access_token",
"instance": "your_flywheel_instance"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_access_token | Your Flywheel Digital API access token. |
instance | Your Flywheel Digital Instance. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_access_tokenandinstance. - By using the Connect Card or the Fivetran dashboard.
Fone Dynamics Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
account_sid | Your Fone Dynamics account SID. |
api_token | Your Fone Dynamics API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
account_sidandapi_token. - By using the Connect Card or the Fivetran dashboard.
Forj Community Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Forj Community API application key. |
api_secret | Your Forj Community secret key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandapi_secret. - By using the Connect Card or the Fivetran dashboard.
Float Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Float API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Formstack Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "formstack",
"group_id": "target_group_id",
"config": {
"schema": "formstack_schema_name",
"client_id": "your_formstack_client_id",
"client_secret": "your_formstack_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Formstack client ID. |
client_secret | Your Formstack client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Fountain Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "fountain",
"group_id": "target_group_id",
"config": {
"schema": "fountain_schema_name",
"sub_domain": "your_fountain_subdomain",
"url_format": "your_fountain_url_format",
"api_token": "your_fountain_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Fountain subdomain. |
url_format | Your Fountain URL format. Available options: "v2" or "api/v2". |
api_token | Your Fountain API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,url_format, andapi_token. - By using the Connect Card or the Fivetran dashboard.
Freightview Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "freightview",
"group_id": "target_group_id",
"config": {
"schema": "freightview_schema_name",
"account_type": "your_freightview_account_type",
"api_token": "your_freightview_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
account_type | Your Freightview Account Type. |
api_key | Your Freightview API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
account_typeandapi_key. - By using the Connect Card or the Fivetran dashboard.
FourKites Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "fourkites",
"group_id": "target_group_id",
"config": {
"schema": "fourkites_schema_name",
"api_key": "your_fourkites_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your FourKites API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
FreshBooks Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "freshbooks",
"group_id": "target_group_id",
"config": {
"schema": "freshbooks_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
authsection: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" } }Auth parameters
Name Description client_idYour FreshBooks client ID. client_secretYour FreshBooks client secret. refresh_tokenYour FreshBooks refresh token. access_tokenYour FreshBooks access token. By using the Connect Card or the Fivetran dashboard.
Freshchat Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Freshchat subdomain. |
bearer_token | Your Freshchat API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domainandapi_token. - By using the Connect Card or the Fivetran dashboard.
Freshdesk
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your company's freshdesk subdomain (usually company.freshdesk.com). |
api_key | Your Freshdesk API Key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
subdomainandapi_key. - By using the Connect Card or the Fivetran dashboard.
Freshdesk Contact Center
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "freshdesk_contact_center",
"group_id": "target_group_id",
"config": {
"schema": "freshdesk_contact_center",
"account_name": "your_account_name",
"api_key": "your_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
account_name | Your Freshdesk Contact Center account name. |
api_key | Your Freshdesk Contact Center API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
account_nameandapi_key. - By using the Connect Card or the Fivetran dashboard.
Freshsales Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "freshsales",
"group_id": "target_group_id",
"config": {
"schema": "freshsales",
"base_url": "your_freshsales_product",
"subdomain": "your_freshsales_domain",
"api_key": "your_freshsales_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your Freshsales product. |
subdomain | Your Freshsales domain. |
api_key | Your Freshsales API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
base_url,subdomain, andapi_key. - By using the Connect Card or the Fivetran dashboard.
Freshservice
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your company's freshservice subdomain (usually company.freshservice.com). |
api_key | Your Freshservice API Key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
subdomainandapi_key. - By using the Connect Card or the Fivetran dashboard.
Freshsuccess Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "freshsuccess",
"group_id": "target_group_id",
"config": {
"schema": "freshsuccess",
"api": "api",
"api_key": "your_freshsuccess_api_key",
"subdomain": "your_freshsuccess_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api | Set this parameter to api. |
api_key | Your Freshsuccess API key. |
subdomain | Your Freshsuccess subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api,api_key, andsubdomain. - By using the Connect Card or the Fivetran dashboard.
Freshteam Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
domain_name | Your company's Freshteam base domain name (usually company.freshteam.com). |
api_key | Your Freshteam API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
domain_nameandapi_key. - By using the Connect Card or the Fivetran dashboard.
Friendbuy Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Friendbuy API key. |
api_secret | Your Friendbuy API secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandapi_secret. - By using the Connect Card or the Fivetran dashboard.
Front
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "front",
"group_id": "target_group_id",
"config": {
"schema": "front"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Front client application.client_secretClient Secretof your Front client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters 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
Request
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": "",
"use_pgp_encryption_options": "false",
"pgp_secret_key": "<secret-key-used>",
"pgp_pass_phrase": "<pass-phrase-used>",
"signer_public_key": "<signer-public-key-used>"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | csv, json, tsv, avro, jsonl, log, parquet, xml, infer |
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 overwrites 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. | |
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. | |
use_pgp_encryption_options | Set to true if files are encrypted using PGP in the FTP server. 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 and if passphrase is used to create pgp_secret_key. | |
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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
user,password,hostandport. - By using the Connect Card or the Fivetran dashboard.
FullStory Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "fullstory",
"group_id": "target_group_id",
"config": {
"schema": "fullstory",
"api_key": "your_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your FullStory API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
G2 Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "g2",
"group_id": "target_group_id",
"config": {
"schema": "g2_schema_name",
"`api_token`": "your_g2_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your G2 API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Gainsight Customer Success
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | The subdomain of your Gainsight account. |
access_key | The access key for API authentication. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following fields in the request:
sub_domainandaccess_key.By using the Connect Card or through the Fivetran dashboard.
Gainsight Product Experience Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "gainsight_product_experience",
"group_id": "target_group_id",
"config": {
"schema": "gainsight_product_experience_schema_name",
"sub_domain": "your_gainsight_product_experience_subdomain",
"api_key": "your_gainsight_product_experience_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Gainsight Product Experience subdomain. |
api_key | Your Gainsight Product Experience API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domainandapi_key. - By using the Connect Card or through the Fivetran dashboard.
Gem Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Gem API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - After creating the connector, by using the Connect Card or the Fivetran dashboard.
Genesys Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "genesys",
"group_id": "target_group_id",
"config": {
"schema": "genesys_schema_name",
"client_id": "your_genesys_client_id",
"client_secret": "your_genesys_client_secret",
"sub_domain": "your_genesys_sub_domain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Genesys client ID. |
client_secret | Your Genesys client secret. |
sub_domain | Your Genesys subdomain. |
Authorization
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.
GetFeedback Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your GetFeedback access token. |
region | Your GetFeedback region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
access_tokenandregion. - After creating the connector, by using the Connect Card or the Fivetran dashboard.
GitHub
Request
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
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
By specifying personal access tokens (pats) and
"auth_mode": "PersonalAccessToken"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, "pats": ["ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], "auth_mode": "PersonalAccessToken" } }Auth parameters
Name Description patsThe Personal Access Tokensgenerated in Github.auth_modeAuthorization type. By using the Connect Card or through the Fivetran dashboard.
GitLab Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "gitlab",
"group_id": "target_group_id",
"config": {
"schema": "gitlab_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
authsection: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" } }Auth parameters
Name Description client_idYour GitLab client ID. client_secretYour GitLab client secret. refresh_tokenYour GitLab refresh token. access_tokenYour GitLab access token. By using the Connect Card or the Fivetran dashboard.
Gladly Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Gladly Username. |
api_token | Your Gladly API Token. |
organization | Your Gladly Organization Name. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandapi_token. - By using the Connect Card or the Fivetran dashboard.
GlobalMeet Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your GlobalMeet username. |
password | Your GlobalMeet password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Gmail Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "gmail",
"group_id": "target_group_id",
"config": {
"schema": "gmail_schema_name",
"user_id": "your_gmail_user_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
user_id | Your Gmail user ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
user_idfield in the request. - By using the Connect Card or the Fivetran dashboard.
GoCardless Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sandbox_account | Your GoCardless account type. |
access_token | Your GoCardless access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sandbox_accountandaccess_token. - By using the Connect Card or the Fivetran dashboard.
Gong
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the following fields in the request:
access_key,access_key_secretandbase_url. - By using the Connect Card or the Fivetran dashboard.
Google Ad Manager
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.
Request
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", "CUSTOM_DIMENSION"],
"dimension_attributes": ["LINE_ITEM_PRIORITY"],
"columns": ["TOTAL_LINE_ITEM_LEVEL_CLICKS"],
"custom_field_ids": [432432, 545345],
"custom_dimension_key_ids": [654755, 234543],
"ad_unit_view": "TOP_LEVEL",
"network_code": "0"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
custom_dimension_key_ids | Custom dimension IDs to include in the sync. Custom dimension can only be selected with the 'CUSTOM_DIMENSION' dimension. | See Ad Manager custom dimension key 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 |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.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", "CUSTOM_DIMENSION"], "dimension_attributes": ["LINE_ITEM_PRIORITY"], "columns": ["TOTAL_LINE_ITEM_LEVEL_CLICKS"], "custom_field_ids": [432432, 545345], "custom_dimension_key_ids": [654755, 234543], "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" } }Auth parameters
Name Description client_idClient IDof your Google Ad Manager client application.client_secretClient Secretof your Google Ad Manager client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Ads
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.
Request
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
}
}
Config parameters
| Name | Description | Supported Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. |
skip_empty_reports | Toggles the Skip empty reports feature. Enabled by default | false, true |
NOTE: The
segments.datefield is required for incremental syncs. Make sure thesegments.datefield is present for every table.
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Google Ads client application.client_secretClient Secretof your Google Ads client application.user_agentYour company's name in your Google Ads client application. refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters 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
Request
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",
"time_aggregation_granularity": "WEEKLY",
"rollback_window": 15
},
{
"table": "table_2",
"config_type": "PREBUILT",
"prebuilt_report": "USER_ACQUISITION_FIRST_USER_MEDIUM_REPORT"
}
]
}
}
Config parameters
| Name | Description | Supported Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | |
time_aggregation_granularity | The type of time aggregation. | DAILY, WEEKLY, MONTHLY, YEARLY |
rollback_window | The window size for a rollback sync. The default value is 30. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Google Analytics client application.client_secretClient Secretof your Google Analytics client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters 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
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
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 Configuration
To provide Fivetran access perform the following steps:
- Add the email address in the format
g-[group-id]@fivetran-production.iam.gserviceaccount.comas a new member, where[group_id]is the connector's group ID. - Assign the following roles:
BigQuery Data Viewerfor DatasetId,Storage Object Adminfor BucketName, andBigQuery Job Userfor Project.
Google Business Profile Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "google_business_profile",
"group_id": "target_group_id",
"config": {
"schema": "google_business_profile_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_access,refresh_token, andaccess_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "google_business_profile", "group_id": "target_group_id", "config": { "schema": "google_business_profile_schema_name" }, "auth": { "client_access": { "client_id": "google_business_profile_client_id", "client_secret": "google_business_profile_client_secret" }, "refresh_token": "google_business_profile_refresh_token", "access_token": "google_business_profile_access_token" } }Auth parameters
Name Description client_idClient IDof your Google Business Profile client application.client_secretClient Secretof your Google Business Profile client application.refresh_tokenThe long-lived Refresh tokenof your Google Business Profile client application.access_tokenThe Access Tokenthat carries the information necessary for API resources to fetch data.By using the Connect Card or the Fivetran dashboard.
Google Calendar Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "google_calendar",
"group_id": "target_group_id",
"config": {
"schema": "google_calendar_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
authsection: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" } }Auth parameters
Name Description client_idClient IDof your Google Calendar client application.client_secretClient IDof your Google Calendar client application.refresh_tokenThe long-lived Refresh tokenof your Google Calendar client application.access_tokenThe Access Tokenthat carries the information necessary for API resources to fetch data.By using the Connect Card or the Fivetran dashboard.
Google Campaign Manager 360
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.
Request
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"]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. A change of this value will trigger a re-sync for enabled reports during the next connector sync. 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. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Google Campaign Manager 360 client application.client_secretClient Secretof your Google Campaign Manager 360 client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Classroom Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "google_classroom",
"group_id": "target_group_id",
"config": {
"schema": "google_classroom_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
authsection:client_access,refresh_token, andaccess_token.POST https://api.fivetran.com/v1/connectors{ "service": "google_classroom", "group_id": "target_group_id", "config": { "schema": "google_classroom_schema_name" }, "auth": { "client_access": { "client_id": "google_classroom_client_id", "client_secret": "google_classroom_client_secret" }, "refresh_token": "google_classroom_refresh_token", "access_token": "google_classroom_access_token" } }Auth parameters
Name Description client_idClient IDof your Google Classroom client application.client_secretClient IDof your Google Classroom client application.refresh_tokenThe long-lived Refresh tokenof your Google Classroom client application.access_tokenThe Access Tokenthat carries the information necessary for API resources to fetch data.By using the Connect Card or the Fivetran dashboard.
Google Cloud Functions
Request
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"}
]
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
function_triggerandsecrets. - By using the Connect Card or the Fivetran dashboard.
Google Cloud Storage
Request
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",
"non_standard_escape_char": "false",
"escape_char_options": "CUSTOM_ESCAPE_CHAR",
"escape_char": "",
"delimiter": "",
"null_sequence": "",
"skip_before": "0",
"skip_after": "0",
"auth_type": "auth_type",
"secret_key": "secret_key",
"line_separator": ";",
"use_pgp_encryption_options": "false",
"pgp_secret_key": "<secret-key-used>",
"pgp_pass_phrase": "<pass-phrase-used>",
"signer_public_key": "<signer-public-key-used>"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. | csv, json, tsv, avro, jsonl, log, parquet, xml, infer |
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 overwrites 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. | |
non_standard_escape_char | Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false. | false, true |
escape_char_options | Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. Required for CSV parsing when non_standard_escape_char is true. Select the CUSTOM_ESCAPE_CHAR option if your file uses custom escape characters to escape quotation marks. Select the DELIMITED_ONLY option if your file doesn't use escape characters to escape quotation marks, and you want your file to be processed with delimiter only. | CUSTOM_ESCAPE_CHAR, DELIMITED_ONLY |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. Required for CSV parsing if escape_char_options is CUSTOM_ESCAPE_CHAR | |
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. | |
null_sequence | If your CSVs use a special value indicating null, you can specify it 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 |
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. | |
use_pgp_encryption_options | Set to true if files are encrypted using PGP in the GCS 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 and if passphrase is used to create pgp_secret_key. | |
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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
bucket,auth_typeandsecret_keyfields in the request. - By using the Connect Card or the Fivetran dashboard.
Google Display & Video 360
Request
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
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Google Display & Video 360 client application.client_secretClient Secretof your Google Display & Video 360 client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Drive
The connector supports two sync strategies:
Magic Folder Request
POST https://api.fivetran.com/v1/connectors
{
"service": "google_drive",
"group_id": "target_group_id",
"config": {
"schema": "test_google_drive",
"folder_id": "folder_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
folder_id | Your Google Drive Folder URL. |
Merge Mode Request
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": ";"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema (required) | The connector schema name has to be unique within the 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 file type. | csv, json, tsv, avro, jsonl, log, parquet, xml, spreadsheet, infer |
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 overwrites 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. |
Authorization
- The created connector can use authentication through 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
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "google_play",
"group_id": "target_group_id",
"config": {
"schema": "test_google_play",
"bucket": "bucket_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
bucket | The Google Cloud Storage source bucket. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Google Play client application.client_secretClient Secretof your Google Play client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters 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
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "google_search_ads_360",
"group_id": "target_group_id",
"config": {
"schema": "test_google_search_ads_360",
"accounts_sync_mode": "SPECIFIC_ACCOUNTS",
"accounts": ["222222", "333333"],
"reports": [
{
"table": "campaign_report",
"report_type": "campaign",
"attributes": [
"customer.id",
"campaign.id",
"campaign.name",
"campaign.status"
],
"metrics": [
"metrics.clicks",
"metrics.cost_micros",
"metrics.interaction_rate"
],
"segments": [
"segments.date",
"segments.device"
]
}
],
"timeframe_months": "SIX"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
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 Resources documentation for details. |
attributes | The report attributes included to sync. | See the list of attributes for each resource type in the Google Search Ads 360 Resources documentation. |
metrics | The report metrics included to sync. | See the list of metrics for each resource type in the Google Search Ads 360 Resources documentation. |
segments | The report segments included to sync. | See the list of segments for each resource type in the Google Search Ads 360 Resources 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 |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "google_search_ads_360", "group_id": "target_group_id", "config": { "schema": "test_google_search_ads_360", "accounts_sync_mode": "SPECIFIC_ACCOUNTS", "accounts": ["222222", "333333"], "reports": [ { "table": "campaign_report", "report_type": "campaign", "attributes": [ "customer.id", "campaign.id", "campaign.name", "campaign.status" ], "metrics": [ "metrics.clicks", "metrics.cost_micros", "metrics.interaction_rate" ], "segments": [ "segments.date", "segments.device" ] } ], "timeframe_months": "SIX" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Google Search Ads 360 client application.client_secretClient Secretof your Google Search Ads 360 client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters 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
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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 |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Google Search Console client application.client_secretClient Secretof your Google Search Console client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Google Sheets
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "google_sheets",
"group_id": "target_group_id",
"config": {
"schema": "google_sheets",
"table": "table"
}
}
Config parameters
| 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. |
Authorization
There are three ways to authorize this connector type:
By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.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" } }Config parameters
Name Description sheet_idThe 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_rangeThe name of the named data range on the sheet that contains the data to be synced. Auth parameters
Name Description client_idClient IDof your Google Sheets client application.client_secretClient Secretof your Google Sheets client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By specifying the values for the
sheet_idandnamed_rangeparameters 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" } }Config parameters
Name Description sheet_idThe 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_rangeThe name of the named data range on the sheet that contains the data to be synced. auth_typeThe ServiceAccountvalue 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.
Google Tasks Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "google_tasks",
"group_id": "target_group_id",
"config": {
"schema": "google_tasks_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_access,refresh_token, andaccess_tokenfields in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "google_tasks", "group_id": "target_group_id", "config": { "schema": "google_tasks_schema_name" }, "auth": { "client_access": { "client_id": "your_google_tasks_client_id", "client_secret": "your_google_tasks_client_secret" }, "refresh_token": "your_google_tasks_refresh_token", "access_token": "your_google_tasks_access_token" } }Auth parameters
Name Description client_idClient ID of your Google Tasks client application. client_secretClient secret of your Google Tasks client application. refresh_tokenThe long-lived refresh token of your Google Tasks client application. access_tokenThe access token that carries the information necessary for API resources to fetch your Google Tasks data. By using the Connect Card or the Fivetran dashboard.
Gorgias Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Gorgias username. |
subdomain | Your Gorgias subdomain. |
api_key | Your Gorgias API key. |
Authorization
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
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "greenhouse",
"group_id": "target_group_id",
"config": {
"schema": "greenhouse",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Greenhouse API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
GreenPowerMonitor Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your GreenPowerMonitor username. |
password | Your GreenPowerMonitor password. |
sub_domain | Your GreenPowerMonitor subdomain. |
Authorization
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 Preview
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Grepsr API Key. |
Authorization
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
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your GRIN API key. |
Authorization
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
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Guru username. |
password | Your Guru password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
user_nameandpassword. - By using the Connect Card or the Fivetran dashboard.
HappyFox Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "happyfox",
"group_id": "target_group_id",
"config": {
"schema": "happyfox_schema_name",
"region": "your_happyfox_region",
"api_key": "your_happyfox_api_key",
"auth_code": "your_happyfox_auth_code",
"account_name": "your_happyfox_account_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
region | Your HappyFox region. |
api_key | Your HappyFox API key. |
auth_code | Your HappyFox auth code. |
account_name | Your HappyFox account name. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
region,api_key,auth_codeandaccount_name. - By using the Connect Card or the Fivetran dashboard.
Harvest Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
account_id | Your Harvest Account ID. |
personal_access_token | Your Harvest Personal Access Token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
account_idandpersonal_access_token. - By using the Connect Card or the Fivetran dashboard.
Healthie Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "healthie",
"group_id": "target_group_id",
"config": {
"schema": "healthie_schema_name",
"environment": "your_healthie_environment",
"api_key": "your_healthie_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
environment | Your Healthie environment. |
api_key | Your Healthie API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
environmentandapi_key. - By using the Connect Card or the Fivetran dashboard.
Heap
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
bucket | The S3 bucket name. |
role_arn | The Role ARN required for authentication. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
bucketandrole_arn. - By using the Connect Card or the Fivetran dashboard.
Height
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "height",
"group_id": "target_group_id",
"config": {
"schema": "height",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Height API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Help Scout
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "helpscout",
"group_id": "target_group_id",
"config": {
"schema": "test_helpscout"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.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" } }Auth parameters
Name Description client_idClient IDof your Help Scout client application.client_secretClient Secretof your Help Scout client application.refresh_tokenThe long-lived refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Helpshift Lite
Request
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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Helpshift API key. |
domain_name | Your Helpshift domain name. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyanddomain_name. - By using the Connect Card or the Fivetran dashboard.
Heroku Kafka
Request
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"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
consumer_groupandservers. - By using the Connect Card or the Fivetran dashboard.
HiBob Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "hibob",
"group_id": "target_group_id",
"config": {
"schema": "hibob_schema_name",
"user_id": "your_hibob_service_user_id",
"user_token": "your_hibob_service_user_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
user_id | Your HiBob Service User ID. |
user_token | Your HiBob Service User Token. |
Authorization
There are two ways to authorize this connector type:
- By specifying values for the
username, andpasswordfields in the request. - By using the Connect Card or the Fivetran dashboard.
High-Volume Agent Db2 for i
Request
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",
"always_encrypted": true,
"agent_host": "host.com",
"agent_port": 4343,
"agent_user": "hvr",
"agent_password": "agent_password",
"agent_public_cert": "CERTIFICATE"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the 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 using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the
configsection 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
Request
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",
"update_method": "DIRECT_CAPTURE",
"direct_capture_method": "DIRECT",
"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"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the 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 using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
update_method | The method used to detect new or changed rows. Supported value: - DIRECT_CAPTURE - Fivetran uses log-based capture to extract your database's change data. |
direct_capture_method | The method used to read the log files. Supported values: - DIRECT - This is the default value. Fivetran reads both online and archived logs. - ASM - When using ASM on the source database. - ARCHIVE_ONLY - Fivetran reads only the archived logs. |
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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the
configsection 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 Oracle Beta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "oracle_sap_hva",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_sap_ecc_oracle",
"host": "host.com",
"port": 1521,
"user": "test_user",
"password": "test_password",
"database": "oracledb",
"pdb_name": "pdb_name",
"sap_user": "sap_test_user",
"uses_netweaver": false,
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"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"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the 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. |
sap_user | The Oracle schema name where the SAP tables reside. |
uses_netweaver | Default value: false. Set to true if you are using Netweaver to connect. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
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.- 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 | The 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the
configsection of the request:host,port,user,password,sap_user,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 Oracle With NetWeaver Beta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "oracle_sap_hva_netweaver",
"group_id": "target_group_id",
"config": {
"schema": "test_sap_ecc_oracle",
"host": "host.com",
"port": 1521,
"user": "test_user",
"password": "test_password",
"database": "oracledb",
"pdb_name": "pdb_name",
"sap_user": "sap_test_user",
"client_id": "800",
"instance_number": "00",
"rfc_library_path": "/opt/nwlibs",
"uses_netweaver": true,
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"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"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema prefix has to be unique within the 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. |
sap_user | The Oracle schema name where the SAP tables reside. |
client_id | Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. |
instance_number | Two-digit number (00-97) of the SAP instance within its host. |
rfc_library_path | Directory path containing the SAP NetWeaver RFC SDK library files. |
uses_netweaver | Default value: false. Set to true if you are using Netweaver to connect. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
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 | The 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. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the
configsection of the request:host,port,user,password,sap_user,agent_host,agent_port,agent_public_cert,agent_user, andagent_password. - By using the Connect Card or the Fivetran dashboard.
Hilti On!Track Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "hilti_ontrack",
"group_id": "target_group_id",
"config": {
"schema": "hilti_ontrack_schema_name",
"client_id": "your_hilti_ontrack_client_id",
"client_secret": "your_hilti_ontrack_client_secret",
"username": "your_hilti_ontrack_username",
"password": "your_hilti_ontrack_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Hilti On!Track client ID. |
client_secret | Your Hilti On!Track client secret. |
username | Your Hilti On!Track username. |
password | Your Hilti On!Track password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,username, andpassword. - By using the Connect Card or the Fivetran dashboard.
Hopin Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "hopin",
"group_id": "target_group_id",
"config": {
"schema": "hopin_schema_name",
"bearer_token": "your_hopin_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
bearer_token | Your Hopin API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
bearer_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
HubSpot
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "hubspot",
"group_id": "target_group_id",
"config": {
"schema": "test_hubspot"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "hubspot", "group_id": "target_group_id", "config": { "schema": "test_hubspot" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your HubSpot client application.client_secretClient Secretof your HubSpot client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or through the Fivetran dashboard.
iLevel Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ilevel",
"group_id": "target_group_id",
"config": {
"schema": "ilevel_schema_name",
"sub_domain": "your_ilevel_environment",
"client_id": "your_ilevel_client_id",
"client_secret": "your_ilevel_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
environment | Your iLevel environment. |
client_id | Your iLevel client ID. |
client_secret | Your iLevel client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Impact
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "impact",
"group_id": "target_group_id",
"config": {
"schema": "impact_schema_name",
"account_sid": "your_impact_account_sid",
"account_token": "your_impact_account_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
account_sid | Your Impact Account SID. |
account_token | Your Impact Account Token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
account_sidandaccount_token. - By using the Connect Card or the Fivetran dashboard.
incident.io Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "incidentio",
"group_id": "target_group_id",
"config": {
"schema": "incidentio_schema_name",
"api_key": "your_incidentio_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your incident.io API key. |
Authorization
There are two ways to authorize this connector type:
- When creating the connector, by specifying a value for the following field in the request:
api_key. - After creating the connector, by using the Connect Card or the Fivetran dashboard.
Infobip Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "infobip",
"group_id": "target_group_id",
"config": {
"schema": "infobip_schema_name",
"api_key": "your_infobip_api_key",
"sub_domain": "your_infobip_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Infobip API key. |
sub_domain | Your Infobip subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Insightly Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "insightly",
"group_id": "target_group_id",
"config": {
"schema": "insightly_schema_name",
"sub_domain": "your_insightly_subdomain",
"api_key": "your_insightly_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Insightly subdomain name. |
api_key | Your Insightly API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domainandapi_key. - By using the Connect Card or the Fivetran dashboard.
Instagram Business
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "instagram_business",
"group_id": "target_group_id",
"config": {
"schema": "instagram_business_test",
"sync_mode": "SpecificAccounts",
"accounts": ["123","456"],
"timeframe_months": "THREE"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sync_mode | Whether to sync all accounts or specific accounts. Default value: AllAccounts. | AllAccounts, SpecificAccounts |
accounts | Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. | |
timeframe_months | Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: SIX. | THREE, SIX, TWELVE, TWENTY_FOUR |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandaccess_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "instagram_business", "group_id": "target_group_id", "config": { "schema": "instagram_business_test", "sync_mode" : "SpecificAccounts", "accounts" : ["123","456"], "timeframe_months" : "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }Auth parameters
Name Description client_idClient IDof your Facebook client application.client_secretClient Secretof your Facebook client application.access_tokenThe Access Tokencarries the information necessary for API resources to fetch dataBy using the Connect Card or through the Fivetran dashboard.
Integral Ad Science Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "integral_ad_science",
"group_id": "target_group_id",
"config": {
"schema": "integral_ad_science_schema_name",
"username": "your_integral_ad_science_username",
"password": "your_integral_ad_science_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Integral Ad Science username. |
password | Your Integral Ad Science password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Integrate Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "integrate",
"group_id": "target_group_id",
"config": {
"schema": "integrate_schema_name",
"api_key": "your_integrate_api_key",
"organization_id": "your_integrate_organization_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Integrate API key. |
organization_id | Your Integrate organization ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandorganization_id. - By using the Connect Card or the Fivetran dashboard.
Intercom
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "intercom",
"group_id": "target_group_id",
"config": {
"schema": "test_intercom"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying a value for
access_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "intercom", "group_id": "target_group_id", "config": { "schema": "test_intercom" }, "auth": { "access_token": "my_access_token" } }Auth parameters
Name Description access_tokenThe long-lived Access Tokencarries the information necessary for API resources to fetch data.By using the Connect Card or through the Fivetran dashboard.
Invoiced Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "invoiced",
"group_id": "target_group_id",
"config": {
"schema": "invoiced_schema_name",
"environment": "your_invoiced_environment",
"api_key": "your_invoiced_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
environment | Your Invoiced environment. |
api_key | Your Invoiced API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
environmentandapi_key. - By using the Connect Card or the Fivetran dashboard.
Ironclad Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ironclad",
"group_id": "target_group_id",
"config": {
"schema": "ironclad_schema_name",
"base_url": "your_ironclad_base_url",
"client_id": "your_ironclad_client_id",
"client_secret": "your_ironclad_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your Ironclad base url. |
client_id | Your Ironclad client ID. |
client_secret | Your Ironclad client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
base_url,client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
ironSource Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ironsource",
"group_id": "target_group_id",
"config": {
"schema": "ironsource_schema_name",
"secret_key": "your_ironsource_secret_key",
"refresh_token": "your_ironsource_refresh_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
secret_key | Your ironSource secret key. |
refresh_token | Your ironSource refresh token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
secret_keyandrefresh_token. - By using the Connect Card or the Fivetran dashboard.
Iterable
NOTE: You will need to register the Fivetran-generated webhooks URL in your Iterable dashboard. See the Iterable setup guide for more details.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "iterable",
"group_id": "target_group_id",
"config": {
"schema": "iterable",
"api_key": "xxxxxxxxxxxxxxxx",
"sync_mode": "SelectedEvents",
"events": ["emailSend", "emailClick"],
"custom_event_sync_mode": "SelectedEvents",
"custom_events": ["customEvent"],
"account_region": "US",
"historic_sync_time_frame": "your_preferred_range"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
api_key | Your Iterable API key. | |
sync_mode | Sync all events or specific events. Default value: AllEvents. | AllEvents, SelectedEvents |
custom_event_sync_mode | Sync all custom events, specific custom events, or no custom events. Default value: AllEvents. | AllEvents, NoEvents, SelectedEvents |
events | Sync specific events. Must be populated if sync_mode is set to SelectedEvents. | customEvent, emailSend, emailSendSkip, emailOpen, emailClick, emailUnSubscribe, emailSubscribe, emailBounce, emailComplaint, hostedUnsubscribeClick, inAppSend, inAppOpen, inAppClick, inAppClose, inAppDelete, inAppDelivery, inAppSendSkip, inboxMessageImpression, inboxSession, pushSend, pushSendSkip, pushBounce, pushOpen, pushUninstall, purchase, smsClick, smsSend, smsSendSkip, smsBounce, smsReceived, webPushSend, webPushClick, webPushSendSkip |
custom_events | Specific custom events to sync. Must be populated if custom_event_sync_mode is set to SelectedEvents. | |
account_region | If your Iterable account URL starts with https://app.eu.iterable.com then provide EU else US | US, EU |
historic_sync_time_frame | Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. | THREE_MONTHS, SIX_MONTHS, ONE_YEAR, TWO_YEARS, FIVE_YEARS, ALL_TIME |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Ivanti Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ivanti",
"group_id": "target_group_id",
"config": {
"schema": "ivanti_schema_name",
"api_key": "your_ivanti_api_key",
"tenant_url": "your_ivanti_tenant_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Ivanti API key. |
tenant_url | Your Ivanti Tenant URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_keyandtenant_url. - By using the Connect Card or the Fivetran dashboard.
Jama Software Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "jama_software",
"group_id": "target_group_id",
"config": {
"schema": "jama_software_schema_name",
"client_id": "your_jama_software_client_id",
"client_secret": "your_jama_software_client_secret",
"subdomain": "your_jama_software_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Jama Software client ID. |
client_secret | Your Jama Software client secret. |
subdomain | Your Jama Software subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret, andsubdomain. - By using the Connect Card or the Fivetran dashboard.
Jamf Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "jamf",
"group_id": "target_group_id",
"config": {
"schema": "jamf_schema_name",
"sub_domain": "your_jamf_subdomain",
"password": "your_jamf_password",
"username": "your_jamf_username"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Jamf subdomain. |
password | Your Jamf password. |
username | Your Jamf username. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,password, andusername. - By using the Connect Card or the Fivetran dashboard.
Jibble Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "jibble",
"group_id": "target_group_id",
"config": {
"schema": "jibble_schema_name",
"client_id": "your_jibble_client_id",
"client_secret": "your_jibble_client_secret",
"environment": "your_jibble_environment"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Jibble client ID. |
client_secret | Your Jibble client secret. |
environment | Your Jibble environment. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret, andenvironment. - By using the Connect Card or the Fivetran dashboard.
Jira
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "jira",
"group_id": "target_group_id",
"config": {
"schema": "test_jira",
"host": "mycompany.atlassian.net",
"port": 443,
"user": "user",
"password": "password",
"path": "path",
"on_premise": false
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
host | The Jira service host address. | |
port | The Jira service host port. | |
user | The Jira username. | |
password | The Jira user's password. | |
path | A URL subdirectory where the Jira instance is working. | |
on_premise | Whether the Jira instance is local or in cloud. | true, false |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,userandpassword. - By using the Connect Card or the Fivetran dashboard.
Jira Align Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "atlassian_jira_align",
"group_id": "target_group_id",
"config": {
"schema": "jira_align_schema_name",
"api_key": "your_jira_align_api_key",
"sub_domain": "your_jira_align_base_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Jira Align API key. |
sub_domain | Your Jira Align base URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Jotform Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "jotform",
"group_id": "target_group_id",
"config": {
"schema": "jotform_schema_name",
"api_key": "your_jotform_api_key",
"base_url": "your_jotform_base_url",
"custom_url": "your_jotform_custom_base_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Jotform API key. |
base_url | Your Jotform base URL. |
custom_url | Your Jotform custom base URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key,base_urlandcustom_url. - By using the Connect Card or the Fivetran dashboard.
JobNimbus Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "jobnimbus",
"group_id": "target_group_id",
"config": {
"schema": "jobnimbus_schema_name",
"api_key": "your_jobnimbus_api_key
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your JobNimbus API key. |
Authorization
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
JustCall Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "justcall",
"group_id": "target_group_id",
"config": {
"schema": "justcall_schema_name",
"api_key": "your_justcall_api_key",
"api_secret": "your_justcall_api_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your JustCall API key. |
api_secret | Your JustCall API secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandapi_secret. - By using the Connect Card or the Fivetran dashboard.
Kandji Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "kandji",
"group_id": "target_group_id",
"config": {
"schema": "kandji_schema_name",
"api_token": "your_kandji_api_token",
"sub_domain": "your_kandji_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Kandji API token. |
sub_domain | Your Kandji subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_tokenandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Kantata
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mavenlink",
"group_id": "target_group_id",
"config": {
"schema": "mavenlink_schema"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Katana Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "katana",
"group_id": "target_group_id",
"config": {
"schema": "katana_schema_name",
"api_key": "your_katana_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Katana API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Kevel Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "kevel",
"group_id": "target_group_id",
"config": {
"schema": "kevel_schema_name",
"api_key": "your_kevel_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Kevel API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
KeyPay Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "keypay",
"group_id": "target_group_id",
"config": {
"schema": "keypay_schema_name",
"api_key": "your_keypay_api_key",
"region": "your_keypay_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your KeyPay API key. |
region | Your KeyPay region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandregion. - By using the Connect Card or the Fivetran dashboard.
Khoros CareLite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "khoros_care",
"group_id": "target_group_id",
"config": {
"schema": "khoros_care_schema_name",
"sub_domain": "your_khoros_care_subdomain",
"username": "your_khoros_care_username",
"password": "your_khoros_care_password",
"company_key": "your_khoros_care_company_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Khoros Care subdomain. |
username | Your Khoros Care username. |
password | Your Khoros Care password. |
company_key | Your Khoros Care company key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,username,password, andcompany_key. - By using the Connect Card or the Fivetran dashboard.
Khoros Communities Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "khoros_communities",
"group_id": "target_group_id",
"config": {
"schema": "khoros_communities_schema_name",
"token": "your_khoros_communities_token",
"community_domain": "your_khoros_communities_community_domain",
"client_id": "your_khoros_communities_client_id",
"community_id": "your_khoros_communities_community_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
community_domain | Your Khoros Communities community domain. |
client_id | Your Khoros Communities client ID. |
community_id | Your Khoros Communities community ID. |
token | Your Khoros Communities bulk API access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
community_domain,client_id,community_id, andtoken. - By using the Connect Card or the Fivetran dashboard.
Kisi Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "kisi",
"group_id": "target_group_id",
"config": {
"schema": "kisi_schema_name",
"api_key": "your_kisi_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Kisi API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Kissmetrics Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "kissmetrics",
"group_id": "target_group_id",
"config": {
"schema": "kissmetrics_schema_name",
"username": "your_kissmetrics_api_username",
"password": "your_kissmetrics_api_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Kissmetrics API Username. |
password | Your Kissmetrics API Password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Klarna Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "klarna",
"group_id": "target_group_id",
"config": {
"schema": "klarna_schema_name",
"username": "your_klarna_username",
"password": "your_klarna_password",
"subdomain": "your_klarna_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Klarna username. |
password | Your Klarna password. |
subdomain | Your Klarna subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,passwordandsubdomain. - By using the Connect Card or the Fivetran dashboard.
Klaviyo
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "klaviyo",
"group_id": "target_group_id",
"config": {
"schema": "klaviyo",
"api_key": "xxxxxxxxxxxxxxxx",
"packing_mode": "packing_mode_of_custom_fields",
"historic_sync_time_frame": "historical_sync_time_frame"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
api_key | Your Klaviyo API key. | |
packing_mode | The packing mode for the custom fields of the EVENT and PERSON tables. Default value: UNPACKED | UNPACKED, PACKED |
historic_sync_time_frame | Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. | THREE_MONTHS, SIX_MONTHS, ONE_YEAR, TWO_YEARS, FIVE_YEARS, ALL_TIME` |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Konnect Insights Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "konnect_insights",
"group_id": "target_group_id",
"config": {
"schema": "konnect_insights",
"account_token": "your_konnect_insights_account_token",
"user_token": "your_konnect_insights_user_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
account_token | Your Konnect Insights account token. |
user_token | Your Konnect Insights user token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
account_tokenanduser_tokenfields in the request. - By using the Connect Card or the Fivetran dashboard.
Kustomer
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "kustomer",
"group_id": "target_group_id",
"config": {
"schema": "kustomer",
"access_token": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your Kustomer API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
The following example will allow you to configure the Kustomer API usage limit of an existing connector.
Request
PATCH https://api.fivetran.com/v1/connectors/{connector_id}
{
"config": {
"api_utilization_percentage": 50.0
}
}
Lattice Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "lattice",
"group_id": "target_group_id",
"config": {
"schema": "lattice_schema_name",
"access_token": "your_lattice_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your Lattice API access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
LaunchDarkly Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "launchdarkly",
"group_id": "target_group_id",
"config": {
"schema": "launchdarkly_schema_name",
"access_token": "your_launchdarkly_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your LaunchDarkly access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Leap CRM Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "leap_crm",
"group_id": "target_group_id",
"config": {
"schema": "leap_crm_schema_name",
"access_token": "your_leap_crm_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your Leap CRM access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
LearnUpon Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "learnupon",
"group_id": "target_group_id",
"config": {
"schema": "learnupon_schema_name",
"username": "your_learnupon_username",
"api_key": "your_learnupon_api_key",
"subdomain": "your_learnupon_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your LearnUpon username. |
api_key | Your LearnUpon API key. |
base_url | Your LearnUpon Base URL. |
subdomain | Your LearnUpon subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
username,api_key, andbase_urlfields in the request. - By using the Connect Card or the Fivetran dashboard.
Lemlist Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "lemlist",
"group_id": "target_group_id",
"config": {
"schema": "lemlist_schema_name",
"api_key": "your_lemlist_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Lemlist API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Lessonly Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "lessonly",
"group_id": "target_group_id",
"config": {
"schema": "lessonly_schema_name",
"username": "your_lessonly_username",
"password": "your_lessonly_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Lessonly username. |
password | Your Lessonly password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Lever
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "lever",
"group_id": "target_group_id",
"config": {
"schema": "lever",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Lever API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Liftoff Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "liftoff",
"group_id": "target_group_id",
"config": {
"schema": "liftoff_schema_name",
"api_key": "your_liftoff_api_key",
"api_secret": "your_liftoff_api_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Liftoff API key. |
api_secret | Your Liftoff API secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for
api_keyandapi_secretfields in the request. - By using the Connect Card or the Fivetran dashboard.
Lightspeed Retail
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "light_speed_retail",
"group_id": "target_group_id",
"config": {
"schema": "light_speed_retail_schema"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
LINE Ads Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "line_ads",
"group_id": "target_group_id",
"config": {
"schema": "line_ads_schema_name",
"group_id": "your_line_ads_group_id",
"secret_key": "your_line_ads_secret_key",
"access_key": "your_line_ads_access_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
group_id | Your LINE Ads group id. |
secret_key | Your LINE Ads secret key. |
access_key | Your LINE Ads access key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
group_id,secret_keyandaccess_key. - By using the Connect Card or the Fivetran dashboard.
LinkedIn Ad Analytics
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "linkedin_ads",
"group_id": "target_group_id",
"config": {
"schema": "linkedin_ads",
"sync_mode": "SpecificAccounts",
"accounts": ["123","234","345"],
"ad_analytics": "SpecificReports",
"reports": ["abc","bcd","cde"],
"view_through_attribution_window_size": "DAY_1",
"post_click_attribution_window_size" : "DAY_30",
"timeframe_months": "THREE"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sync_mode | Whether to sync all accounts or specific accounts. Default value: AllAccounts | SpecificAccounts, AllAccounts |
accounts | Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. | |
ad_analytics | Whether to sync all reports or specific reports. Default value: AllReports | SpecificReports, AllReports |
reports | Specific Reports to sync. Must be populated if ad_analytics is set to SpecificReports. | |
view_through_attribution_window_size | The time period to attribute conversions based on views. Default value: DAY_7 | DAY_1, DAY_7, DAY_28, DAY_30 |
post_click_attribution_window_size | The time period to attribute conversions based on clicks. Default value: DAY_30 | DAY_1, DAY_7, DAY_28, DAY_30 |
timeframe_months | Number of months for which to query reporting data included in the initial sync. This number cannot be modified once the connector is created. Default value: ALL_TIME | THREE, SIX, TWELVE, TWENTY_FOUR, ALL_TIME |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "linkedin_ads", "group_id": "target_group_id", "config": { "schema": "linkedin_ads", "sync_mode": "SpecificAccounts", "accounts": ["123","234","345"], "ad_analytics": "SpecificReports", "reports": ["abc","bcd","cde"], "view_through_attribution_window_size": "DAY_1", "post_click_attribution_window_size" : "DAY_30", "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your LinkedIn client application.client_secretClient Secretof your LinkedIn client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or through the Fivetran dashboard.
Linear Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "linear",
"group_id": "target_group_id",
"config": {
"schema": "linear_schema_name",
"api_key": "your_linear_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Linear API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
LinkedIn Company Pages
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "linkedin_company_pages",
"group_id": "target_group_id",
"config": {
"schema": "linkedin_company_pages",
"social_data_sync_timeframe": "SIX"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
social_data_sync_timeframe | The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: SIX . | THREE, SIX, TWELVE |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "linkedin_company_pages", "group_id": "target_group_id", "config": { "schema": "linkedin_company_pages", "social_data_sync_timeframe": "SIX" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your LinkedIn client application.client_secretClient Secretof your LinkedIn client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or through the Fivetran dashboard.
LinkSquares Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "linksquares",
"group_id": "target_group_id",
"config": {
"schema": "linksquares_schema_name",
"api_key": "your_linksquares_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your LinkSquares API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
LiveChat Partner Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "livechat_partner",
"group_id": "target_group_id",
"config": {
"schema": "livechat_partner_schema_name",
"api_token": "your_livechat_partner_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Livechat Partner API Token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Lob Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "lob",
"group_id": "target_group_id",
"config": {
"schema": "lob_schema_name",
"api_key": "your_lob_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Lob API key. |
Authorization
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Looker Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "looker_source",
"group_id": "target_group_id",
"config": {
"schema": "your_looker_schema_name",
"sub_domain": "your_looker_sub_domain",
"client_id": "your_client_id",
"client_secret": "your_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Looker subdomain. |
client_id | Your Looker Client ID. |
client_secret | Your Looker Client secret. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following fields in the request:
sub_domain,client_idandclient_secret.By using the Connect Card or the Fivetran dashboard.
Loop Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "loop",
"group_id": "target_group_id",
"config": {
"schema": "loop_schema_name",
"api_key": "your_loop_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Loop API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Loopio Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "loopio",
"group_id": "target_group_id",
"config": {
"schema": "loopio_schema_name",
"app_key": "your_loopio_app_key",
"secret": "your_loopio_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
app_key | Your Loopio App Key. |
secret | Your Loopio Secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying values for the
app_keyandsecret. - By using the Connect Card or the Fivetran dashboard.
Lucca Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "lucca",
"group_id": "target_group_id",
"config": {
"schema": "lucca_schema_name",
"sub_domain": "your_lucca_sub_domain",
"environment": "your_lucca_environment",
"api_key": "your_lucca_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Lucca subdomain. |
environment | Your Lucca environment. |
api_key | Your Lucca API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,environment, andapi_key. - By using the Connect Card or the Fivetran dashboard.
Luma Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "luma",
"group_id": "target_group_id",
"config": {
"schema": "luma_schema_name",
"api_key": "your_luma_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Luma API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Mailchimp
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mailchimp",
"group_id": "target_group_id",
"config": {
"schema": "schema_name"
},
"ecommerce_stores": ["list_of_e_commerce_store_ids"]
}
Config parameters
| Name | Description | Notes |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
ecommerce_stores | IDs of E-Commerce stores whose data you want to sync. | This field is deprecated and will be removed on October 31, 2024. |
Authorization
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Mailgun Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mailgun",
"group_id": "target_group_id",
"config": {
"schema": "mailgun_schema_name",
"username": "your_mailgun_api_username",
"subdomain": "your_mailgun_subdomain",
"api_key": "your_mailgun_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Mailgun API username. |
subdomain | Your Mailgun subdomain. |
api_key | Your Mailgun API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,subdomain, andapi_key. - By using the Connect Card or the Fivetran dashboard.
Mailjet Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mailjet",
"group_id": "target_group_id",
"config": {
"schema": "mailjet_schema_name",
"secret_key": "your_mailjet_secret_key",
"api_key": "your_mailjet_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
secret_key | Your Mailjet secret key. |
api_key | Your Mailjet API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
secret_keyandapi_key. - By using the Connect Card or the Fivetran dashboard.
Malomo Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "malomo",
"group_id": "target_group_id",
"config": {
"schema": "malomo_schema_name",
"api_key": "your_malomo_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Malomo API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Mambu Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mambu",
"group_id": "target_group_id",
"config": {
"schema": "mambu_schema_name",
"tenant_name": "your_mambu_tenant_name",
"api_key": "your_mambu_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
tenant_name | Your Mambu tenant name. |
api_key | Your Mambu API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
tenant_nameandapi_key. - By using the Connect Card or the Fivetran dashboard.
Mandrill
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mandrill",
"group_id": "target_group_id",
"config": {
"schema": "mandrill",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Mandrill API key. |
Authorization
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.
MariaDB
Fivetran supports a few different incarnations of MariaDB. To configure MariaDB connectors, use the MySQL instructions, with the appropriate service name:
- Azure Database for MariaDB -
"service": "maria_azure" - Generic MariaDB -
"service": "maria" - RDS -
"service": "maria_rds"
Marin Software
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "marin",
"group_id": "target_group_id",
"config": {
"schema": "test_marin",
"host": "marin_host_address",
"user": "marin_user",
"password": "marin_password",
"prefix": ""
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
host | The Marin host address. |
user | The Marin username. |
password | The Marin user's password. |
prefix | Folder path to the Marin manifest file. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,userandpassword. - By using the Connect Card or the Fivetran dashboard.
Marketo
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "marketo",
"group_id": "target_group_id",
"config": {
"schema": "marketo",
"endpoint": "https://my.mktorest.com/rest",
"identity": "https://my.mktorest.com/identity",
"user_id": "MKTOWS_58-LBZ-000_Y",
"encryption_key": "your_encryption_key",
"soap_uri": "https://58-LBZ-000.mktoapi.com/soap/mktows/3_1",
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"client_secret": "your_api_secret",
"api_quota": 10000,
"historic_sync_time_frame": "your_preferred_range"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
endpoint | Marketo REST API endpoint. | |
identity | Marketo REST API identity URL. | |
user_id | Marketo SOAP API User ID. | |
encryption_key | Marketo SOAP API Encryption Key. | |
soap_uri | Marketo SOAP API Endpoint. | |
client_id | Marketo REST API Client ID. | |
client_secret | Marketo REST API Client Secret. | |
api_quota | Allowed number of API requests to Marketo instance per day, the default value is 10000. | |
historic_sync_time_frame | Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. | THREE_MONTHS, SIX_MONTHS, ONE_YEAR, TWO_YEARS, FIVE_YEARS, ALL_TIME |
Check out our Marketo setup guide to configure Marketo permissions and obtain the relevant account information, including ID and secret.
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
endpoint,identity,client_id,client_secretandapi_quota. - By using the Connect Card or the Fivetran dashboard.
Authorization
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Matomo Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "matomo",
"group_id": "target_group_id",
"config": {
"schema": "matomo_schema_name",
"token": "your_matomo_auth_token",
"sub_domain": "your_matomo_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
token | Your Matomo auth token. |
sub_domain | Your Matomo subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
tokenandsubdomainfields in the request. - By using the Connect Card or the Fivetran dashboard.
Maxio Chargify Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "maxio_chargify",
"group_id": "target_group_id",
"config": {
"schema": "maxio_chargify_schema_name",
"api_key": "enter_your_api_key",
"sub_domain": "enter_your_sub_domain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Maxio Chargify API key. |
sub_domain | Your Maxio Chargify subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Maxio SaaSOptics Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "maxio_saasoptics",
"group_id": "target_group_id",
"config": {
"schema": "maxio_saasoptics_schema_name",
"subdomain": "your_maxio_saasoptics_subdomain",
"account_name": "your_maxio_saasoptics_account_name",
"api_token": "your_maxio_saasoptics_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your Maxio SaaSOptics subdomain. |
account_name | Your Maxio SaaSOptics account name. |
api_token | Your Maxio SaaSOptics API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
subdomain,account_name, andapi_token. - By using the Connect Card or the Fivetran dashboard.
Medallia
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "medallia",
"group_id": "target_group_id",
"config": {
"schema": "medallia_analytics",
"subdomain": "subdomain",
"domain_type": "eu",
"client_name": "companyName"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | The Medallia subdomain. |
domain_type | The domain type of your Medallia URL (com, eu, ca, etc.). com by default. |
client_name | Your Medallia company name. |
Authorization
There are two ways to authorize this connector type:
By specifying values for the following fields in the
authsection:client_id,client_secret, andaccess_token.POST https://api.fivetran.com/v1/connectors{ "service": "medallia", "group_id": "target_group_id", "config": { "schema": "test_medallia", "subdomain": "subdomain", "domain_type": "eu", "client_name": "companyName" }, "auth": { "client_id": "my_client_id", "client_secret": "my_client_secret", "access_token": "my_access_token" } }Auth parameters
Name Description client_idYour Medallia client ID. client_secretYour Medallia client secret key. access_tokenYour Medallia access token that contains all the information necessary for the API resources to fetch your data. By using the Connect Card or through the Fivetran dashboard.
Medallia Agile Research Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "medallia_agile_research",
"group_id": "target_group_id",
"config": {
"schema": "medallia_agile_research_schema_name",
"region": "your_medallia_agile_research_region",
"x_master_key": "your_medallia_agile_research_master_key",
"x_key": "your_medallia_agile_research_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
region | Your Medallia Agile region. |
x_master_key | Your Medallia Agile Research master key. |
x_key | Your Medallia Agile Research key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
region,x_master_key, andx_key. - By using the Connect Card or the Fivetran dashboard.
Megaphone Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "megaphone",
"group_id": "target_group_id",
"config": {
"schema": "megaphone",
"organization_id": "your_megaphone_organization_id",
"api_token": "your_megaphone_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
organization_id | Your Megaphone organization ID. |
api_token | Your Megaphone API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying values for the
api_tokenandorganization_idfields in the request. - By using the Connect Card or the Fivetran dashboard.
Mention Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "Mention",
"group_id": "target_group_id",
"config": {
"schema": "mention_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following fields in the request:
client_idandclient_secret.POST https://api.fivetran.com/v1/connectors{ "service": "mention", "group_id": "target_group_id", "config": { "schema": "mention_schema_name" }, "auth": { "client_access": { "client_id": "your_mention_client_id", "client_secret": "your_mention_client_secret" } } }Auth parameters
Name Description client_access.client_idYour Mention Client ID. client_access.client_secretYour Mention Client Secret. By using the Connect Card or the Fivetran dashboard.
Microsoft Advertising
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "bingads",
"group_id": "target_group_id",
"config": {
"schema": "test_bingads",
"sync_mode": "SpecificAccounts",
"accounts": ["123","234","345"],
"timeframe_months": "THREE",
"rollback_window_size": 30
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sync_mode | Whether to sync all accounts or specific accounts. Default value: AllAccounts. | SpecificAccounts, AllAccounts |
accounts | Specific accounts to sync. Must be populated if syncMode is set to SpecificAccounts. | |
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: SIX. | THREE, SIX, TWELVE, TWENTY_FOUR, ALL_TIME |
rollback_window_size | The time frame of the rollback sync to capture conversions. Default value: 35. | 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90 or 95 days. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "bingads", "group_id": "target_group_id", "config": { "schema": "test_bingads", "sync_mode": "SpecificAccounts", "accounts": ["123","234","345"], "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Microsoft Advertising client application.client_secretClient Secretof your Microsoft Advertising client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or through the Fivetran dashboard.
Microsoft Dynamics 365 Business Central Beta
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "business_central",
"group_id": "target_group_id",
"config": {
"schema": "business_central",
"tenant_id": "your_business_central_tenant_id",
"companies": [
"list_of_company_ids"
],
"environment_name": "your_business_central_environment_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
tenant_id | Your Microsoft Dynamics 365 Business Central tenant ID. |
companies | IDs of the companies whose data you want to sync. |
environment_name | Your Microsoft Dynamics 365 Business Central environment name. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "business_central", "group_id": "target_group_id", "config": { "schema": "business_central", "tenant_id": "your_business_central_tenant_id", "companies": [ "list_of_company_ids" ], "environment_name": "your_business_central_environment_name" }, "auth": { "client_access": { "client_id": "your_business_central_client_id", "client_secret": "your_business_central_client_secret" }, "refresh_token": "your_refresh_token" } }Auth parameters
Name Description client_idYour Microsoft Dynamic 365 Business Central client ID. client_secretYour Microsoft Dynamic 365 Business Central client secret. refresh_tokenThe 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. By using the Connect Card or the Fivetran dashboard.
Microsoft Dynamics 365 CRM
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "dynamics_365",
"group_id": "target_group_id",
"config": {
"schema": "dynamics_365_schema",
"domain_name": "domain_name",
"resource_url": "resource_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
domain_name | The primary domain name of the Microsoft Entra ID tenant that subscribes to Dynamics 365. |
resource_url | The Dynamics 365 service root URL. |
NOTE: You can also retrieve connecting user details such as
connecting_userandconnecting_user_emailin the config section while retrieving connector details. These fields areread-only, and we cannot provide them in a POST request. We populate these fields only after the initial sync has completed.
Authorization
There are three ways to authorize this connector type:
By specifying
"auth_type": "OAUTH2", and the values for theclient_accessandrefresh_tokenparameters in theauthsection. Refer Authentication methods section in the setup guide for more info.POST https://api.fivetran.com/v1/connectors{ "service": "dynamics_365", "group_id": "target_group_id", "config": { "schema": "dynamics_365_schema", "domain_name": "domain_name", "resource_url": "resource_url" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "auth_type": "OAUTH2", "refresh_token": "my_refresh_token" } }Beta By specifying
"auth_type": "SERVICE_PRINCIPAL", and the values for theclient_accessparameter in theauthsection. Refer Authentication methods section in the setup guide for more info.POST https://api.fivetran.com/v1/connectors{ "service": "dynamics_365", "group_id": "target_group_id", "config": { "schema": "dynamics_365_schema", "domain_name": "domain_name", "resource_url": "resource_url" }, "auth": { "client_access": { "client_id": "service_principal_client_id", "client_secret": "service_principal_client_secret" }, "auth_type": "SERVICE_PRINCIPAL" } }Auth parameters
Name Description Possible values client_idClient ID of your Dynamic 365 client application, or Service Principal. client_secretClient secret value of your Dynamic 365 client application, or Service Principal. auth_typeAuthentication mechanism. Default value: OAUTH2OAUTH2,SERVICE_PRINCIPALrefresh_tokenThe long-lived refresh token along with the client_idandclient_secretparameters carry the information necessary to get a new access token for API resources. Required ifauth_typeisOAUTH2.By using the Connect Card or the Fivetran dashboard.
Microsoft Dynamics 365 Finance and Operations
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "microsoft_dynamics_365_fno",
"group_id": "target_group_id",
"config": {
"schema": "test_microsoft_dynamics_365_fno",
"container_name": "container_name",
"connection_string": "BlobEndpoint=https://abc123.blob.core.windows.net/;TableEndpoint=https://abc123.table.core.windows.net/;SharedAccessSignature=xxxxxxxxx"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
container_name | The name of the blob container. |
connection_string | The blob storage container connection string. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
container_nameandconnection_string. - By using the Connect Card or the Fivetran dashboard.
Microsoft Lists
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "microsoft_lists",
"group_id": "target_group_id",
"config": {
"schema": "test_list",
"site_id": "target_site_id",
"site_name" : "target_site_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema has to be unique within the destination. Required for connector creation. |
site_id | The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the id field in the Graph API response for sites. |
site_name | The Name of the SharePoint site. The Site Name is the name field in the Graph API response for sites. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "microsoft_lists", "group_id": "target_group_id", "config": { "schema": "test_list", "site_id": "target_site_id", "site_name" : "target_site_name" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Microsoft client application.client_secretClient Secretof your Microsoft client application.refresh_tokenThe long-lived Refresh token carries the information necessary to get a new access token for API resources. By using the Connect Card or the Fivetran dashboard.
Microsoft Entra ID Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "microsoft_entra_id",
"group_id": "target_group_id",
"config": {
"schema": "microsoft_entra_id_schema_name",
"tenant": "your_microsoft_entra_id_tenant",
"client_id": "your_microsoft_entra_id_client_id",
"client_secret": "your_microsoft_entra_id_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
tenant | Your Microsoft Entra ID tenant. |
client_id | Your Microsoft Entra ID client ID. |
client_secret | Your Microsoft Entra ID client Secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for following fields in the request:
tenant,client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Missive Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "missive",
"group_id": "target_group_id",
"config": {
"schema": "missive_schema_name",
"api_token": "your_missive_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Missive API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Mixmax Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mixmax",
"group_id": "target_group_id",
"config": {
"schema": "mixmax",
"api_token": "your_mixmax_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Mixmax API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Mixpanel
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mixpanel",
"group_id": "target_group_id",
"config": {
"schema": "mixpanel",
"api_secret": "your_api_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_secret | Mixpanel API Secret. |
region | Mixpanel Data Region. |
To find the API Secret, log in to your Mixpanel account, then click on the Account section and click on Project (see our Mixpanel setup guide). Ensure your account has access to this information.
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_secretfield in the request. - By using the Connect Card or the Fivetran dashboard.
Mode Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mode",
"group_id": "target_group_id",
"config": {
"schema": "mode",
"workspace": "your_mode_workspace",
"token": "your_mode_token",
"secret": "your_mode_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
workspace | Your Mode workspace. |
token | Your Mode token. |
secret | Your Mode secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
workspace,token, andsecret. - By using the Connect Card or the Fivetran dashboard.
Moloco Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "moloco",
"group_id": "target_group_id",
"config": {
"schema": "moloco_schema_name",
"workplace_id": "your_moloco_workplace_id",
"email": "your_moloco_email",
"password": "your_moloco_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
workplace_id | Your Moloco workplace ID. |
email | Your Moloco email address. |
password | Your Moloco password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
workplace_id,emailandpassword. - By using the Connect Card or the Fivetran dashboard.
Monday.com Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "monday",
"group_id": "target_group_id",
"config": {
"schema": "monday_schema_name",
"personal_api_token": "your_monday_personal_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
personal_api_token | Your Monday.com Personal API Token. |
Authorization
- By specifying the value for the
personal_api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
MongoDB
Fivetran supports two different MongoDB configurations. Each configuration has its own service value:
- MongdDB Replica Set -
"service": "mongo" - MongoDB Sharded Cluster -
"service": "mongo_sharded"
To learn more, see the setup guide for your MongoDB connector type.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mongo",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_mongo",
"hosts": ["mongoinstance.mycompany.com:27017"],
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"packing_mode": "UseUnpackedModeOnly",
"packed_mode_tables": []
}
}
Config parameters
| Name | Description | Notes |
|---|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. | |
hosts | A list of host addresses of the primary node and all replicas. Each list item is either: a DB instance host/IP address with a port number, or SRV host record. | |
user | The user name. | |
password | The user's password. | |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). | |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. | |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. | |
packing_mode | Whether to sync all tables in unpacked mode, all tables in packed mode, or specific tables in packed mode. Default value: UseUnpackedModeOnly. | UseUnpackedModeOnly, UsePackedModeOnly, 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). |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,userandpassword. - By using the Connect Card or the Fivetran dashboard.
MNTN Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mountain",
"group_id": "target_group_id",
"config": {
"schema": "mntn_schema_name",
"api_key": "your_mntn_reporting_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your MNTN reporting API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Mux Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mux",
"group_id": "target_group_id",
"config": {
"schema": "mux_schema_name",
"token_id": "your_mux_token_id",
"token_secret_key": "your_mux_token_secret_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
token_id | Your Mux token ID. |
token_secret_key | Your Mux token secret key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
token_idandtoken_secret_key. - By using the Connect Card or the Fivetran dashboard.
myosh Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "myosh",
"group_id": "target_group_id",
"config": {
"schema": "myosh_schema_name",
"username": "your_myosh_username",
"password": "your_myosh_password",
"api_key": "your_myosh_api_key",
"sub_domain": "your_myosh_subdomain",
"server_variable": "your_myosh_server_variable"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
username | Your myosh username. | |
password | Your myosh password. | |
api_key | Your myosh API key. | |
sub_domain | Your myosh subdomain. | oteapi, api, testapi |
server_variable | Your myosh server variable. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,password,api_key,sub_domain, andserver_variable. - By using the Connect Card or the Fivetran dashboard.
MySQL
Fivetran supports a few different incarnations of MySQL. Each type of connector has its own service value:
- Aurora MySQL -
"service": "aurora" - Azure Database for MySQL -
"service": "mysql_azure" - Azure Database for MariaDB -
"service": "maria_azure" - Generic MariaDB -
"service": "maria" - Generic MySQL -
"service": "mysql" - Google Cloud SQL for MySQL -
"service": "google_cloud_mysql" - Magento MySQL -
"service": "magento_mysql" - Magento Amazon RDS for MySQL -
"service": "magento_mysql_rds" - Amazon RDS for MariaDB -
"service": "maria_rds" - Amazon RDS for MySQL -
"service": "mysql_rds"
Check out our setup guide for your type of connector.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "mysql",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_mysql",
"host": "mysqlinstance.mycompany.com",
"port": 3306,
"database": "mysqldb",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"update_method": "BINLOG",
"replica_id": "4573961"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The user name. |
password | The user's password. |
database | The database name. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
update_method | The method to detect new or changed rows. Supported values: BINLOG - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. TELEPORT - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes. |
replica_id | Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,userandpassword. - By using the Connect Card or the Fivetran dashboard.
Namely Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "namely",
"group_id": "target_group_id",
"config": {
"schema": "namely_schema_name",
"sub_domain": "your_namely_subdomain"
},
"auth":{
"client_access":{
"client_id": "your_namely_client_id",
"client_secret": "your_namely_client_secret"
}
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Namely subdomain. |
client_id | Your Namely Client ID. |
client_secret | Your Namely Client Secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Navan Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "navan",
"group_id": "target_group_id",
"config": {
"schema": "navan_schema_name",
"region": "your_navan_region",
"client_id": "your_navan_client_id",
"client_secret": "your_navan_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
region | Your Navan region. |
client_id | Your Navan client ID. |
client_secret | Your Navan client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
region,client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Nice Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "nice",
"group_id": "target_group_id",
"config": {
"schema": "nice_schema_name",
"base_url": "your_nice_base_url",
"client_id": "your_nice_client_id",
"client_secret": "your_nice_client_secret",
"access_key_id": "your_nice_access_key_id",
"access_key_secret": "your_nice_access_key_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your Nice base URL. |
client_id | Your Nice client ID. |
client_secret | Your Nice client secret. |
access_key_id | Your Nice AccessKey ID. |
access_key_secret | Your Nice AccessKey Secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
base_url,client_id,client_secret,access_key_id, andaccess_key_secret. - By using the Connect Card or the Fivetran dashboard.
Notion Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "notion",
"group_id": "target_group_id",
"config": {
"schema": "notion_schema_name"
},
"auth":{
"client_access":{
"client_id": "your_notion_client_id",
"client_secret": "your_notion_client_secret"
}
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Notion Client ID. |
client_secret | Your Notion Client Secret. |
NetSuite SuiteAnalytics
Request
POST https://api.fivetran.com/v1/connectors
Request when using the NetSuite.com data source
{
"service": "netsuite_suiteanalytics",
"group_id": "target_group_id",
"config": {
"schema": "test_netsuite",
"host": "netsuite_service_host",
"port": "netsuite_service_port",
"datasource": "NetSuite.com",
"account": "netsuite_account_id",
"role": "netsuite_role_id",
"email": "netsuite_email",
"password": "netsuite_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
host | The NetSuite service host address. |
port | The NetSuite service host port. |
datasource | The NetSuite data source value: NetSuite.com. |
account | The NetSuite Account ID. |
role | The NetSuite Role ID for connection. |
email | The NetSuite user's email address. |
password | The NetSuite user's password. |
Request when using the NetSuite2.com data source
{
"service": "netsuite_suiteanalytics",
"group_id": "target_group_id",
"config": {
"schema": "test_netsuite",
"host": "netsuite_service_host",
"port": "netsuite_service_port",
"datasource": "NetSuite2.com",
"account": "netsuite_account_id",
"role": "netsuite_role_id",
"consumer_key": "netsuite_consumer_key",
"consumer_secret": "netsuite_consumer_secret",
"token_key": "netsuite_token_key",
"token_secret": "netsuite_token_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
host | The NetSuite service host address. |
port | The NetSuite service host port. |
datasource | The NetSuite2 data source value: NetSuite2.com. |
account | The NetSuite Account ID. |
role | The NetSuite Role ID for connection. |
consumer_key | The NetSuite consumer key obtained when creating an Integration Record. |
consumer_secret | The NetSuite consumer secret obtained when creating an Integration Record. |
token_key | The NetSuite token ID obtained when creating an Access Token. |
token_secret | The NetSuite token password obtained when creating an Access Token. |
Authorization
There are three ways to authorize this connector type:
- If you use the NetSuite.com data source, by specifying the values for the following fields in the request:
host,port,datasource,account,emailandpassword. - If you use the NetSuite2.com data source, by specifying the values for the following fields in the request:
host,port,datasource,account,role,consumer_key,consumer_secret,token_keyandtoken_secret. - By using the Connect Card or the Fivetran dashboard.
Nylas Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "nylas",
"group_id": "target_group_id",
"config": {
"schema": "nylas_schema_name",
"sub_domain": "your_nylas_sub_domain",
"access_token": "your_nylas_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Nylas subdomain. |
access_token | Your Nylas access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
sub_domainandaccess_token. - By using the Connect Card or the Fivetran dashboard.
Okendo Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "okendo",
"group_id": "target_group_id",
"config": {
"schema": "okendo_schema_name",
"user_id": "your_okendo_user_id",
"api_key": "your_okendo_user_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
user_id | Your Okendo user ID. |
api_key | Your Okendo API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
user_idandapi_key. - By using the Connect Card or the Fivetran dashboard.
Okta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "okta",
"group_id": "target_group_id",
"config": {
"schema": "okta_schema_name",
"api_token": "your_okta_api_token",
"sub_domain": "yourSubDomain",
"domain": "yourDomain"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
api_token | Your Okta API token. | |
sub_domain | Your Okta subdomain. For example, if your Okta URL is https://fivetran.okta-emea.com, then your subdomain is fivetran. | |
domain | (Optional) Your Okta domain. For example, if your Okta URL is https://fivetran.okta-apac.com, then your domain is fivetran.okta-apac.com. | .okta.com, .okta-emea.com, .okta-preview.com |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_token,domainandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Ometria Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ometria",
"group_id": "target_group_id",
"config": {
"schema": "ometria_schema_name",
"api_key": "your_ometria_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Ometria API key. |
Authorization
There are two ways to authorize this connector type:
- When creating the connector, by specifying the
api_keyin the request. - After creating the connector, by using the Connect Card or the Fivetran dashboard.
ON24 Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "on24",
"group_id": "target_group_id",
"config": {
"schema": "on24_schema_name",
"region": "your_on24_region",
"client_id": "your_on24_client_id",
"token_key": "your_on24_token_key",
"token_secret": "your_on24_token_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
region | Your ON24 account's region. |
client_id | Your ON24 client ID. |
token_key | Your ON24 token key. |
token_secret | Your ON24 token secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
region,client_id,token_key, andtoken_secret. - By using the Connect Card or the Fivetran dashboard.
OnceHub Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "oncehub",
"group_id": "target_group_id",
"config": {
"schema": "oncehub_schema_name",
"api_key": "your_oncehub_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your OnceHub API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
OneDrive
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "one_drive",
"group_id": "target_group_id",
"config": {
"schema": "test_one_drive",
"folder_path": "target_folder_path"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema has to be unique within the destination. Required for connector creation. |
folder_path | Your Onedrive folder URL. You can find the folder URL by following the steps mentioned in the OneDrive Setup Guide. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "one_drive", "group_id": "target_group_id", "config": { "schema": "test_one_drive", "folder_path": "target_folder_path" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Microsoft OneDrive client application.client_secretClient Secretof your Microsoft OneDrive client application.refresh_tokenThe long-lived Refresh tokencarries the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Open Data DC Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "open_data_dc",
"group_id": "target_group_id",
"config": {
"schema": "open_data_dc_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
Open Data DC is a publicly available dataset and does not require any authorization.
Open Exchange Rates Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "open_exchange_rates",
"group_id": "target_group_id",
"config": {
"schema": "open_exchange_rates_schema_name",
"app_id": "your_app_id",
"base_currency": "your_base_currency"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
app_id | Your Open Exchange Rates app ID. |
base_currency | Your Open Exchange Rates base currency. |
Authorization
There are two ways to authorize this connector type:
- By specifying values for the
app_idandbase_currencyfields in the request. - By using the Connect Card or the Fivetran dashboard.
OpenSearch Beta
Fivetran supports a few different incarnations of OpenSearch. Each type of connector has its own service value:
- OpenSearch -
"service": "opensearch" - Open Distro -
"service": "opendistro"
Check out our setup guide for your type of connector.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "opensearch",
"group_id": "target_group_id",
"config": {
"schema": "test_opensearch",
"host": "opensearchinstance.mycompany.com",
"port": 443,
"user": "user",
"password": "password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "tunnel_user",
"always_encrypted": true
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema prefix has to be unique within the destination. Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The user name. |
password | The user's password. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
always_encrypted | Default value: true. Set to false if TLS is not required when using an SSH tunnel. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following fields in the request for basic authentication:
userandpassword.POST https://api.fivetran.com/v1/connectors{ "service": "opensearch", "group_id": "target_group_id", "config": { "schema": "test_opensearch", "host": "opensearchinstance.mycompany.com", "port": 443, "user": "user", "password": "password" } }By using the Connect Card or the Fivetran dashboard.
Opsgenie Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "atlassian_ops_genie",
"group_id": "target_group_id",
"config": {
"schema": "atlassian_ops_genie_schema",
"region": "your_region",
"api_key": "your_api_key"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
region | Your company's Opsgenie region (usually company.opsgenie.com). | api, api.eu |
api_key | Your Opsgenie API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
regionandapi_key. - By using the Connect Card or the Fivetran dashboard.
Optimizely
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "optimizely",
"group_id": "target_group_id",
"config": {
"schema": "test_optimizely",
"account_id": "test_account_id",
"packing_mode": "Packed"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
account_id | Your Optimizely account ID. | |
packing_mode | Specifies how Fivetran should handle your enriched export data. Default value: Packed. | Packed, Unpacked |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "optimizely", "group_id": "target_group_id", "config": { "schema": "test_optimizely", "account_id" : "test_account_id" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Optimizely client application.client_secretClient Secretof your Optimizely client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Oracle
Fivetran supports a few different incarnations of Oracle. Each type of connector has its own service value:
- Generic Oracle -
"service": "oracle" - Oracle RAC -
"service": "oracle_rac" - Oracle RDS -
"service": "oracle_rds" - Oracle EBS -
"service": "oracle_ebs"
Check out our setup guide for your type of connector.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "oracle",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_oracle",
"host": "oracleinstance.mycompany.com",
"port": 1521,
"database": "oracledb",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"update_method": "TELEPORT"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The user name. |
password | The user's password. |
database | The database name. This is the SID or Service Name provided by your Oracle DBA. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
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. - TELEPORT - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes. |
Authorization
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.
Oracle Business Intelligence Publisher Beta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "oracle_business_intelligence_publisher",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_oracle_business_intelligence_publisher",
"server_url": "https://<oracle_fusion_cloud>:<port>",
"username": "test_username",
"password": "test_password",
"folder_path": "/Custom/test_folder"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
server_url | The Oracle Business Intelligence Publisher instance URL. |
username | The OracleBusiness Intelligence Publisher username. |
password | The Oracle Business Intelligence Publisher password. |
folder_path | The folder path created in Oracle Fusion Business Intelligence Publisher instance. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,password,server_url, andfolder_path. - By using the Connect Card or the Fivetran dashboard.
Oracle Fusion Cloud Applications
The request and response and their parameters (except service) are identical for the following Oracle Fusion Cloud Applications connectors:
- Oracle Fusion CRM -
"service": "oracle_fusion_cloud_apps_crm" - Oracle Fusion FSCM -
"service": "oracle_fusion_cloud_apps_fscm" - Oracle Fusion HCM -
"service": "oracle_fusion_cloud_apps_hcm"
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "oracle_fusion_cloud_apps_crm",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_oracle_fusion_cloud",
"server_url": "https://<oracle_fusion_cloud_instance>:<port>",
"username": "test_username",
"authentication_method": "BASIC",
"password": "test_password",
"issuer": "test_issuer",
"private_key": "private_key",
"public_key": "public_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
server_url | The Oracle Fusion Cloud Instance URL. |
username | The Oracle Fusion Cloud username. |
authentication_method | Authentication method of your Oracle Fusion connector. (BASIC or JWT) |
password | Your Oracle Fusion Cloud user password. Required if authentication_method is set to BASIC. |
issuer | The issuer name of your API authentication. Required if authentication_method is set to JWT. |
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-----). Required if authentication_method is set to JWT. |
public_key | The complete contents of your public key file, including the start and end tags (-----BEGIN CERTIFICATE-----Your key without line breakers-----END CERTIFICATE-----). Required if authentication_method is set to JWT. |
Authorization
There are three ways to authorize this connector type:
By specifying the
authentication_methodas BASIC and the values for the following fields in the request:usernameandpassword.POST https://api.fivetran.com/v1/connectors{ "service": "oracle_fusion_cloud_apps_crm", "group_id": "target_group_id", "config": { "schema_prefix": "test_oracle_fusion_cloud", "server_url": "https://<oracle_fusion_cloud_instance>:<port>", "username": "test_username", "authentication_method": "BASIC", "password": "test_password" } }By specifying the
authentication_methodas JWT and the values for the following fields in the request:username,issuer,private_keyandpublic_key.POST https://api.fivetran.com/v1/connectors{ "service": "oracle_fusion_cloud_apps_crm", "group_id": "target_group_id", "config": { "schema_prefix": "test_oracle_fusion_cloud", "server_url": "https://<oracle_fusion_cloud_instance>:<port>", "username": "test_username", "authentication_method": "JWT", "issuer": "test_issuer", "private_key": "private_key", "public_key": "public_key" } }By using the Connect Card or the Fivetran dashboard.
Oracle Moat Analytics Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "oracle_moat_analytics",
"group_id": "target_group_id",
"config": {
"schema": "oracle_moat_analytics_schema_name",
"token": "your_oracle_moat_analytics_token",
"brand_id": "your_oracle_moat_analytics_brand_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
token | Your Oracle Moat Analytics Token. |
brand_id | Your Oracle Moat Analytics Brand ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
tokenandbrand_id. - By using the Connect Card or the Fivetran dashboard.
Orbit Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "orbit",
"group_id": "target_group_id",
"config": {
"schema": "orbit_schema_name",
"bearer_token": "your_orbit_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
bearer_token | Your Orbit API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
bearer_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Ordway Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ordway",
"group_id": "target_group_id",
"config": {
"schema": "ordway_schema_name",
"account": "your_ordway_account",
"api_token": "your_ordway_api_token",
"company": "your_ordway_company_name",
"email_id": "your_ordway_email_id",
"api_key": "your_ordway_api_key"
}
}
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
account | Your Ordway account type. |
api_token | Your Ordway API token. |
company | Your Ordway company name. |
email_id | Your Ordway user email ID. |
api_key | Your Ordway API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
account,api_token,company,email_id, andapi_key. - By using the Connect Card or the Fivetran dashboard.
Ortto Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ortto",
"group_id": "target_group_id",
"config": {
"schema": "ortto_schema_name",
"api_key": "your_ortto_api_key",
"base_url": "your_ortto_base_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Ortto API key. |
base_url | Your Ortto base URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_keyandbase_url - By using the Connect Card or the Fivetran dashboard.
Outbrain
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "outbrain",
"group_id": "target_group_id",
"config": {
"schema": "test_outbrain",
"user": "outbrain_user",
"password": "outbrain_password",
"timeframe_months": "THREE",
"pullArchivedCampaigns": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
user | The username or email of the Outbrain user. | |
password | The Outbrain user's password. | |
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. The default value is TWELVE. NOTE: The more months of reporting data you sync, the longer your initial sync will take. | THREE, SIX, TWELVE, TWENTY_FOUR, ALL_TIME |
pullArchivedCampaigns | The boolean value specifying whether to sync or not data for archived campaigns. Default value: false |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
userandpassword. - By using the Connect Card or the Fivetran dashboard.
Outreach
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "outreach",
"group_id": "target_group_id",
"config": {
"schema": "test_outreach"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "outreach", "group_id": "target_group_id", "config": { "schema": "test_outreach", "domain": "domain" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Outreach client application.client_secretClient Secretof your Outreach client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Packiyo Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "packiyo",
"group_id": "target_group_id",
"config": {
"schema": "packiyo_schema_name",
"subdomain": "your_packiyo_subdomain",
"api_token": "your_packiyo_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your Packiyo subdomain. |
api_token | Your Packiyo API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_tokenandsubdomain. - By using the Connect Card or the Fivetran dashboard.
PagerDuty Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pagerduty",
"group_id": "target_group_id",
"config": {
"schema": "pagerduty_schema_name",
"api_key": "your_pagerduty_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your PagerDuty API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
PandaDoc Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pandadoc",
"group_id": "target_group_id",
"config": {
"schema": "pandadoc_schema_name",
"api_key": "your_pandadoc_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your PandaDoc API key (production key). |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Papershift Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "papershift",
"group_id": "target_group_id",
"config": {
"schema": "papershift_schema_name",
"api_key": "your_papershift_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Papershift API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Pardot
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pardot",
"group_id": "target_group_id",
"config": {
"schema": "test_pardot",
"email": "pardot_user_email",
"password": "pardot_password",
"business_unit_id": "pardot_business_unit_id",
"salesforce_security_token": "pardot_salesforce_security_token",
"api_version": "V4",
"historical_sync_limit": "historical_sync_limit",
"rest_api_limit": 150000,
"time_zone": "GMT+05:30",
"is_external_activities_endpoint_selected": true,
"limit_for_api_calls_to_external_activities_endpoint": 150000
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
email | The email of the Pardot user. | |
password | The Pardot user's password. | |
business_unit_id | The Pardot user's Business Unit ID. | |
salesforce_security_token | The Pardot user's Salesforce SSO Account Security Token. | |
api_version | The Pardot API Version Fivetran should use. An empty value defaults to V3. | V3, V4 |
historical_sync_limit | The time range for which historical data should be synced. Default value: All Time. | 3 months, 6 months, 1 year, 2 years, 5 years, All Time |
rest_api_limit | The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000. | |
time_zone | The time zone configured in your Pardot instance. An empty value defaults to UTC+00:00. | GMT+01:00, GMT+02:00, GMT+03:00, GMT+03:30, GMT+04:00, GMT+04:30, GMT+05:00, GMT+05:30, GMT+05:45, GMT+06:00, GMT+06:30, GMT+07:00, GMT+08:00, GMT+08:45, GMT+09:00, GMT+09:30, GMT+10:00, GMT+10:30, GMT+11:00, GMT+12:00, GMT+12:45, GMT+13:00, GMT+13:45, GMT+14:00, GMT+00:00, GMT-01:00, GMT-02:00, GMT-02:30, GMT-03:00, GMT-03:30, GMT-04:00, GMT-05:00, GMT-06:00, GMT-07:00, GMT-08:00, GMT-09:00, GMT-09:30, GMT-10:00, GMT-11:00, GMT-12:00 |
is_external_activities_endpoint_selected | Whether the EXTERNAL_ACTIVITY table must be synced or not. | |
limit_for_api_calls_to_external_activities_endpoint | API limit for the external activities endpoint. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "pardot", "group_id": "target_group_id", "config": { "schema": "test_pardot", "email": "pardot_user_email", "password": "pardot_password", "business_unit_id": "pardot_business_unit_id", "salesforce_security_token": "pardot_salesforce_security_token", "api_version": "V4", "historical_sync_limit": "historical_sync_limit", "rest_api_limit": 150000, "time_zone": "GMT+05:30", "is_external_activities_endpoint_selected": true, "limit_for_api_calls_to_external_activities_endpoint": 150000 }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" } } }Auth parameters
Name Description client_idClient IDof your Pardot client application.client_secretClient Secretof your Pardot client application.By using the Connect Card or the Fivetran dashboard.
Partnerize Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "partnerize",
"group_id": "target_group_id",
"config": {
"schema": "partnerize_schema_name",
"application_key": "your_partnerize_user_application_key",
"api_key": "your_partnerize_user_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
application_key | Your Partnerize user application key. |
api_key | Your Partnerize user api key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
application_keyandapi_key. - By using the Connect Card or the Fivetran dashboard.
PartnerStack Vendor Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "partnerstack_vendor",
"group_id": "target_group_id",
"config": {
"schema": "partnerstack_vendor_schema_name",
"public_key": "your_partnerstack_vendor_public_key",
"secret_key": "your_partnerstack_vendor_secret_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
public_key | Your PartnerStack Vendor public key. |
secret_key | Your PartnerStack Vendor secret key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
public_keyandsecret_key. - By using the Connect Card or the Fivetran dashboard.
Paychex Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "paychex",
"group_id": "target_group_id",
"config": {
"schema": "paychex_schema_name",
"client_id": "your_paychex_api_key",
"client_secret": "your_paychex_api_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Paychex API key. |
client_secret | Your Paychex API secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
PayPal
Fivetran supports sandbox mode for PayPal connectors. Provide "paypal_sandbox" as a service to use sandbox mode.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "paypal",
"group_id": "target_group_id",
"config": {
"schema": "paypal",
"client_id": "my_client_id",
"secret_key": "my_secret_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Client ID of your PayPal client application. |
secret_key | Secret Key of your PayPal client application. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandsecret_key. - By using the Connect Card or the Fivetran dashboard.
Pendo
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pendo",
"group_id": "target_group_id",
"config": {
"schema": "test_pendo",
"integration_key": "pendo_integration_key",
"region": "pendo_region",
"sync_mode": "SpecificAppIds",
"app_ids": ["appId1(234)","appId2(456)"]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
integration_key | The integration key of the Pendo account. | |
region | The Pendo account region. | US, EU |
sync_mode | Whether to sync all App IDs or specific App IDs. Default value: AllAppIds. | AllAppIds, SpecificAppIds |
app_ids | Specific App IDs to sync. Must be populated if sync_mode is set to SpecificAppIds. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
integration_keyandregion. - By using the Connect Card or the Fivetran dashboard.
Persona Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "persona",
"group_id": "target_group_id",
"config": {
"schema": "persona_schema_name",
"api_key": "your_persona_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Persona API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Personio Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "personio",
"group_id": "target_group_id",
"config": {
"schema": "personio_schema_name",
"client_id": "your_personio_clientid",
"client_secret": "your_personio_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Personio Client ID. |
client_secret | Your Personio secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Phoenix Ads Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "phoenix_ads",
"group_id": "target_group_id",
"config": {
"schema": "phoenix_ads_schema_name",
"agent_id": "your_phoenix_ads_agent_id",
"secret_key": "your_phoenix_ads_secret_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
agent_id | Your Phoenix Ads Agent ID. |
secret_key | Your Phoenix Ads Secret key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
agent_idandsecret_key. - By using the Connect Card or the Fivetran dashboard.
Picqer Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "picqer",
"group_id": "target_group_id",
"config": {
"schema": "picqer_schema_name",
"api_key": "your_picqer_api_key",
"sub_domain": "your_picqer_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Picqer API key. |
sub_domain | Your Picqer subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Pigment Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pigment",
"group_id": "target_group_id",
"config": {
"schema": "pigment_schema_name",
"api_key": "your_pigment_api_key",
"view_id": "your_pigment_view_id",
"list_id": "your_pigment_list_id",
"metric_id": "your_pigment_metric_id",
"table_id": "your_pigment_table_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Pigment API key. |
view_id | Your Pigment view ID. |
list_id | Your Pigment list ID. |
metric_id | Your Pigment metric ID. |
table_id | Your Pigment table ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key,view_id,list_id,metric_id, andtable_id. - By using the Connect Card or the Fivetran dashboard.
Pingdom Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pingdom",
"group_id": "target_group_id",
"config": {
"schema": "pingdom_schema_name",
"username": "your_pingdom_username"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Pingdom username. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the following field in the request:
username. - By using the Connect Card or the Fivetran dashboard.
Pinpoint Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pinpoint",
"group_id": "target_group_id",
"config": {
"schema": "pinpoint_schema_name",
"api_key": "your_pinpoint_api_key",
"sub_domain": "your_pinpoint_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Pinpoint API key. |
sub_domain | Your Pinpoint subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Pinterest Ads
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pinterest_ads",
"group_id": "group_id",
"config": {
"schema": "test_pinterest",
"sync_mode": "SpecificAdvertisers",
"advertisers": ["advertiser1", "advertiser2"],
"click_attribution_window": "THIRTY",
"engagement_attribution_window": "THIRTY",
"view_attribution_window": "ONE",
"conversion_report_time": "AD_EVENT",
"timeframe_months": "THREE"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sync_mode | Whether to sync all advertisers or specific advertisers. | AllAdvertisers, SpecificAdvertisers |
advertisers | Specific Advertisers to sync. Must be populated if sync_mode is set to SpecificAdvertisers. | |
click_attribution_window | The number of days to use as the conversion attribution window for a 'click' action. | ONE, SEVEN, THIRTY, SIXTY |
engagement_attribution_window | The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action. | ONE, SEVEN, THIRTY, SIXTY |
view_attribution_window | The number of days to use as the conversion attribution window for a 'view' action. | ONE, SEVEN, THIRTY, SIXTY |
conversion_report_time | The date that the user interacted with the ad OR completed a conversion event. | AD_EVENT, CONVERSION_EVENT |
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 |
Authorization
There are two ways to authorize this connector type:
By specifying the values of the
client_id,client_secret, andrefresh_tokenparameters in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "pinterest_ads", "group_id": "group_id", "config": { "schema": "test_pinterest", "sync_mode": "SpecificAdvertisers", "advertisers": ["advertiser1", "advertiser2"], "click_attribution_window": "THIRTY", "engagement_attribution_window": "THIRTY", "view_attribution_window": "ONE", "conversion_report_time": "AD_EVENT", "timeframe_months": "THREE", "refresh_token_expires_at": 1717858800 }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Pinterest client application.client_secretClient Secretof your Pinterest client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources. Make sure theRefresh tokensupports the following scope:"ads:read,boards:read,boards:read_secret,pins:read,pins:read_secret,user_accounts:read,catalogs:read".refresh_token_expires_at(Optional) The expiration date of the refresh token as a Unix timestamp in seconds. By using the Connect Card or through the Fivetran dashboard.
Pinterest Organic Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pinterest_organic",
"group_id": "target_group_id",
"config": {
"schema": "pinterest_organic_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessparameter in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "pinterest_organic", "group_id": "target_group_id", "config": { "schema": "pinterest_organic_schema_name" }, "auth": { "client_access": { "client_id": "pinterest_organic_client_id", "client_secret": "pinterest_organic_client_secret" }, "refresh_token": "your_refresh_token", "access_token": "your_access_token" } }Auth parameters
Name Description client_access.client_idYour Pinterest client ID. client_access.client_secretYour Pinterest client secret. refresh_tokenYour Pinterest refresh token. access_tokenYour Pinterest access token. By using the Connect Card or the Fivetran dashboard.
Pipedrive
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pipedrive",
"group_id": "target_group_id",
"config": {
"schema": "test_pipedrive",
"domain": "domain",
"api_token": "api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
domain | Your Pipedrive domain. |
api_token | (Optional) The Personal API token of your Pipedrive account. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "pipedrive", "group_id": "target_group_id", "config": { "schema": "test_pipedrive", "domain": "domain" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Pipedrive client application.client_secretClient Secretof your Pipedrive client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Pipe17 Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pipe17",
"group_id": "target_group_id",
"config": {
"schema": "test_pipe17",
"api_key": "your_pipe17_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | The Pipe17 API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - After creation using the Connect Card or the Fivetran dashboard.
Pivotal Tracker Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "pivotal_tracker",
"group_id": "target_group_id",
"config": {
"schema": "pivotal_tracker",
"api_token": "your_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Pivotal Tracker API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Piwik PRO Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "piwik_pro",
"group_id": "piwik_pro_group_id",
"config": {
"schema": "piwik_pro_schema_name",
"client_id": "your_piwik_pro_client_id",
"client_secret": "your_piwik_pro_client_secret",
"sub_domain": "your_piwik_pro_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Piwik PRO client ID. |
client_secret | Your Piwik PRO client secret. |
sub_domain | Your Piwik PRO subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secretandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Placer.ai Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "placerai",
"group_id": "target_group_id",
"config": {
"schema": "placerai_schema_name",
"api_key": "your_placerai_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Placer.ai API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
PlanetScale Beta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "planetscale",
"group_id": "target_group_id",
"config": {
"schema": "planetscale_schema_name",
"host": "host",
"database": "database",
"username": "username",
"password": "password",
"shards": "shards",
"use_replica": "use_replica",
"treat_tiny_int_as_boolean": "treat_tiny_int_as_boolean"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
host | The database host name. |
database | The database name. |
username | The username. |
password | The password. |
shards | (Optional) The comma-separated list of shards to sync. |
use_replica | (Optional) The boolean specifying whether replica is used. |
treat_tiny_int_as_boolean | (Optional) The boolean specifying whether tinyint(1) is treated as boolean. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,database,usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Planful Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "planful",
"group_id": "target_group_id",
"config": {
"schema": "planful_schema_name",
"access_id": "your_planful_access_id",
"access_key": "your_planful_access_key",
"email_id": "your_planful_email_id",
"tenant_app_url": "your_planful_tenant_app_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_id | Your Planful access ID. |
access_key | Your Planful access key. |
email_id | Your Planful email ID. |
tenant_app_url | Your Planful tenant app URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
access id,access key,email_id, andtenant_app_url. - By using the Connect Card or the Fivetran dashboard.
Planhat Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "planhat",
"group_id": "target_group_id",
"config": {
"schema": "planhat_schema_name",
"access_token": "your_planhat_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your Planhat access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Playvox Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "playvox",
"group_id": "target_group_id",
"config": {
"schema": "playvox_schema_name",
"api_key": "your_playvox_api_key",
"sub_domain": "your_playvox_subdomain",
"user_id": "your_playvox_user_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Playvox API key. |
sub_domain | Your Playvox subdomain. |
user_id | Your Playvox user ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key,sub_domain, anduser_id. - By using the Connect Card or the Fivetran dashboard.
Playvox Workforce Management Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "playvox_workforce_management",
"group_id": "target_group_id",
"config": {
"schema": "playvox_workforce_management_schema_name",
"region_url": "your_playvox_workforce_management_region_url",
"tenant_url": "your_playvox_workforce_management_tenant_url",
"identifier": "your_playvox_workforce_management_client_identifier",
"secret": "your_playvox_workforce_management_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
region_url | Your Playvox Workforce Management region URL. |
tenant_url | Your Playvox Workforce Management tenant URL. |
identifier | Your Playvox Workforce Management client identifier. |
secret | Your Playvox Workforce Management client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
region_url,tenant_url,identifier, andsecret. - By using the Connect Card or the Fivetran dashboard.
Podio Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "podio",
"group_id": "target_group_id",
"config": {
"schema": "podio_schema_name",
"username": "your_podio_username",
"password": "your_podio_password",
"client_id": "your_podio_client_id",
"client_secret": "your_podio_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Podio account username. |
password | Your Podio account password. |
client_id | Your Podio client ID. |
client_secret | Your Podio client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,password,client_id, andclient_secret. - By using the Connect Card or the Fivetran dashboard.
PostgreSQL
Fivetran supports a few different incarnations of PostgreSQL. Each type of connector has its own service value:
- Aurora -
"service": "aurora_postgres" - Azure -
"service": "azure_postgres" - Generic PostgreSQL -
"service": "postgres" - Google Cloud SQL -
"service": "google_cloud_postgresql" - Heroku -
"service": "heroku_postgres" - RDS -
"service": "postgres_rds"
Check out our setup guide for your type of connector.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "postgres",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_postgres",
"host": "postgresinstance.mycompany.com",
"port": 5432,
"database": "postgres",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"auth_method": "PASSWORD",
"update_method": "WAL",
"replication_slot": "test_replication_slot"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The user name. |
password | The user's password. |
database | The database name. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
auth_method | Database authentication method. Specify only for "service": "google_cloud_postgresql". Supported values: PASSWORD - The default method. Connect to your database using username and password.CLIENT_CERTIFICATE - Additionally authenticate with your database using client certificates. |
update_method | The method to detect new or changed rows. Specify only for "service": "postgres" or "service": "postgres_rds". Supported values: WAL - this method replicates new, changed and deleted rows by tailing the write-ahead log (WAL) through a logical slot. This is more efficient than the XMIN method, but requires more setup and monitoring.XMIN - this method detects new or changed rows using the XMIN system column, but is not capable of detecting deleted rows.WAL_PGOUTPUT - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot.TELEPORT - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes. |
replication_slot | Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". |
publication_name | Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,user,passwordanddatabase. - By using the Connect Card or the Fivetran dashboard.
PostHog Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "posthog",
"group_id": "target_group_id",
"config": {
"schema": "posthog_schema_name",
"api_key": "your_posthog_api_key",
"sub_domain": "your_posthog_data_region"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
api_key | Your PostHog API key. | |
sub_domain | Your PostHog data region (US or EU). | app, eu |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Postmark Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "postmark",
"group_id": "target_group_id",
"config": {
"schema": "postmark",
"api_token": "your_postmark_account_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Postmark account API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
PowerReviews Enterprise Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "power_reviews_enterprise",
"group_id": "target_group_id",
"config": {
"schema": "power_reviews_enterprise_schema_name",
"client_id": "your_power_reviews_enterprise_client_id",
"client_secret": "your_power_reviews_enterprise_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your PowerReviews Enterprise Client ID. |
client_secret | Your PowerReviews Enterprise Client Secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Prisma Cloud Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "prisma_cloud",
"group_id": "target_group_id",
"config": {
"schema": "prisma_cloud_name",
"client_id": "your_prisma_cloud_access_key_id",
"client_secret": "your_prisma_cloud_secret_access_key",
"base_url": "your_prisma_cloud_admin_console_url",
"console_url": "your_prisma_cloud_console_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Prisma Cloud access key ID. |
client_secret | Your Prisma Cloud secret access key. |
base_url | Your Prisma Cloud admin console URL. |
console_url | Your Prisma Cloud console URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,base_url, andconsole_url. - By using the Connect Card or the Fivetran dashboard.
Prive Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "prive",
"group_id": "target_group_id",
"config": {
"schema": "prive_schema_name",
"api_key": "your_prive_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Prive API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Procore Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "procore",
"group_id": "target_group_id",
"config": {
"schema": "procore_schema_name",
"environment": "your_procore_account_environment",
"client_id": "your_procore_client_id",
"client_secret": "your_procore_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
environment | Your Procore account environment. |
client_id | Your Procore client ID. |
client_secret | Your Procore client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
environment,client_id, andclient_secret. - By using the Connect Card or the Fivetran dashboard.
Productboard Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "productboard",
"group_id": "target_group_id",
"config": {
"schema": "productboard_schema_name",
"bearer_token": "your_productboard_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
bearer_token | Your Productboard API key. |
Authorization
There are two ways to authorize this connector type:
- When creating the connector, by specifying a value for the following field in the request:
bearer_token. - By using the Connect Card or the Fivetran dashboard.
Productive Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "productive",
"group_id": "target_group_id",
"config": {
"schema": "productive_schema_name",
"personal_access_token": "your_productive_personal_access_token",
"organization_id": "your_productive_organization_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
personal_access_token | Your Productive personal access token. |
organization_id | Your Productive organization ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
personal_access_tokenandorganization_id. - By using the Connect Card or the Fivetran dashboard.
Proofpoint Security AwarenessLite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "proofpoint_security_awareness",
"group_id": "target_group_id",
"config": {
"schema": "proofpoint_security_awareness_schema_name",
"token_key": "your_proofpoint_security_awareness_token_key",
"region": "your_proofpoint_security_awareness_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
token_key | Your Proofpoint Security Awareness Token Key. |
region | Your Proofpoint Security Awareness Region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
token_keyandregion. - By using the Connect Card or the Fivetran dashboard.
Qualaroo Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "qualaroo",
"group_id": "target_group_id",
"config": {
"schema": "qualaroo_schema_name",
"api_key": "your_qualaroo_api_key",
"api_secret": "your_qualaroo_api_secret",
"survey_ids": ["qualaroo_survey_id_1","qualaroo_survey_id_2"]
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Qualaroo API key. |
api_secret | Your Qualaroo API secret. |
survey_ids | Array of Qualaroo survey IDs. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandapi_secret. - By using the Connect Card or the Fivetran dashboard.
Qualtrics
Request
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.
POST https://api.fivetran.com/v1/connectors
{
"service": "qualtrics",
"group_id": "target_group_id",
"config": {
"schema": "qualtrics",
"auth_type": "ADVANCED",
"data_center": "data_center",
"certificate": "---",
"private_key": "---",
"pass_phrase": "---"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
data_center | Data center ID of the Qualtrics account. You can find it in the URL before qualtrics.com. For example, if your URL is youraccount.ca1.qualtrics.com, then the data center ID is ca1. | |
auth_type | Authentication type | STANDARD, ADVANCED |
certificate | Provide content of the .cert certificate (only when auth_type = ADVANCED). | String |
private_key | Provide content of the .pem private key (only when auth_type = ADVANCED). | String |
pass_phrase | Enter the pass phrase for the generated private-key (only when auth_type = ADVANCED). | String |
Authorization
IMPORTANT: Qualtrics connectors created on or after July 25, 2024, must authenticate using either STANDARD or ADVANCED authentication method.
There are three ways to authorize this connector type:
STANDARD (recommended)authentication:By specifying
auth_typeasSTANDARDand the values for theclient_accessandrefresh_tokenfields in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "qualtrics", "group_id": "target_group_id", "config": { "schema": "qualtrics", "auth_type": "STANDARD", "data_center": "data_center" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient ID of your Qualtrics client application. client_secretClient secret of your Qualtrics client application. refresh_tokenThe long-lived Refresh token, along with theclient_idandclient_secretparameters, carry the information necessary to get a new access token for API resources.Config parameters
Name Description schemaThe connector schema has to be unique within the destination. Required for connector creation. auth_typeType of Authentication. data_centerData center ID of the Qualtrics account. Can be found in the URL before qualtrics.com. (For example, if your URL isyouraccount.ca1.qualtrics.com, then the data center isca1.)ADVANCEDauthentication :By specifying
auth_typeasADVANCEDalong with the values for thecertificate,private_key,pass_phrasefields and the values for theclient_accessfields in the auth section.POST https://api.fivetran.com/v1/connectors{ "service": "qualtrics", "group_id": "target_group_id", "config": { "schema": "qualtrics", "auth_type": "ADVANCED", "data_center": "data_center", "certificate": "---", "private_key": "---", "pass_phrase": "---" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" } } }Auth parameters
Configure the connected app mentioned below, for OAuth2.0 client-credential flow, as per our Advanced authentication setup guide.
Name Description client_idClient Id of your private app. client_secretClient secret of your private app refresh_tokenNULL , refresh_tokenis not involved in this flow.Config parameters
Name Description schemaThe connector schema has to be unique within the destination. Required for connector creation. data_centerData center ID of the Qualtrics account. Can be found in the URL before qualtrics.com. (For example, if your URL isyouraccount.ca1.qualtrics.com, then the data center isca1.)auth_typeType of Authentication. certificateProvide content of the .cert certificate. private_keyProvide content of the .key private key. pass_phraseEnter the pass phrase for the generated private-key. NOTE: Required scopes: "read:contact_frequency_rules read:contact_transactions read:directories read:directory_contacts read:distributions read:groups read:libraries read:mailing_list_contacts read:mailing_lists read:organizations read:samples read:subscriptions read:survey_responses read:survey_sessions read:surveys read:tickets read:users"
By using the Connect Card or the Fivetran dashboard.
The following example will allow you to configure the Qualtrics API usage limit of an existing connector.
PATCH https://api.fivetran.com/v1/connectors/{connector_id}{ "config": { "api_requests_per_minute": 1500 } }Config parameters
Name Description schemaThe connector schema name has to be unique within the destination. Required for connector creation. data_centerData center ID of the Qualtrics account. Can be found in the URL before qualtrics.com. (For example, if your URL isyouraccount.ca1.qualtrics.com, then the data center isca1.)api_requests_per_minuteAllowed number of API requests to Qualtrics per minute.
QuickBooks
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "quickbooks",
"group_id": "target_group_id",
"config": {
"schema": "test_quickbooks"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_access,refresh_token, andrealm_idin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "quickbooks", "group_id": "target_group_id", "config": { "schema": "test_quickbooks" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token", "realm_id": "my_realm_id" } }Auth parameters
Name Description client_idClient IDof your QuickBooks client application.client_secretClient Secretof your QuickBooks client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.realm_idRealm IDof your QuickBooks application.By using the Connect Card or the Fivetran dashboard.
Quora Ads Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "quora_ads",
"group_id": "target_group_id",
"config": {
"schema": "quora_ads_schema_name",
"client_id": "your_quora_ads_client_id",
"client_secret": "your_quora_ads_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Quora Ads client ID. |
client_secret | Your Quora Ads client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Quorum Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "quorum",
"group_id": "target_group_id",
"config": {
"schema": "quorum_schema_name",
"api_key": "your_quorum_api_key",
"username": "your_quorum_username"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Quorum API key. |
username | Your Quorum username . |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandusername. - By using the Connect Card or the Fivetran dashboard.
Rakuten Advertising Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rakutenadvertising",
"group_id": "target_group_id",
"config": {
"schema": "rakutenadvertising_schema_name",
"report_keys": "your_rakutenadvertising_report_keys",
"api_token": "your_rakutenadvertising_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
report_keys | Your Rakuten Advertising report keys. |
api_token | Your Rakuten Advertising API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
report_keysandapi_token. - By using the Connect Card or the Fivetran dashboard.
Ramp Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ramp",
"group_id": "target_group_id",
"config": {
"schema": "ramp_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_access,refresh_token, andaccess_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "ramp", "group_id": "target_group_id", "config": { "schema": "ramp_schema_name" }, "auth": { "client_access": { "client_id": "ramp_client_id", "client_secret": "ramp_client_secret" }, "refresh_token": "ramp_refresh_token", "access_token": "ramp_access_token" } }Auth parameters
Name Description client_idYour Ramp client ID. client_secretYour Ramp client secret. refresh_tokenYour Ramp refresh token. access_tokenYour Ramp access token. By using the Connect Card or the Fivetran dashboard.
Rarible Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rarible",
"group_id": "target_group_id",
"config": {
"schema": "rarible_schema_name",
"blockchain": "you_rarible_blockchain",
"collection_address": "your_rarible_collection_address"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
blockchain | Your Rarible Blockchain. |
collection_address | Your Rarible Collection Address. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
blockchainandcollection_address. - By using the Connect Card or the Fivetran dashboard.
ReBound Returns Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rebound_returns",
"group_id": "target_group_id",
"config": {
"schema": "rebound_returns_schema_name",
"login": "your_rebound_returns_login",
"api_key": "your_rebound_returns_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
login | Your ReBound Returns login. |
api_key | Your ReBound Returns API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
loginandapi_key. - By using the Connect Card or the Fivetran dashboard.
Recharge
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "recharge",
"group_id": "target_group_id",
"config": {
"schema": "test_recharge",
"api_token": "recharge_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | The Recharge API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Recurly
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "recurly",
"group_id": "target_group_id",
"config": {
"schema": "test_recurly",
"sub_domain": "recurly_subdomain",
"api_key": "recurly_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your company's Recurly subdomain. |
api_key | The Recurly API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domainandapi_key. - By using the Connect Card or the Fivetran dashboard.
Reddit Ads
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "reddit_ads",
"group_id": "target_group_id",
"config": {
"schema": "test_reddit_ads",
"custom_reports": [
{
"report_name": "test_report_name",
"level": "CAMPAIGN",
"segmentation": "COMMUNITY",
"conversions_report_included": true,
"custom_events_included": true,
"report_fields": ["clicks", "cpc", "ctr", "app_install_metrics"],
"event_names": ["lead", "sign_up", "purchase"],
"time_zone_mode": "USER",
"time_zone": "GMT"
}
],
"timeframe_months": "SIX",
"sync_multiple_accounts": true,
"accounts": [
{
"name": "other_linked_account_name"
}
]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
custom_reports | The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data. | |
report_name | The table name within the schema to which connector will sync the data of the specific report. | |
level | Level of custom report. | ACCOUNT, CAMPAIGN, AD_GROUP , AD, POST, NONE |
segmentation | Level of custom report. | COUNTRY, METRO, INTEREST , COMMUNITY, PLACEMENT, NONE |
conversions_report_included | The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: false | true, false |
custom_events_included | The boolean value specifying whether the custom events will be included in event conversions report. Default value: false | true, false |
report_fields | The list of fields included in custom report | Possible field values |
event_names | The list of events the conversion data will be synchronised for | Possible event values |
time_zone_mode | When set to ACCOUNT, the connector uses your Reddit Ads account's time zone to sync report data. When set to USER, the connector uses the value provided in the time_zone field. Default value: ACCOUNT. | ACCOUNT, USER |
time_zone | The specific time zone to sync report data if time_zone_mode is set to USER. | Possible values can be queried from Reddit Ads' API endpoint https://ads-api.reddit.com/api/v2.0/time_zones |
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 |
sync_multiple_accounts | When this parameter is set to true, we sync the data of the additional linked accounts. When this parameter is set to false, we sync only the data from the main account that was used for authorization | true, false |
accounts | Additional linked accounts list. | |
name | Reddit username of the additional linked account. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "reddit_ads", "group_id": "target_group_id", "config": { "schema": "test_reddit_ads" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Reddit Ads client application.client_secretClient Secretof your Reddit Ads client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
ReferralHero Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "referralhero",
"group_id": "target_group_id",
"config": {
"schema": "referral_schema_name",
"api_token": "your_referralhero_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your ReferralHero API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Reltio Beta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "reltio",
"group_id": "target_group_id",
"config": {
"schema": "reltio_schema_name",
"tenant_configs": [
{
"tenant_id": "your_reltio_tenant_id",
"subdomain": "your_reltio_subdomain",
"client_id": "your_reltio_client_id",
"client_secret": "your_reltio_client_secret"
}
],
"max_api_requests_per_day": 1000000
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
tenant_id | Your Reltio tenant ID. | |
subdomain | Your Reltio subdomain. | |
client_id | Your Reltio client ID. | |
client_secret | Your Reltio client secret. | |
max_api_requests_per_day | The maximum number of API requests per day. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
tenant_id,sub_domain,client_id, andclient_secret. - By using the Connect Card or the Fivetran dashboard.
Reply.io Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "replyio",
"group_id": "target_group_id",
"config": {
"schema": "replyio_schema_name",
"api_key": "your_replyio_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Reply.io API key. |
Authorization
There are two ways to authorize this connector type:
- When creating the connector, by specifying a value for the following field in the request:
api_key. - After creating the connector, by using the Connect Card or the Fivetran dashboard.
Resource Management by Smartsheet Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "resource_management_by_smartsheet",
"group_id": "target_group_id",
"config": {
"schema": "resource_management_by_smartsheet_schema_name",
"api_token": "your_resource_management_by_smartsheet_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Resource Management by Smartsheet API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
RetailNext Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "retailnext",
"group_id": "target_group_id",
"config": {
"schema": "retailnext_schema_name",
"access_key": "your_access_key",
"subscription": "your_subscription",
"secret_key": "your_secret_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_key | Your RetailNext access key. |
subscription | Your RetailNext subscription. |
secret_key | Your RetailNext secret key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
access_key,subscriptionandsecret_key. - By using the Connect Card or the Fivetran dashboard.
Retently Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "retently",
"group_id": "target_group_id",
"config": {
"schema": "retently_schema_name",
"api_token": "your_retently_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Retently API token. |
Authorization
There are two ways to authorize this connector type:
- When creating the connector, by specifying a value for the following field in the request:
api_token. - After creating the connector, by using the Connect Card or the Fivetran dashboard.
RingCentral
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ringcentral",
"group_id": "target_group_id",
"config": {
"schema": "test_ringcentral"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying a value for
access_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "ringcentral", "group_id": "target_group_id", "config": { "schema": "test_ringcentral" }, "auth": { "access_token": "my_access_token" } }Auth parameters
Name Description access_tokenThe long-lived Access tokencarries the information necessary to access API resources.TIP: For instructions to generate the
access_token, see RingCentral's documentation.By using the Connect Card or through the Fivetran dashboard.
Revel Systems Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "revel",
"group_id": "target_group_id",
"config": {
"schema": "revel_systems_schema_name",
"sub_domain": "your_revel_systems_sub_domain",
"api_key_api_secret": "your_revel_systems_api_key_api_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Revel Systems subdomain. |
api_key_api_secret | Your Revel Systems API key and API secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domainandapi_key_api_secret. - By using the Connect Card or the Fivetran dashboard.
RevenueCat Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "revenuecat",
"group_id": "target_group_id",
"config": {
"schema": "revenuecat_schema_name",
"api_key": "your_revenuecat_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your RevenueCat API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
REVIEWS.ai Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "reviewsai",
"group_id": "target_group_id",
"config": {
"schema": "reviewsai_schema_name",
"api_token": "your_reviewsai_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your REVIEWS.ai API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
REVIEWS.io Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "reviewsio",
"group_id": "target_group_id",
"config": {
"schema": "reviewsio_schema_name",
"api_key": "your_reviewsio_api_key",
"store_id": "your_reviewsio_store_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your REVIEWS.io API key. |
store_id | Your REVIEWS.io store ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandstore_id. - By using the Connect Card or the Fivetran dashboard.
RevOps Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "revops",
"group_id": "target_group_id",
"config": {
"schema": "revops_schema_name",
"api_key": "revops_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your RevOps API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
RevX Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "revx",
"group_id": "target_group_id",
"config": {
"schema": "revx_schema_name",
"username": "your_revx_username",
"password": "your_revx_password_hash"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your RevX username. |
password | The MD5 hash of your RevX password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Ricochet360 Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ricochet360",
"group_id": "target_group_id",
"config": {
"schema": "ricochet360_schema_name",
"api_key": "your_ricochet360_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Ricochet360 API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Ringover Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ringover",
"group_id": "target_group_id",
"config": {
"schema": "ringover_schema_name",
"api_key": "your_ringover_api_key",
"region": "your_ringover_account_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Ringover API key. |
region | Your Ringover account's host region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
api_keyandregionfields in the request. - By using the Connect Card or the Fivetran dashboard.
Rippling Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rippling",
"group_id": "target_group_id",
"config": {
"schema": "rippling_schema_name",
"api_key": "your_rippling_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Rippling API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Rithum
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rithum",
"group_id": "target_group_id",
"config": {
"schema": "rithum_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessparameter in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "rithum", "group_id": "target_group_id", "config": { "schema": "rithum_schema_name" }, "auth": { "client_access": { "client_id": "your_rithum_client_id", "client_secret": "your_rithum_client_secret" } } }Auth parameters
Name Description client_access.client_idYour Rithum Client ID. client_access.client_secretYour Rithum Client Secret. By using the Connect Card or the Fivetran dashboard.
Rocketlane Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rocketlane",
"group_id": "target_group_id",
"config": {
"schema": "rocketlane_schema_name",
"api_key": "your_rocketlane_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Rocketlane API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Rokt Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rokt",
"group_id": "target_group_id",
"config": {
"schema": "rokt_schema_name",
"account_id": "your_rokt_account_id",
"app_id": "your_rokt_app_id",
"app_secret": "your_rokt_app_secret",
"currency": "your_rokt_currency",
"time_zone_variation": "your_rokt_time_zone_variation",
"historical_sync_time_frame": "your_rokt_historical_sync_time_frame"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
account_id | Your Rokt account ID. |
app_id | Your Rokt app ID. |
app_secret | Your Rokt app secret. |
currency | Your Rokt currency. |
time_zone_variation | Your Rokt time zone variation. |
historical_sync_time_frame | Your Rokt historical sync time frame. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
account_id,app_id,app_secret,currency,time_zone_variationandhistorical_sync_time_frame. - By using the Connect Card or the Fivetran dashboard.
Rollbar Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rollbar",
"group_id": "target_group_id",
"config": {
"schema": "rollbar_schema_name",
"project_access_token": "your_rollbar_project_access_token",
"account_access_token": "your_rollbar_account_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
project_access_token | Your Rollbar project access token. |
account_access_token | Your Rollbar account access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
project_access_tokenandaccount_access_tokenfields in the request. - By using the Connect Card or the Fivetran dashboard.
Rootly Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rootly",
"group_id": "target_group_id",
"config": {
"schema": "rootly_schema_name",
"api_key": "your_rootly_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Rootly API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
RTB House Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rtb_house",
"group_id": "target_group_id",
"config": {
"schema": "rtb_house_schema_name",
"username": "your_rtb_house_username",
"password": "your_rtb_house_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your RTB House username. |
password | Your RTB House password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Ruddr Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ruddr",
"group_id": "target_group_id",
"config": {
"schema": "ruddr_schema_name",
"api_key": "your_ruddr_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key | Your Ruddr API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Rundeck Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "rundeck",
"group_id": "target_group_id",
"config": {
"schema": "rundeck_schema_name",
"api_token": "your_rundeck_api_token",
"sub_domain": "your_rundeck_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_token | Your Rundeck API token. |
sub_domain | Your Rundeck subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_tokenandsub_domain. - By using the Connect Card or the Fivetran dashboard.
SafeBase Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "safebase",
"group_id": "target_group_id",
"config": {
"schema": "safebase_schema_name",
"api_key": "your_safebase_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your SafeBase API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
SafetyCulture Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "safetyculture",
"group_id": "target_group_id",
"config": {
"schema": "safetyculture_schema_name",
"api_token": "your_safetyculture_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your SafetyCulture API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - After creating the connector, by using the Connect Card or the Fivetran dashboard.
Sage HR Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sage_hr",
"group_id": "target_group_id",
"config": {
"schema": "sage_hr_schema_name",
"sub_domain": "your_sage_hr_sub_domain",
"api_key": "your_sage_hr_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Sage HR subdomain. |
api_key | Your Sage HR API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
sub_domainandapi_key. - By using the Connect Card or the Fivetran dashboard.
Sage Intacct
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sage_intacct",
"group_id": "target_group_id",
"config": {
"schema": "test_intacct",
"company_id": "your_intacct_company_id",
"user_id": "your_intacct_user_id",
"login_password": "xxxxxxxxxx",
"sender_id": "your_intacct_sender_id",
"sender_password": "your_intacct_sender_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
company_id | Your company ID that is used to set up the Sage Intacct instance. It is a part of the Sage Intacct instance's login credentials. |
user_id | Your Sage Intacct user ID. It is a part of the login credentials. |
login_password | The login password. It is a part of the login credentials. |
sender_id | Your Sage Intacct sender ID. |
sender_password | Your Sage Intacct sender password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
company_id,user_idandlogin_password. - By using the Connect Card or the Fivetran dashboard.
Sailthru
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sailthru",
"group_id": "target_group_id",
"config": {
"schema": "sailthru",
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"api_secret": "your_api_secret",
"packing_mode": "packing_mode_for_custom_fields",
"s3_role_arn": "your_s3_role_arn",
"s3_bucket": "your_s3_bucket",
"historic_sync_time_frame": "your_preferred_range"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
api_key | The Sailthru API key. | |
api_secret | The Sailthru API secret. | |
packing_mode | The packing mode for the custom fields of the LIST_STAT and USER tables. Default value: UNPACKED | UNPACKED, PACKED |
s3_bucket | Name of the S3 bucket configured to receive Sailthru Connect data. | |
s3_role_arn | ARN of the IAM role created for Fivetran. | |
historic_sync_time_frame | Range of historical data you would like to include in the initial sync. Default value: ALL_TIME. | THREE_MONTHS, SIX_MONTHS, ONE_YEAR, TWO_YEARS, FIVE_YEARS, ALL_TIME |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandapi_secret. - By using the Connect Card or the Fivetran dashboard.
Salesforce
Request
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.
Use salesforce_sandbox service name for sandbox account or salesforce service name for production account.
POST https://api.fivetran.com/v1/connectors
{
"service": "salesforce",
"group_id": "target_group_id",
"config": {
"schema": "salesforce",
"base_url": "https://base_url.salesforce.com",
"sync_formula_fields": false,
"authentication_method": "STANDARD",
"certificate": "---",
"private_key": "---"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. | |
base_url | The custom Salesforce domain. Ensure that the base_url starts with https://. | |
sync_formula_fields | (Optional) Sync formula fields (default value = false). | true, false |
authentication_method | (Optional) Authentication type (default value = STANDARD) | STANDARD, ADVANCED |
certificate | Provide content of the .pem certificate (only when authentication_method = ADVANCED). | String, Base64 encoded |
private_key | Provide content of the .key private key (only when authentication_method = ADVANCED). | String, Base64 encoded |
NOTE: You can also retrieve connecting user details such as
connecting_user,connecting_user_emailandorganization_idin the config section while retrieving connector details. These fields areread-only, and we cannot provide them in a POST request. We populate these fields only after the initial sync has completed.
Authorization
There are three ways to authorize this connector type:
STANDARDauthentication:By specifying
authentication_methodasSTANDARDand the values for theclient_accessandrefresh_tokenfields in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "salesforce", "group_id": "target_group_id", "config": { "schema": "salesforce", "authentication_method": "STANDARD", "base_url": "https://base_url.salesforce.com", "sync_formula_fields": false }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient ID of your Salesforce client application. client_secretClient secret of your Salesforce client application. refresh_tokenThe long-lived Refresh token, along with theclient_idandclient_secretparameters, carry the information necessary to get a new access token for API resources.ADVANCEDauthentication Private Preview:By specifying
authentication_methodasADVANCEDalong with the values for thecertificate,private_key,base_urlfields and the values for theclient_accessfields in the auth section.POST https://api.fivetran.com/v1/connectors{ "service": "salesforce", "group_id": "target_group_id", "config": { "schema": "salesforce", "authentication_method": "ADVANCED", "base_url": "https://base_url.salesforce.com", "certificate": "---", "private_key": "---", "sync_formula_fields": false }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" } } }Auth parameters
Configure the connected app mentioned below, for OAuth2.0 client-credential flow, as per our Advanced authentication setup guide.
Name Description client_idConsumer key for your configured connected app. client_secretConsumer secret for your configured connected app. refresh_tokenNULL , refresh_tokenis not involved in this flow.AWS PrivateLink
To create a connector with AWS PrivateLink for Salesforce, by specifying
networking_methodasPrivateLink(default value =Directly) andbase_urlas_custom domain name_as mentioned in the configuration parameters above.POST https://api.fivetran.com/v1/connectors{ "service": "salesforce", "group_id": "target_group_id", "config": { "schema": "salesforce", "base_url": "https://base_url.salesforce.com" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" } } }By using the Connect Card or the Fivetran dashboard.
Salesforce Commerce Cloud
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "salesforce_commerce_cloud",
"group_id": "target_group_id",
"config": {
"schema": "test_sfcc",
"client_id": "your_client_id",
"client_secret": "your_api_secret",
"short_code": "your_short_code",
"site_id": "your_site_id",
"customer_list_id": "your_customer_list_id",
"organization_id": "organization_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | The Salesforce Commerce Cloud Client ID. |
client_secret | The Salesforce Commerce Cloud Client secret. |
short_code | The Salesforce eight-character string assigned to a realm for routing purposes. |
site_id | The name of the site from which you want to sync data. |
customer_list_id | The parameter to retrieve customer details. |
organization_id | The organization ID from Salesforce Commerce Cloud account. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,short_code,site_id,organization_idandcustomer_list_id. - By using the Connect Card or the Fivetran dashboard.
Salesforce Marketing Cloud
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "salesforce_marketing_cloud",
"group_id": "target_group_id",
"config": {
"schema": "test_sfmc",
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"client_secret": "your_api_secret",
"instance": "",
"is_new_package": "true",
"sub_domain": "http://your.sub.domain/",
"sync_mode": "SelectedEvents",
"selected_event_types": ["BounceEvent", "ClickEvent"],
"historic_sync_time_frame": "THREE_MONTHS"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
client_id | The Salesforce Marketing Cloud client ID. | |
client_secret | The Salesforce Marketing Cloud client secret. | |
instance | The Salesforce Marketing Cloud instance ID | s1, s4, s5, s6, s7, s8, s10, s50 |
is_new_package | Indicates that your installed package uses OAuth 2.0. Default value: false | true, false |
sub_domain | Your Salesforce Marketing Cloud subdomain. | |
sync_mode | Sync all events or specific event types. Default value: AllEvents. | AllEvents, SelectedEvents |
selected_event_types | Sync specific event types. Can be populated if sync_mode is set to SelectedEvents. | BounceEvent, ClickEvent, ForwardedEmailEvent, ForwardedEmailOptInEvent, OpenEvent, UnsubEvent, SurveyEvent, SentEvent |
historic_sync_time_frame | Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. | THREE_MONTHS, SIX_MONTHS, ONE_YEAR, TWO_YEARS, FIVE_YEARS, ALL_TIME |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret, andinstance. - By using the Connect Card or the Fivetran dashboard.
Salesloft
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "salesloft",
"group_id": "target_group_id",
"config": {
"schema": "test_salesloft"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "salesloft", "group_id": "target_group_id", "config": { "schema": "test_salesloft", "client_id": "my_client_id", "client_secret": "my_client_secret" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idApplication_Idof your Salesloft client application.client_secretSecretof your Salesloft client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Salsify Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "salsify",
"group_id": "target_group_id",
"config": {
"schema": "salsify_schema_name",
"api_key": "your_salsify_api_key",
"sub_domain": "your_salsify_organization_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Salsify API key. |
sub_domain | Your Salsify organization ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_keyandsub_domain. - By using the Connect Card or the Fivetran dashboard.
Samsara Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "samsara",
"group_id": "target_group_id",
"config": {
"schema": "samsara_schema_name",
"region": "your_samsara_account_region",
"access_token": "your_samsara_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
region | The region of your Samsara account. For instance, if your region is EUROPE, provide eu.samsara in the Region field. If your region is not in Europe, provide samsara. |
access_token | Your Samsara API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Sana Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sana",
"group_id": "target_group_id",
"config": {
"schema": "sana_schema_name",
"subdomain": "sana_subdomain",
"client_id": "sana_client_id",
"client_secret": "sana_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your Sana subdomain. |
client_id | Your Sana client ID. |
client_secret | Your Sana client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for following fields in the request:
subdomain,client_id, andclient_secret. - By using the Connect Card or the Fivetran dashboard.
SAP Business ByDesign
Request
POST api.fivetran.com/v1/connectors
{
"service": "sap_business_by_design",
"group_id": "target_group_id",
"config": {
"schema": "test_sap_business_bydesign",
"username" : "your_sap_business_bydesign_username",
"password" : "your_sap_business_bydesign_password",
"instance_url": "your_sap_business_bydesign_instance_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | The SAP Business ByDesign username. |
password | The SAP Business ByDesign password. |
instance_url | The SAP Business ByDesign instance URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,password, andinstance_url. - By using the Connect Card or the Fivetran dashboard.
SAP Concur
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "concur",
"group_id": "target_group_id",
"config": {
"schema": "test_sap_concur",
"auth_mode": "PasswordGrant",
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
"client_secret": "your_application_secret",
"username": "your_sap_concur_username",
"login_password": "your_login_password",
"company_uuid": "your_company_uuid",
"company_request_token": "your_company_request_token",
"region": "your_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
auth_mode | The SAP Concur authentication method. |
client_id | The SAP Concur Client ID. |
client_secret | The SAP Concur Client secret. |
username | The SAP Concur username. This is applicable if AuthMode is PasswordGrant |
login_password | The SAP Concur password. This is applicable if AuthMode is PasswordGrant |
company_uuid | The SAP Concur UUID. This is applicable if AuthMode is CompanyLevel |
company_request_token | The SAP Concur Company Request Token. This is applicable if AuthMode is CompanyLevel |
region | The region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,username,login_password, andregion. - By using the Connect Card or the Fivetran dashboard.
SAP HANA In Dev
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sap_hana",
"group_id": "target_group_id",
"config": {
"schema": "test_sap_hana",
"host": "sap_hana_host",
"port": 1521,
"database": "sap_hana_database",
"user": "sap_hana_user",
"password": "sap_hana_password",
"test_table_name": "sap_hana_test_table_name",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
host | The SAP HANA host or IP address. |
port | The SAP HANA port number. |
user | Your SAP HANA user name. |
password | Your SAP HANA password. |
database | The database name. |
testTableName | The table name to test the connection. By default, we use the T503K table. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,user,password,database,testTableName,tunnel_host,tunnel_port, andtunnel_user. - By using the Connect Card or the Fivetran dashboard.
SAP SuccessFactors Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sap_success_factors",
"group_id": "target_group_id",
"config": {
"client_id": "sap_success_factors_client_id",
"client_secret": "sap_success_factors_client_secret",
"company_id": "sap_success_factors_company_id",
"sub_domain": "http://your.sub.domain"
}
}
Config parameters
| Name | Description |
|---|---|
client_id | Your SAP SuccessFactors Client ID. |
client_secret | Your SAP SuccessFactors Client Secret which you generated through SAML Assertion. |
company_id | Your SAP SuccessFactors Company ID. |
sub_domain | Your SAP SuccessFactors Subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,company_id,client_id, andclient_secret. - By using the Connect Card or the Fivetran dashboard.
SAP S/4 In Dev
IMPORTANT: We have disabled new connector creation using our REST API.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sap_s4hana",
"group_id": "target_group_id",
"config": {
"schema": "test_sap_s4",
"host": "sap_s4_host",
"port": 1521,
"database": "sap_s4_database",
"user": "sap_s4_user",
"password": "sap_s4_password",
"test_table_name": "sap_s4_test_table_name",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
host | The SAP S/4 host or IP address. |
port | The SAP S/4 port number. |
user | Your SAP S/4 user name. |
password | Your SAP S/4 password. |
database | The database name. |
testTableName | The table name to test the connection. By default, we use the T503K table. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,user,password,database,testTableName,tunnel_host,tunnel_portandtunnel_user. - By using the Connect Card or the Fivetran dashboard.
SCORM Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "scorm",
"group_id": "target_group_id",
"config": {
"schema": "scorm_schema_name",
"username": "your_scorm_app_id",
"password": "your_scorm_secret_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your SCORM App ID. |
password | Your SCORM Secret Key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Security Journey Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "security_journey",
"group_id": "target_group_id",
"config": {
"schema": "security_journey",
"api_key": "your_security_journey_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Security Journey API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Segment
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "segment",
"group_id": "target_group_id",
"config": {
"schema": "test_segment_webhook",
"sync_type": "Webhook"
}
}
{
"service": "segment",
"group_id": "target_group_id",
"config": {
"schema": "test_segment_s3",
"sync_type": "S3",
"prefix": "prefix",
"bucket": "bucket",
"role_arn": "role_arn"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sync_type | The Segment connector sync type. | Webhook, S3 |
prefix | Folder path to the Segment files within the bucket. Must be populated if sync_type is set to S3. | |
bucket | The name of the Segment bucket. Must be populated if sync_type is set to S3. | |
role_arn | The Role ARN required for authentication. Must be populated if sync_type is set to S3. |
Authorization
There are three ways to authorize this connector type:
- By specifying the values for the following fields in the request:
prefix,bucket, androle_arn, ifsync_typeis set toS3. - By specifying the field
sync_typeaswebhook, if you are connecting using only webhooks. - By using the Connect Card or the Fivetran dashboard.
SendGrid
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sendgrid",
"group_id": "target_group_id",
"config": {
"schema": "test_sendgrid",
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | The SendGrid API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Sensor Tower Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sensor_tower",
"group_id": "target_group_id",
"config": {
"schema": "sensor_tower_schema_name",
"api_token": "your_sensor_tower_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Sensor Tower API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
ServiceNow
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "servicenow",
"group_id": "target_group_id",
"config": {
"schema": "stripe_schema",
"instance": "instance_id",
"client_id": "client_id",
"client_secret": "client_secret",
"username": "username",
"password": "password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
instance | ServiceNow Instance ID. |
client_id | ServiceNow Client ID. |
client_secret | ServiceNow Client Secret. |
username | Your ServiceNow User ID (username). |
password | Your account password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
instance,client_id,client_secret,usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
ServiceTitan Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "servicetitan",
"group_id": "target_group_id",
"config": {
"schema": "servicetitan_schema_name",
"client_id": "your_servicetitan_client_id",
"client_secret": "your_servicetitan_client_secret",
"environment": "your_servicetitan_environment",
"tenant_id": "your_servicetitan_tenant_id",
"app_key": "your_servicetitan_app_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your ServiceTitan client ID. |
client_secret | Your ServiceTitan client secret. |
environment | Your ServiceTitan environment. |
tenant_id | Your ServiceTitan tenant ID. |
app_key | Your ServiceTitan app key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,environment,tenant_id, andapp_key. - By using the Connect Card or the Fivetran dashboard.
SFTP
The connector supports two sync strategies:
Magic Folder Request
To use the Magic Folder sync strategy, specify the is_single_table_mode parameter as false. If you don't specify the parameter, we will use the default Merge Mode sync strategy to sync files.
POST https://api.fivetran.com/v1/connectors
{
"service": "sftp",
"group_id": "target_group_id",
"config": {
"is_single_table_mode": "false",
"schema": "test_sftp",
"connection_method": "direct",
"is_keypair": "false",
"password": "password",
"user": "user_name",
"host": "sftp.company.com",
"port": "22",
"prefix": "folder_path"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
is_single_table_mode (required as false) | Allows the creation of connector using the specified Sync strategy. | true, false |
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
connection_method | The connection method used to connect to SFTP Server. | direct, sshTunnel |
is_keypair | Whether to use a key pair for authentication. When true, do not use password. | true, false |
password | Your SFTP server password. | |
user | Your SFTP server username. | |
host | Your SFTP server host address. | |
port | Your SFTP server port. | |
tunnel_user | SSH tunnel username. Specify only to connect using an SSH tunnel. | |
tunnel_host | SSH tunnel host address. Specify only to connect using an SSH tunnel. | |
tunnel_port | SSH tunnel port. Specify only to connect using an SSH tunnel. | |
prefix | All files and folders under this folder path will be searched for files to sync. |
NOTE: You can find the SFTP Server Public Key and SSH Tunnel Public Key for your group in the SFTP setup form.
Merge Mode Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sftp",
"group_id": "target_group_id",
"config": {
"is_single_table_mode": "true",
"schema": "test_sftp",
"table": "table_name",
"connection_method": "direct",
"is_keypair": "false",
"password": "password",
"user": "user_name",
"host": "sftp.company.com",
"port": "22",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "csv",
"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",
"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": ";"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
is_single_table_mode | Allows the creation of connector using the specified Sync strategy. | true, false |
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
connection_method | The connection method used to connect to SFTP Server. | direct, sshTunnel |
is_keypair | Whether to use a key pair for authentication. When true, do not use password. | true, false |
password | Your SFTP server password. | |
user | Your SFTP server username. | |
host | Your SFTP server host address. | |
port | Your SFTP server port. | |
tunnel_user | SSH tunnel username. Specify only to connect using an SSH tunnel. | |
tunnel_host | SSH tunnel host address. Specify only to connect using an SSH tunnel. | |
tunnel_port | SSH tunnel port. Specify only to connect using an SSH tunnel. | |
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. | csv, json, tsv, avro, jsonl, log, parquet, xml |
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_pption | If you know that the source completely overwrites 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. | |
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. | |
use_pgp_encryption_options | Set to true if files present in the SFTP server 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. |
NOTE: You can find the SFTP Server Public Key and SSH Tunnel Public Key for your group in the SFTP setup form.
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,userandpassword. - By using the Connect Card or the Fivetran dashboard.
SharePoint
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 Request
POST https://api.fivetran.com/v1/connectors
{
"service": "share_point",
"group_id": "target_group_id",
"config": {
"schema": "test_share_point",
"share_url": "target_folder_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema has to be unique within the destination. Required for connector creation. |
share_url | Your SharePoint folder URL. You can find the folder URL by following the steps mentioned in the SharePoint Setup Guide. |
Merge Mode Request
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": "share_point",
"group_id": "target_group_id",
"config": {
"schema": "test_share_point",
"table": "test_table",
"prefix": "folder_link_url",
"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": ";"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema (required) | The connector schema name has to be unique within the 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 link will be searched for files to sync. This can be any shared folder link. | |
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. | csv, json, tsv, avro, jsonl, log, parquet, xml, spreadsheet, infer |
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 overwrites 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. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "share_point", "group_id": "target_group_id", "config": { "schema": "test_share_point", "share_url": "target_share_url" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Microsoft client application.client_secretClient Secretof your Microsoft client application.refresh_tokenThe long-lived Refresh token carries the information necessary to get a new access token for API resources. By using the Connect Card or the Fivetran dashboard.
Sharetribe Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sharetribe",
"group_id": "sharetribe_group_id",
"config": {
"schema": "sharetribe_schema_name",
"client_id": "your_sharetribe_client_id",
"client_secret": "your_sharetribe_client_secret",
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Sharetribe client ID. |
client_secret | Your Sharetribe client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
ShipHero Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "shiphero",
"group_id": "target_group_id",
"config": {
"schema": "shiphero_schema_name",
"username": "your_shiphero_username",
"password": "your_shiphero_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your ShipHero username. |
password | Your ShipHero password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
ShipNetwork Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "shipnetwork",
"group_id": "target_group_id",
"config": {
"schema": "shipnetwork_schema_name",
"client_id": "your_shipnetwork_client_id",
"api_user_identifier": "your_shipnetwork_api_user_identifier",
"api_user_secret": "your_shipnetwork_api_user_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your ShipNetwork client ID. |
api_user_identifier | Your ShipNetwork API user identifier. |
api_user_secret | Your ShipNetwork API user secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,api_user_identifier, andapi_user_secret. - By using the Connect Card or the Fivetran dashboard.
ShipStation Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "shipstation",
"group_id": "target_group_id",
"config": {
"schema": "shipstation_schema_name",
"username": "your_shipstation_username",
"password": "your_shipstation_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your ShipStation username. |
password | Your ShipStation password. |
Shopify
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "shopify",
"group_id": "target_group_id",
"config": {
"schema": "shopify_schema",
"shop": "shop_name"
}
}
Config parameter
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
shop | The Shopify shop name. Can be found in the URL before .myshopify.com. |
Authorization
There are two ways to authorize this connector type:
By specifying a value for
access_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "shopify", "group_id": "target_group_id", "config": { "schema": "test_shopify", "shop": "my_shop" }, "auth": { "access_token" : "my_access_token" } }Auth parameter
Name Description access_tokenThe Shopify access token. By using the Connect Card or the Fivetran dashboard.
Shopware Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "shopware",
"group_id": "target_group_id",
"config": {
"schema": "shopware_schema_name",
"domain": "your_shopware_domain",
"username": "your_shopware_username",
"password": "your_shopware_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
domain | Your Shopware domain. |
username | Your Shopware username. |
password | Your Shopware password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
domain,username, andpassword. - By using the Connect Card or the Fivetran dashboard.
Short.io Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "shortio",
"group_id": "target_group_id",
"config": {
"schema": "shortio_schema_name",
"api_key": "your_shortio_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Short.io API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Shortcut Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "shortcut",
"group_id": "target_group_id",
"config": {
"schema": "shortcut_schema_name",
"api_token": "your_shortcut_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Shortcut API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Sigma Computing Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sigma_computing_source",
"group_id": "target_group_id",
"config": {
"schema": "sigma_computing_schema_name",
"client_id": "your_sigma_computing_client_id",
"client_secret": "your_sigma_computing_client_secret",
"api_server": "your_sigma_computing_api_server"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Sigma Computing client ID. |
client_secret | Your Sigma Computing client secret. |
api_server | Your Sigma Computing API server. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret, andapi_server. - By using the Connect Card or the Fivetran dashboard.
Simplecast Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "simplecast",
"group_id": "target_group_id",
"config": {
"schema": "simplecast_schema_name",
"api_token": "your_simplecast_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Simplecast API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Simplesat Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "simplesat",
"group_id": "target_group_id",
"config": {
"schema": "simplesat_schema_name",
"account_key": "your_simplesat_account_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
account_key | Your Simplesat account key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
account_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
SingleStore Partner-Built In Dev
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "singlestore_source",
"group_id": "target_group_id",
"config": {
"schema": "singlestore_schema_name",
"host": "host",
"port": "port",
"database": "database",
"table": "table",
"user": "user_name",
"password": "password",
"driver.parameters": "additional_driver_parameters",
"ssl.mode": "ssl_configuration_parameters",
"ssl.server.cert": "ssl_server_certificate"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
host | The database host name. |
port | The port number. |
database | The database name. |
table | The table name. |
user | The user name. |
password | The password. |
driver.parameters | (Optional) Additional driver parameters. Eg: "cachePrepStmts = TRUE; allowMultiQueries= TRUE; connectTimeout = 20000" |
ssl.mode | (Optional) Enable SSL and specify related configuration parameters. |
ssl.server.cert | (Optional) The SSL server certificate. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,database,table,user,passwordand, optionally,driver.parameters,ssl.modeandssl.server.cert. - By using the Connect Card or the Fivetran dashboard.
SISTRIX Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sistrix",
"group_id": "target_group_id",
"config": {
"schema": "sistrix_schema_name",
"domain": "your_domain",
"api_key": "your_sistrix_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
domain | Your SISTRIX domain. |
api_key | Your SISTRIX API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
domainandapi_key. - By using the Connect Card or the Fivetran dashboard.
SkuVault Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "skuvault",
"group_id": "target_group_id",
"config": {
"schema": "skuvault_schema_name",
"email": "your_skuvault_email",
"password": "your_skuvault_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
email | Your SkuVault email. |
password | Your SkuVault password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
emailandpassword. - By using the Connect Card or the Fivetran dashboard.
Skilljar Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "skilljar",
"group_id": "target_group_id",
"config": {
"schema": "skilljar_schema_name",
"api_key": "your_skilljar_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Skilljar API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
SkillsTX Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "skillstx",
"group_id": "target_group_id",
"config": {
"schema": "skillstx_schema_name",
"client_id": "your_skillstx_client_id",
"client_secret": "your_skillstx_client_secret",
"subdomain": "your_skillstx_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your SkillsTX client ID. |
client_secret | Your SkillsTX client secret. |
subdomain | Your SkillsTX subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret, andsubdomain. - By using the Connect Card or the Fivetran dashboard.
Slab Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "slab",
"group_id": "target_group_id",
"config": {
"schema": "slab_schema_name",
"access_token": "your_slab_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your Slab access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Slack
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "slack",
"group_id": "target_group_id",
"config": {
"schema": "slack_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
authsection:client_access,refresh_token, andaccess_token.POST https://api.fivetran.com/v1/connectors{ "service": "slack", "group_id": "target_group_id", "config": { "schema": "slack_schema_name" }, "auth": { "client_access": { "client_id": "slack_client_id", "client_secret": "slack_client_secret" }, "refresh_token": "slack_refresh_token", "access_token": "slack_access_token" } }Auth parameters
Name Description client_access.client_idYour Slack Client ID. client_access.client_secretYour Slack Client Secret. refresh_tokenYour Slack refresh token. access_tokenYour Slack access token. By using the Connect Card or the Fivetran dashboard.
Smadex Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "smadex",
"group_id": "target_group_id",
"config": {
"schema": "smadex_schema_name",
"email": "your_smadex_email",
"password": "your_smadex_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
email | Your Smadex account's email ID. |
password | Your Smadex account's password. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the following fields in the request:
emailandpassword. - By using the Connect Card or the Fivetran dashboard.
SmartHR Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "smarthr",
"group_id": "smarthr_group_id",
"config": {
"schema": "smarthr_schema_name",
"subdomain": "your_smarthr_subdomain",
"environment": "your_smarthr_environment",
"bearer_token": "your_smarthr_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your SmartHR subdomain. |
environment | Your SmartHR environment. |
bearer_token | Your SmartHR access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
subdomain,environment, andbearer_token. - By using the Connect Card or the Fivetran dashboard.
SmartRecruiters Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "smartrecruiters",
"group_id": "target_group_id",
"config": {
"schema": "smartrecruiters_schema_name",
"client_id": "smartrecruiters_client_id",
"client_secret": "smartrecruiters_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id | Your SmartRecruiters client ID. |
client_secret | Your SmartRecruiters client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Smartwaiver Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "smartwaiver",
"group_id": "target_group_id",
"config": {
"schema": "smartwaiver_schema_name",
"api_key": "your_smartwaiver_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Smartwaiver API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Snapchat Ads
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "snapchat_ads",
"group_id": "target_group_id",
"config": {
"schema": "test_snapchat_ads",
"sync_mode": "SpecificOrganizations",
"organizations": ["abc","cde","def"],
"swipe_attribution_window": "DAY_7",
"view_attribution_window": "HOUR_3",
"timeframe_months": "THREE",
"custom_reports": [
{
"report_name": "some_report_name",
"granularity": "DAY",
"base_metrics_fields": ["core", "swipes"],
"add_metric_variants": true,
"skad_metrics_fields": ["conversion_searches_sk_ad_network_total", "custom_event_1_sk_ad_network"],
"breakdown": "CAMPAIGN",
"breakout": "total",
"dimension": "COUNTRY"
}
]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sync_mode | Whether to sync all organizations or specific organizations. Default value: AllOrganizations. | AllOrganizations, SpecificOrganizations |
organizations | Specific organizations IDs to sync. Must be populated if syncMode is set to SpecificOrganizations. | |
swipe_attribution_window | The time period to attribute conversions based on swipes. Default value: DAY_28 | DAY_1, DAY_7, DAY_28 |
view_attribution_window | The time period to attribute conversions based on views. Default value: DAY_1 | HOUR_1, HOUR_3, HOUR_6, DAY_1, DAY_7, DAY_28 |
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 |
custom_reports | List of custom reports. Optional | |
report_name | Custom report name | |
granularity | Custom report granularity | HOUR, DAY |
base_metrics_fields | List of base metrics included into custom report | |
add_metric_variants | Boolean defining whether optional fields corresponding to separate Swipe-Up and View variants of selected metrics are included into report. Default value is false. | true, false |
skad_metrics_fields | List of SKAd metrics included into custom report | |
breakdown | Custom report breakdown | CAMPAIGN, AD, AD_SQUAD |
breakout | Custom report breakout | total, web, app, offline, total_off_platform, total_on_platform |
dimension | Custom report dimension | COUNTRY, REGION, DMA, DEVICE_OS, DEVICE_MAKE, DEMOGRAPHIC, INTEREST |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "snapchat_ads", "group_id": "target_group_id", "config": { "schema": "test_snapchat_ads", "sync_mode": "SpecificOrganizations", "organizations": ["abc","cde","def"], "swipe_attribution_window": "DAY_7", "view_attribution_window": "HOUR_3", "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Snapchat Ads client application.client_secretClient Secretof your Snapchat Ads client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or through the Fivetran dashboard.
Snyk Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "snyk",
"group_id": "target_group_id",
"config": {
"schema": "snyk_schema_name",
"api_token": "your_snyk_api_token",
"region": "your_snyk_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Snyk API token. |
region | Your Snyk region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_tokenandregion. - By using the Connect Card or the Fivetran dashboard.
Snowflake
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "snowflake_db",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_snowflake_db",
"auth": "password",
"host": "host",
"database": "database",
"user": "user",
"password": "password",
"connectionType": "Directly",
"passphrase": "passphrase",
"private_key": "privateKey",
"is_private_key_encrypted": true,
"role": "role"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. | |
auth | Password-based or key-based authentication type. | |
host | The Snowflake service host address. | |
port | The Snowflake service host port. | |
database | The Snowflake database name. | |
user | The Snowflake username. | |
password | The Snowflake user's password. | |
passphrase | The passphrase used to encrypt the private key. Must be populated if is_private_key_encrypted is set to true. | |
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----). | |
is_private_key_encrypted | Whether the private key is encrypted. | true, false |
role | The Snowflake user's role. | |
update_method | Default value: Teleport. | Teleport, Time Travel |
Authorization
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Snowplow
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "snowplow",
"group_id": "target_group_id",
"config": {
"schema": "schema_name",
"enable_enrichments": "false",
"config_repository_url": "configRepositoryURL"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
enable_enrichments | To sync events with or without enrichments. | true, false |
config_repository_url | The public repository URL containing JSON configuration files. |
Initial Configuration
Copy the code snippet into the <head> section of your web page.
Authorization
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
SolarWinds Service Desk Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "solarwinds_service_desk",
"group_id": "target_group_id",
"config": {
"schema": "solarwinds_service_desk_schema_name",
"domain": "your_solarwinds_service_desk_domain",
"token": "your_solarwinds_service_desk_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
domain | Your SolarWinds Service Desk domain. |
token | Your SolarWinds Service Desk token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
domainandtoken. - By using the Connect Card or the Fivetran dashboard.
SonarQube Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sonarqube",
"group_id": "target_group_id",
"config": {
"schema": "sonarqube_schema_name",
"subdomain": "your_sonarqube_subdomain",
"user_token": "your_sonarqube_user_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your SonarQube subdomain. |
user_token | Your SonarQube user token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
subdomainanduser_token. - By using the Connect Card or the Fivetran dashboard.
SparkPost Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sparkpost",
"group_id": "target_group_id",
"config": {
"schema": "sparkpost_schema_name",
"api_key": "your_sparkpost_api_key",
"host_url": "your_sparkpost_host_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your SparkPost API key. |
host_url | Your SparkPost host URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandhost_url. - By using the Connect Card or the Fivetran dashboard.
Splash Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "splash",
"group_id": "target_group_id",
"config": {
"schema": "splash_schema_name",
"client_id": "your_splash_client_id",
"client_secret": "your_splash_client_secret",
"username": "your_splash_username",
"password": "your_splash_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Splash client ID. |
client_secret | Your Splash client secret. |
username | Your Splash username. |
password | Your Splash password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,username, andpassword. - By using the Connect Card or the Fivetran dashboard.
Split Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "splitio",
"group_id": "target_group_id",
"config": {
"schema": "split_schema_name",
"admin_api_key": "your_split_admin_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
admin_api_key | Your Split Admin API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value of the
admin_api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Splunk Beta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "splunk",
"group_id": "target_group_id",
"config": {
"schema": "schema",
"host": "host",
"port": 8089,
"user": "user",
"password": "password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
host | The Splunk service host address. |
port | The Splunk service host port. |
user | The Splunk username. |
password | The Splunk user's password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,userandpassword. - By using the Connect Card or the Fivetran dashboard.
SQL Server
Fivetran supports a few different incarnations of SQL Server. Each type of connector has its own service value:
- Azure -
"service": "azure_sql_db" - Azure Managed Instance -
"service": "azure_sql_managed_db" - Generic SQL Server -
"service": "sql_server" - Google Cloud -
"service": "google_cloud_sqlserver" - RDS -
"service": "sql_server_rds"
Check out our setup guide for your type of connector.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sql_server",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_sql",
"host": "sqlinstance.mycompany.com",
"port": 1433,
"database": "sqldb",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"update_method": "NATIVE_UPDATE"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The user name. For Azure Databases, the format must be user@domain. |
password | The user's password. |
database | The database name. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
update_method | (Optional) The incremental sync method the connector will use. The possible values are "TELEPORT" or "NATIVE_UPDATE". The type defaults to "NATIVE_UPDATE" if the value is set to null or not specified. |
Authorization
There are three ways to authorize this connector type:
By specifying the values for the following fields in the request:
host,port,password,useranddatabase.For
azure_sql_dbandazure_sql_managed_dbservice types: by specifying the values of thetenant_idin theconfigsection,access_tokenandrefresh_tokenparameters in theauthsection:POST https://api.fivetran.com/v1/connectors{ "service": "azure_sql_db | azure_sql_managed_db", "group_id": "target_group_id", "config": { "schema_prefix": "azure_sql", "auth_method": "ActiveDirectory", "tenant_id": "your_tenant_id" }, "auth": { "access_token": "my_access_token", "refresh_token": "my_refresh_token" } }Auth parameters
Name Description auth_methodAuthorization method. tenant_idMicrosoft Entra ID (formerly Azure Active Directory) tenant ID. access_tokenThe long-lived Access token carries the information necessary to access API resources. refresh_tokenThe long-lived Refresh token carries the information necessary to get a new access token for API resources. By using the Connect Card or the Fivetran dashboard.
High-Volume Agent SQL Server
Fivetran supports a few different incarnations of High-Volume Agent SQL Server. Each type of connector has its own service value:
- High-Volume Agent SQL Server -
"service": "sql_server_hva" - High-Volume Agent SAP ECC on SQL Server -
"service": "sql_server_sap_ecc_hva"
POST https://api.fivetran.com/v1/connectors
{
"service": "sql_server_hva",
"group_id": "target_group_id",
"config": {
"schema_prefix": "sql_server_hva_example",
"host": "host.com",
"port": 1433,
"database": "oracledb",
"pdb_name": "pdb_name",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"always_encrypted": true,
"agent_host": "host.com",
"agent_port": 4343,
"agent_user": "hvr",
"agent_password": "agent_password",
"agent_public_cert": "CERTIFICATE",
"update_method": "NATIVE_UPDATE"
}
}
Config parameters
| Name | Description |
|---|---|
schema_prefix | The connector schema prefix has to be unique within the destination. Required for connector creation. |
host | DB instance host or IP address. |
port | The port number. |
user | The user name. For Azure Databases, the format must be user@domain. |
password | The user's password. |
database | The database name. |
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 using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
agent_host | The host address of the machine running the agent. Often the same as the DB host. |
agent_port | The port that the agent has open for Fivetran's connection. Default value is 4343. |
agent_user | The agent's username. |
agent_password | The password for the agent user. |
agent_public_cert | The public certificate generated by the agent. |
sap_schema | SAP Schema Name. Required only for High-Volume Agent SAP ECC connector. |
update_method | (Optional) The incremental sync method the connector will use. The possible values are "TELEPORT" or "NATIVE_UPDATE". The type defaults to "NATIVE_UPDATE" if the value is set to null or not specified. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
host,port,user,password,database,agent_host,agent_port,agent_public_cert,agent_user, andagent_password. - By using the Connect Card or the Fivetran dashboard.
Spotify Ads
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "spotify_ads",
"group_id": "target_group_id",
"config": {
"schema": "spotify_ads",
"sync_mode": "SPECIFIC_ACCOUNTS",
"timeframe_months": "SIX",
"accounts": [],
"report_list": [
{
"table": "table_1",
"dimension": "CAMPAIGN",
"granularity": "DAY",
"fields": [ "CLICKS" ]
},
{
"table": "table_2",
"dimension": "AD_SET",
"granularity": "DAY",
"fields": [ "CLICKS", "CTR", "IMPRESSIONS" ]
}
]
}
}
Config parameters
| Name | Description | Supported Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sync_mode | Whether to sync all accounts or specific accounts. | ALL_ACCOUNTS, SPECIFIC_ACCOUNTS |
timeframe_months | The 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 |
accounts | The list of Ad Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. | |
report_list | 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. | |
dimension | The dimension (entity_type) to sync. | |
granularity | The report granularity. | |
fields | A list of the fields (metrics) to sync. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "spotify_ads", "group_id": "target_group_id", "config": { "schema": "spotify_ads", "sync_mode": "SPECIFIC_ACCOUNTS", "accounts": [], "report_list": [ { "table": "table_1", "dimension": "CAMPAIGN", "granularity": "DAY", "fields": [ "CLICKS" ] }, { "table": "table_2", "dimension": "AD_SET", "granularity": "DAY", "fields": [ "CLICKS", "CTR", "IMPRESSIONS" ] } ] }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret", "user_agent": "my_company_name", "developer_token": "my_developer_token" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Ad Studio application.client_secretClient Secretof your Ad Studio application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Sprout Social
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sprout",
"group_id": "target_group_id",
"config": {
"schema": "sprout_schema_name",
"bearer_token": "your_sprout_bearer_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
bearer_token | Your Sprout API access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
bearer_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Square
Request using API access token
POST https://api.fivetran.com/v1/connectors
{
"service": "square",
"group_id": "group_id",
"config": {
"schema": "square_schema",
"client_id": "clientId",
"api_access_token": "accessToken"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | The Application ID of your organization. |
api_access_token | The Square API access token of your application. |
Request using OAuth
POST https://api.fivetran.com/v1/connectors
{
"service": "square",
"group_id": "group_id",
"config": {
"schema": "square_schema",
"client_id": "clientId",
"client_secret": "clientSecret",
"refresh_token": "refreshToken"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | The Application ID of your organization. |
client_secret | The Application Secret of your organization. |
refresh_token | The OAuth refresh token of your organization. |
Retrieving the access token
- Log in to https://developer.squareup.com/apps with your personal credentials and click on the View Details option displayed under your Application ID.
- Switch to Production Settings option in the bottom left corner.
- Select Credentials menu on the left side of the screen.
- Click on Show option for Personal Access Token tab.
- Copy the
access Token.
Authorization
There are three ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandapi_access_token. - By specifying the values for the following fields in the request:
client_id,client_secret, andrefresh_token. - By using the Connect Card or the Fivetran dashboard.
Required scopes
The following scopes are required for this connector:
- MERCHANT_PROFILE_READ
- PAYMENTS_READ
- SETTLEMENTS_READ
- ORDERS_READ
- BANK_ACCOUNTS_READ
- ITEMS_READ
- CUSTOMERS_READ
- INVENTORY_READ
- EMPLOYEES_READ
- TIMECARDS_SETTINGS_READ
- CASH_DRAWER_READ
- LOYALTY_READ
- TIMECARDS_READ
- DISPUTES_READ
- SUBSCRIPTIONS_READ
- INVOICES_READ
- GIFTCARDS_READ
- MERCHANT_PROFILE_READ
- DEVICE_CREDENTIAL_MANAGEMENT
- VENDOR_READ
- BANK_ACCOUNTS_READ
Squarespace Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "squarespace",
"group_id": "target_group_id",
"config": {
"schema": "squarespace_schema_name",
"api_key": "your_squarespace_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Squarespace API key. |
Authorization
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.
StackAdapt Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "stackadapt",
"group_id": "target_group_id",
"config": {
"schema": "stackadapt_schema_name",
"api_key": "your_stackadapt_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your StackAdapt API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Standard Metrics Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "standard_metrics",
"group_id": "standard_metrics_group_id",
"config": {
"schema": "standard_metrics_schema_name",
"client_id": "your_standard_metrics_client_id",
"client_secret": "your_standard_metrics_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Standard Metrics client ID. |
client_secret | Your Standard Metrics client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
StarRez Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "starrez",
"group_id": "starrez_group_id",
"config": {
"schema": "starrez_schema_name",
"sub_domain": "your_starrez_sub_domain",
"password": "your_starrez_api_password",
"username": "your_starrez_api_username"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your StarRez subdomain. |
username | Your StarRez API username. |
password | Your StarRez API password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,username, andpassword. - By using the Connect Card or the Fivetran dashboard.
Statistics Netherlands CBS Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "statistics_netherlands_cbs",
"group_id": "statistics_netherlands_cbs_group_id",
"config": {
"schema": "statistics_netherlands_cbs_schema_name",
"identifier": "your_statistics_netherlands_cbs_identifier"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
identifier | Your Statistics Netherlands CBS catalog identifier. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
identifierfield in the request. - By using the Connect Card or the Fivetran dashboard.
Statsig
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "statsig",
"group_id": "target_group_id",
"config": {
"schema": "statsig_schema_name",
"secret_key": "your_statsig_secret_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
secret_key | Your Statsig secret key. |
Authorization
- By specifying the value for the
secret_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Statuspage Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "statuspage",
"group_id": "target_group_id",
"config": {
"schema": "statuspage_schema_name",
"api_key": "your_statuspage_api_key",
"organization": "your_statuspage_organization"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Statuspage API key. |
organization | Your Statuspage organization ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_keyandorganization. - By using the Connect Card or the Fivetran dashboard.
sticky.io Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "stickyio",
"group_id": "target_group_id",
"config": {
"schema": "stickyio_schema_name",
"base_url": "your_sticky.io_base_url",
"username": "your_sticky.io_username",
"password": "your_sticky.io_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
base_url | Your sticky.io base URL . |
username | Your sticky.io username . |
password | Your sticky.io password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
base_url,username, andpassword. - By using the Connect Card or the Fivetran dashboard.
Stripe
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "stripe",
"group_id": "target_group_id",
"config": {
"schema": "stripe_schema",
"access_token": "restricted_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | The Stripe API Restricted Key |
support_connected_accounts_sync | (Optional) Sync connected accounts |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Stylight Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "stylight",
"group_id": "target_group_id",
"config": {
"schema": "stylight_schema_name",
"username": "your_stylight_api_username",
"password": "your_stylight_api_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Stylight Username. |
password | Your Stylight Password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Subscript Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "subscript",
"group_id": "target_group_id",
"config": {
"schema": "subscript_schema_name",
"api_key": "your_subscript_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Subscript API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
SugarCRM Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "sugarcrm",
"group_id": "target_group_id",
"config": {
"schema": "sugarcrm_schema_name",
"sub_domain": "your_sugarcrm_subdomain",
"client_id": "your_sugarcrm_client_id",
"client_secret": "your_sugarcrm_client_secret",
"username": "your_sugarcrm_username",
"password": "your_sugarcrm_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your SugarCRM subdomain. |
client_id | Your SugarCRM client ID. |
client_secret | Your SugarCRM client secret. |
username | Your SugarCRM username. |
password | Your SugarCRM password. |
Authorization
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,username, andpassword. - By using the Connect Card or the Fivetran dashboard.
SurveyMonkey
Request
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.
POST https://api.fivetran.com/v1/connectors
{
"service": "survey_monkey",
"group_id": "target_group_id",
"config": {
"schema": "test_survey_monkey",
"eu_region": true
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
eu_region | The SurveyMonkey account region. Specify true, if your account is hosted in the EU region. Default value is false. | true, false |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandaccess_tokenin theauth section.POST https://api.fivetran.com/v1/connectors{ "service": "survey_monkey", "group_id": "target_group_id", "config": { "schema": "test_survey_monkey", "eu_region" : false }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }Auth parameters
| Name | Description | |---|---| |
client_id|Client IDof your SurveyMonkey client application. | |client_secret|Client Secretof your SurveyMonkey client application. | |access_token| The long-livedAccess tokencarries the information necessary to access API resources. |By using Connect Card or through the Fivetran dashboard.
Survicate Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "survicate",
"group_id": "target_group_id",
"config": {
"schema": "your_survicate_schema_name",
"api_key": "your_survicate_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Survicate API Key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Swoogo Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "swoogo",
"group_id": "target_group_id",
"config": {
"schema": "swoogo_schema_name",
"client_id": "your_swoogo_client_id",
"client_secret": "your_swoogo_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Swoogo client ID. |
client_secret | Your Swoogo client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Tableau Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "tableau_source",
"group_id": "target_group_id",
"config": {
"schema": "tableau_source_schema_name",
"pat_name": "your_tableau_source_personal_access_token_name",
"pat_secret": "your_tableau_source_personal_access_token_secret",
"site_name": "your_tableau_source_site_name",
"sub_domain": "your_tableau_source_sub_domain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
pat_name | Your Tableau Personal Access Token (PAT) name. |
pat_secret | Your Tableau PAT secret. |
site_name | Your Tableau site name. |
sub_domain | Your Tableau subdomain. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
pat_name,pat_secret,site_name, andsub_domain. - By using the Connect Card or the Fivetran dashboard.
Taboola
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "taboola",
"group_id": "target_group_id",
"config": {
"schema": "test_taboola",
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"client_secret": "your_api_secret",
"sync_mode": "AllAccounts",
"account_ids": "account_id1, account_id2"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
client_id | The Taboola client ID. | |
client_secret | The Taboola client secret. | |
sync_mode | Whether to sync all accounts or specific accounts. | AllAccounts, SpecificAccounts |
account_ids | Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secretandaccess_token. - By using the Connect Card or the Fivetran dashboard.
Talkdesk
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "talkdesk",
"group_id": "target_group_id",
"config": {
"schema": "talkdesk_schema_name",
"account_name" : "talkdesk_account_name",
"region": "talkdesk_region",
"client_id": "client_id",
"client_secret": "client_secret"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
account_name | Your Talkdesk account name. | |
region | Your Talkdesk region. | .com, .eu, ca.com |
client_id | Client ID of your OAuth client. | |
client_secret | Client secret of your OAuth client. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Talkwalker Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "talkwalker",
"group_id": "target_group_id",
"config": {
"schema": "talkwalker_schema_name",
"access_token": "your_talkwalker_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your Talkwalker access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Teads Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "teads",
"group_id": "target_group_id",
"config": {
"schema": "teads_schema_name",
"api_key": "your_teads_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Teads API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Teamtailor Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "teamtailor",
"group_id": "target_group_id",
"config": {
"schema": "teamtailor_schema_name",
"api_key": "your_teamtailor_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Teamtailor API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Teamwork Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "teamwork",
"group_id": "target_group_id",
"config": {
"schema": "teamwork_schema_name",
"site_address": "your_site_address",
"username": "your_username",
"password": "your_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
site_address | Your Teamwork site address. |
username | Your Teamwork username. |
password | Your Teamwork password. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following fields in the request:
site_address,username, andpassword.By using the Connect Card or the Fivetran dashboard.
Tempo Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "tempo",
"group_id": "target_group_id",
"config": {
"schema": "tempo_schema_name",
"sub_domain": "your_tempo_organization_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Tempo subdomain. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessparameter in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "tempo", "group_id": "target_group_id", "config": { "schema": "tempo_schema_name", "sub_domain": "your_tempo_organization_name" }, "auth": { "client_access": { "client_id": "tempo_client_id", "client_secret": "tempo_client_secret" } } }Auth parameters
Name Description client_access.client_idYour Tempo Client ID. client_access.client_secretYour Tempo Client secret. By using the Connect Card or the Fivetran dashboard.
TestRail Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "testrail",
"group_id": "target_group_id",
"config": {
"schema": "testrail_schema_name",
"sub_domain": "your_testrail_subdomain",
"username": "your_testrail_username",
"api_key": "your_testrail_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your TestRail subdomain. |
username | Your TestRail username. This is usually the email used for the account. |
api_key | Your TestRail API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,username, andapi_key. - By using the Connect Card or the Fivetran dashboard.
TextUs Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "textus",
"group_id": "target_group_id",
"config": {
"schema": "textus_schema_name",
"api_token": "textus_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your TextUs API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
The Movie Database Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "the_movie_database",
"group_id": "target_group_id",
"config": {
"schema": "the_movie_database_schema_name",
"api_read_access_token": "your_the_movie_database_api_read_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_read_access_token | Your The Movie Database API read access token. |
Authorization
- By specifying a value for the
api_read_access_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
The Trade Desk
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "the_trade_desk",
"group_id": "target_group_id",
"config": {
"schema": "test_trade_desk",
"login": "test_login",
"password": "xxxxxxxxxx",
"sync_mode": "SpecificAccounts",
"partners": ["partner_id1", "partner_id2"]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
login | The Trade Desk email. It is a part of the login credentials. | |
password | The Trade Desk password. It is a part of the login credentials. | |
sync_mode | Whether to sync all accounts or specific accounts. | AllAccounts, SpecificAccounts |
partners | Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
loginandpassword. - By using the Connect Card or the Fivetran dashboard.
Thinkific Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "thinkific",
"group_id": "target_group_id",
"config": {
"schema": "thinkific_schema_name",
"sub_domain": "your_thinkific_subdomain",
"client_key": "your_thinkific_client_key",
"client_secret": "your_thinkific_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Thinkific subdomain. |
client_key | Your Thinkific client key. |
client_secret | Your Thinkific client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,client_keyandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Ticket Tailor Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ticket_tailor",
"group_id": "target_group_id",
"config": {
"schema": "ticket_tailor_schema_name",
"api_key": "your_ticket_tailor_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Ticket Tailor API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
TikTok Ads
Request
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.
POST https://api.fivetran.com/v1/connectors
{
"service": "tiktok_ads",
"group_id": "target_group_id",
"config": {
"schema": "tiktok_ads",
"sync_mode": "SpecificAccounts",
"accounts": ["123","543"],
"timeframe_months": "THREE",
"custom_reports": [
{
"table_name": "table_1",
"report_type": "auction_basic_campaign_report",
"dimensions": ["campaign_id"],
"metrics": ["conversion", "cost_per_conversion", "conversion_rate"],
"aggregate": "daily"
},
{
"table_name": "table_2",
"report_type": "reservation_ads_adgroup_report",
"dimensions": ["adgroup_id"],
"metrics": ["likes", "comments", "shares", "profile_visits"],
"aggregate": "lifetime"
}
],
"attributionWindowSize": "FOURTEEN"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sync_mode | Whether to sync all advertiser accounts or specific accounts. | AllAccounts, SpecificAccounts |
accounts | Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. | |
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 |
custom_reports | The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. | |
table_name | The table name within the schema to which connector will sync the data of the specific report. | |
report_type | The name of the TikTok Ads report from which the connector will sync the data. | auction_basic_campaign_report,auction_basic_adgroup_report,auction_basic_ad_report,auction_basic_advertiser_report,auction_audience_campaign_report,auction_audience_adgroup_report,auction_audience_ad_report,auction_audience_advertiser_report,reservation_ads_campaign_report,reservation_ads_adgroup_report,reservation_ads_ad_report,reservation_ads_advertiser_report |
dimensions | A list of the dimensions to group the data to be synced. ID dimensions are mandatory. | |
metrics | A list of the metrics to be synced. | |
aggregate | The aggregation duration. | hourly , daily , lifetime |
attributionWindowSize | The attribution window to capture conversions. | ONE, SEVEN, FOURTEEN, TWENTY_EIGHT |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandaccess_tokenin theauth section.POST https://api.fivetran.com/v1/connectors{ "service": "tiktok_ads", "group_id": "target_group_id", "config": { "schema": "tiktok_ads", "sync_mode": "SpecificAccounts", "accounts": ["123"], "timeframe_months": "THREE", "custom_reports": [ { "table_name": "table_1", "report_type": "auction_basic_campaign_report", "dimensions": ["campaign_id"], "metrics": ["conversion", "cost_per_conversion", "conversion_rate"], "aggregate": "daily" } ] }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }Auth parameters
Name Description client_idClient IDof your TikTok Ads client application.client_secretClient Secretof your TikTok Ads client application.access_tokenThe long-lived Access tokencarries the information necessary to access API resources.By using the Connect Card or through the Fivetran dashboard.
IMPORTANT: If you use your own OAuth application, grant Fivetran read access permissions to all the endpoints.
Tive Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "tive",
"group_id": "target_group_id",
"config": {
"schema": "tive_schema_name",
"client_id": "your_tive_client_id",
"client_secret": "your_tive_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Tive client ID. |
client_secret | Your Tive client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Toggl Track Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "toggl_track",
"group_id": "target_group_id",
"config": {
"schema": "toggl_track_schema_name",
"api_token": "your_toggl_track_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Toggl Track API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_token. - By using the Connect Card or the Fivetran dashboard.
Totango Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "totango",
"group_id": "target_group_id",
"config": {
"schema": "totango_schema_name",
"personal_access_token": "your_totango_personal_access_token",
"region": "your_totango_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
personal_access_token | Your Totango personal access token. |
region | Your Totango region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
personal_access_tokenandregion. - By using the Connect Card or the Fivetran dashboard.
Transcend Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "transcend",
"group_id": "target_group_id",
"config": {
"schema": "transcend_schema_name",
"api_key": "your_transcend_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Transcend API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Trelica Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "trelica",
"group_id": "trelica_group_id",
"config": {
"schema": "trelica_schema_name",
"client_id": "your_trelica_client_id",
"client_secret": "your_trelica_client_secret",
"environment": "your_trelica_environment"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Trelica client ID. |
client_secret | Your Trelica client secret. |
environment | Your Trelica environment. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secretandenvironment. - By using the Connect Card or the Fivetran dashboard.
Trello Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "trello",
"group_id": "target_group_id",
"config": {
"schema": "trello_schema_name",
"api_key": "your_trello_api_key",
"api_token": "your_trello_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Trello API key. |
api_token | Your Trello API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_keyandapi_token. - By using the Connect Card or the Fivetran dashboard.
Tremendous Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "tremendous",
"group_id": "target_group_id",
"config": {
"schema": "tremendous_schema_name",
"environment": "your_tremendous_environment",
"client_id": "your_tremendous_client_id",
"client_secret": "your_tremendous_client_secret"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
environment | Your Tremendous environment. | production, sandbox |
client_id | Your Tremendous client ID. | |
client_secret | Your Tremendous client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
environment,client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Triple Whale Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "triple_whale",
"group_id": "target_group_id",
"config": {
"schema": "triple_whale_schema_name",
"shop_domain": "your_triple_whale_shop_domain",
"api_key": "your_triple_whale_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
shop_domain | Your Triple Whale shop domain. |
api_key | Your Triple Whale API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
shop_domainandapi_keyfields in the request. - By using the Connect Card or the Fivetran dashboard.
Trisolute Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "trisolute",
"group_id": "target_group_id",
"config": {
"schema": "trisolute_schema_name",
"api_token": "your_trisolute_api_token"
}}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Trisolute API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Twilio
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "twilio",
"group_id": "group_id",
"config": {
"schema": "test_twilio",
"sid":"test_api_sid",
"secret":"test_api_secret",
"accounts":[
"test_account_sid"
],
"sync_mode":"SpecificAccounts"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sid | The Twilio API key SID | |
secret | The Twilio API secret | |
accounts | Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. | |
sync_mode | Whether to sync all accounts or specific accounts. | AllAccounts, SpecificAccounts |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sid,secret,sync_modeandaccounts. - By using the Connect Card or the Fivetran dashboard.
Twitter Organic
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "twitter",
"group_id": "target_group_id",
"config": {
"schema": "twitter_schema",
"sync_mode": "SpecificAccounts",
"accounts": ["twitteraccount1","twitteraccount2"],
"timeframe_months": "TWELVE"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sync_mode | Whether to sync all accounts or specific accounts. Default value: AllAccounts. | AllAccounts, SpecificAccounts |
accounts | Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. | |
timeframe_months | Number of months' worth of 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 |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_id,client_secret,oauth_token, andoauth_token_secretparameters in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "twitter", "group_id": "target_group_id", "config": { "schema": "twitter_schema", "sync_mode": "SpecificAccounts", "accounts": ["twitteraccount1","twitteraccount2"], "timeframe_months": "TWELVE" }, "auth": { "client_access": { "client_id": "my_consumer_key", "client_secret": "my_consumer_secret" }, "oauth_token": "twitter_access_token", "oauth_token_secret": "twitter_access_token_secret" } }Auth parameters
Name Description client_idThe Twitter App consumer key. client_secretThe Twitter App consumer secret. oauth_tokenThe Twitter App access token. oauth_token_secretThe Twitter App access token secret. By using the Connect Card or through the Fivetran dashboard.
Twitter Ads
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "twitter_ads",
"group_id": "group_id",
"config": {
"schema": "test_twitter",
"oauth_token":"twitter_access_token",
"oauth_token_secret":"twitter_access_token_secret",
"consumer_key":"twitter_key",
"consumer_secret":"twitter_secret",
"accounts":[
"twitter_account1"
],
"sync_mode":"SpecificAccounts",
"timeframe_months": "timeframe_months"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
oauth_token | The Twitter App access token. | |
oauth_token_secret | The Twitter App access token secret. | |
consumer_key | The Twitter App consumer key. | |
consumer_secret | The Twitter App consumer secret. | |
accounts | Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. | |
sync_mode | Whether to sync all accounts or specific accounts. | AllAccounts, SpecificAccounts |
timeframe_months | Historical sync time frame in months. | THREE, SIX, TWELVE, TWENTY_FOUR, ALL_TIME |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
oauth_token,oauth_token_secret,consumer_keyandconsumer_secret. - By using the Connect Card or the Fivetran dashboard.
Tymeshift Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "tymeshift",
"group_id": "target_group_id",
"config": {
"schema": "tymeshift_schema_name",
"client_id": "your_tymeshift_email",
"client_secret": "your_tymeshift_password",
"sub_domain": "your_tymeshift_domain",
"account_plan": "your_tymeshift_account_plan"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Tymeshift email. |
client_secret | Your Tymeshift password. |
sub_domain | Your Tymeshift subdomain. |
account_plan | Your Tymeshift account plan. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
client_id,client_secret,sub_domain, andaccount_plan. - By using the Connect Card or the Fivetran dashboard.
Typeform
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "typeform",
"group_id": "target_group_id",
"config": {
"schema": "typeform"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_access,refresh_token, andaccess_token(optional) in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "typeform", "group_id": "target_group_id", "config": { "schema": "typeform" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token", "access_token": "my_access_token" } }Auth parameters
Name Description client_idThe Typeform client ID. client_secretThe Typeform client secret. refresh_tokenThe Typeform API refresh token. access_tokenThe Typeform API access token. By using the Connect Card or the Fivetran dashboard.
Udemy Business Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "udemy_business",
"group_id": "target_group_id",
"config": {
"schema": "udemy_business_schema_name",
"client_id": "udemy_business_client_id",
"client_secret": "udemy_business_client_secret",
"account_id": "udemy_business_account_id",
"account_name": "udemy_business_account_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Udem Business client ID. |
client_secret | Your Udemy Business client secret. |
account_id | Your Udemy Business account ID. |
account_name | Your Udemy Business account name. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for following fields in the request:
client_id,client_secret,account_id, andaccount_name. - By using the Connect Card or the Fivetran dashboard.
UKG Pro Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "ukg_pro",
"group_id": "target_group_id",
"config": {
"schema": "ukg_pro_schema_name",
"username": "your_ukg_pro_username",
"password": "your_ukg_pro_password",
"hostname": "your_ukg_pro_hostname",
"customer_api_key": "your_ukg_pro_customer_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your UKG Pro username. |
password | Your UKG Pro password. |
hostname | Your UKG Pro hostname. |
customer_api_key | Your UKG Pro Customer API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,password,hostname, andcustomer_api_key. - By using the Connect Card or the Fivetran dashboard.
Unicommerce Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "unicommerce",
"group_id": "target_group_id",
"config": {
"schema": "unicommerce_schema_name",
"username": "uniware_username",
"password": "uniware_password",
"tenant": "your_uniware_account_code",
"facility_codes": ["facility_code_1","facility_code_2"]
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Uniware username. |
password | Your Uniware password. |
tenant | Your Uniware account code. |
facility_codes | Your Uniware facility codes. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
username,password,tenant, andfacility_codes. - By using the Connect Card or the Fivetran dashboard.
Upland Software Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "upland",
"group_id": "target_group_id",
"config": {
"schema": "upland_schema_name",
"sub_domain": "your_upland_sub_domain",
"company_key": "your_upland_company_key",
"username": "your_upland_username",
"password": "your_upland_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Upland Software subdomain. |
company_key | Your Upland Software company key. |
username | Your Upland Software username. |
password | Your Upland Software password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domain,company_key,username, andpassword. - By using the Connect Card or the Fivetran dashboard.
UpPromote Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "uppromote",
"group_id": "target_group_id",
"config": {
"schema": "uppromote_schema_name",
"api_key": "your_uppromote_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your UpPromote API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
UserVoice
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "uservoice",
"group_id": "target_group_id",
"config": {
"schema": "test_uservoice",
"domain": "uservoice_domain",
"key": "your_api_key",
"secret": "your_api_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
domain | Domain of your UserVoice site. If it ends with ".uservoice.com", you can specify just the subdomain ("mydomain.uservoice.com" → "mydomain") |
key | The UserVoice API key. |
secret | The UserVoice API secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
domain,keyandsecret. - By using the Connect Card or the Fivetran dashboard.
Veeqo Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "veeqo",
"group_id": "target_group_id",
"config": {
"schema": "veeqo_schema_name",
"api_key": "your_veeqo_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Veeqo API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Veeva Vault Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "veevavault",
"group_id": "target_group_id",
"config": {
"schema": "veevavault_schema_name",
"username": "veevavault_username",
"password": "veevavault_password",
"base_url": "your_veevavault_base_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Veeva Vault username. |
password | Your Veeva Vault password. |
base_url | Your Veeva Vault base URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,passwordandbase_url. - By using the Connect Card or the Fivetran dashboard.
Vimeo Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "vimeo",
"group_id": "target_group_id",
"config": {
"schema": "vimeo_schema_name",
"user_id": "your_vimeo_user_id",
"client_id": "your_vimeo_client_id",
"client_secret": "your_vimeo_client_secret",
"rate_limit_plan": "your_vimeo_rate_limit_plan",
"historical_sync_time_frame": "your_vimeo_historical_sync_time_frame"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
user_id | Your Vimeo user ID. |
client_id | Your Vimeo client ID. |
client_secret | Your Vimeo client secret. |
rate_limit_plan | Your Vimeo pricing plan. |
historical_sync_time_frame | Range of historical data you want to include in the initial sync. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
user_id,client_id,client_secret,rate_limit_plan, andhistorical_sync_time_frame. - By using the Connect Card or the Fivetran dashboard.
Visit by GES Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "visit_by_ges",
"group_id": "target_group_id",
"config": {
"schema": "visit_by_ges_schema_name",
"api_key": "your_visit_by_ges_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Visit by GES API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card after creating the connector or the Fivetran dashboard.
Visma Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "visma",
"group_id": "target_group_id",
"config": {
"schema": "visma_schema_name",
"tenant_id": "your_visma_tenant_id",
"client_id": "your_visma_client_id",
"client_secret": "your_visma_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
tenant_id | Your Visma tenant ID. |
client_id | Your Visma client ID. |
client_secret | Your Visma client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the following fields in the request:
tenant_id,client_id, andclient_secret. - By using the Connect Card after creating the connector or the Fivetran dashboard.
Vitally Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "vitally",
"group_id": "target_group_id",
"config": {
"schema": "vitally_schema_name",
"api_key": "your_vitally_api_key",
"base_url": "your_vitally_base_url"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Vitally API key. |
base_url | Your Vitally base URL. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_keyandbase_url. - By using the Connect Card or the Fivetran dashboard.
Vonage Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "vonage",
"group_id": "target_group_id",
"config": {
"schema": "vonage_schema_name",
"api_key": "your_vonage_api_key",
"api_secret": "your_vonage_api_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Vonage API key. |
api_secret | Your Vonage API secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_keyandapi_secret. - By using the Connect Card or the Fivetran dashboard.
Vonage Contact Center Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "vonage_contact_center",
"group_id": "target_group_id",
"config": {
"schema": "vonage_contact_center_schema_name",
"client_id": "your_vonage_contact_center_client_id",
"client_secret": "your_vonage_contact_center_client_secret",
"region": "your_vonage_contact_center_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Vonage Contact Center client ID. |
client_secret | Your Vonage Contact Center client secret. |
region | Your Vonage Contact Center region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret, andregion. - By using the Connect Card or the Fivetran dashboard.
VTS Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "vts",
"group_id": "target_group_id",
"config": {
"schema": "vts_schema_name",
"api_key": "your_vts_api_key",
"secret": "your_vts_secret",
"environment": "your_vts_environment"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your VTS API key. |
secret | Your VTS secret. |
environment | Your VTS environment. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key,secretandenvironment. - By using the Connect Card or the Fivetran dashboard.
VWO Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "vwo",
"group_id": "target_group_id",
"config": {
"schema": "vwo_schema_name",
"api_token": "your_vwo_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your VWO API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_tokenfield in the request. - By using the Connect Card or the Fivetran dashboard.
Walmart DSP Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "walmart_dsp",
"group_id": "target_group_id",
"config": {
"schema": "test_walmart_dsp",
"login": "test_login",
"password": "xxxxxxxxxx",
"sync_mode": "SpecificAccounts",
"partners": ["partner_id1", "partner_id2"]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
login | Walmart DSP email. It is a part of the login credentials. | |
password | Walmart DSP password. It is a part of the login credentials. | |
sync_mode | Whether to sync all accounts or specific accounts. | AllAccounts, SpecificAccounts |
partners | Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
loginandpassword. - By using the Connect Card or the Fivetran dashboard.
Walmart Marketplace Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "walmart_marketplace",
"group_id": "target_group_id",
"config": {
"schema": "walmart_marketplace_schema_name",
"client_id": "your_walmart_marketplace_client_id",
"client_secret": "your_walmart_marketplace_client_secret",
"service_name": "your_walmart_marketplace_service_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Walmart Marketplace client ID. |
client_secret | Your Walmart Marketplace client secret. |
service_name | Your Walmart Marketplace service name. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret, andservice_name. - By using the Connect Card or the Fivetran dashboard.
Wasabi Cloud Storage Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "wasabi_cloud_storage",
"group_id": "target_group_id",
"config": {
"schema": "test_wasabi_cloud_storage",
"table": "table_name",
"bucket": "bucket_name",
"region": "US_EAST_1",
"auth_type": "ACCESS_KEY",
"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",
"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": ";"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
table | The table name within the schema to which the connector will sync the data. Required for connector creation. | |
bucket | The Wasabi Cloud Storage bucket name. Required for connector creation. | |
region | The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: US_EAST_1. | US_EAST_1,US_EAST_2,US_CENTRAL_1,US_WEST_1,CA_CENTRAL_1,EU_CENTRAL_1,EU_CENTRAL_2,EU_WEST_1,EU_WEST_2,AP_NORTHEAST_1,AP_NORTHEAST_2,AP_SOUTHEAST_1,AP_SOUTHEAST_2 |
auth_type | The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: ACCESS_KEY. | ACCESS_KEY, PUBLIC_BUCKET |
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. | csv, json, tsv, avro, jsonl, log, parquet, xml, infer |
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 overwrites 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 |
use_pgp_encryption_options | Set to true if files are encrypted using PGP in the Wasabi Cloud Storage 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. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
access_key_idandaccess_key_secretfields, if yourauth_typeisACCESS_KEY.By using the Connect Card or the Fivetran dashboard.
Webconnex Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "webconnex",
"group_id": "target_group_id",
"config": {
"schema": "webconnex_schema_name",
"api_key": "your_webconnex_api_key",
"product": "product_name"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
api_key | Your Webconnex API key. | |
product | The Webconnex product name. | regfox.com, ticketspice.com, redpodium.com, and givingfuel.com |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
api_keyandproductfields in the request. - By using the Connect Card or the Fivetran dashboard.
Webhooks
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "webhooks",
"group_id": "target_group_id",
"config": {
"schema": "schema_name",
"table": "table_name",
"sync_format": "Packed",
"bucket_service": "S3",
"s3_bucket": "your_bucket_name",
"s3_role_arn": "arn::your_role_arn",
"auth_method": "NONE"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
sync_format | The webhooks sync format. Default value: Unpacked. Unpacked messages must be valid JSON. | Unpacked, Packed |
bucket_service | Whether to store the events in Fivetran's container service or your S3 bucket. Default value: Fivetran. | Fivetran, AZURE, GCS, S3 |
gcs_bucket | The GCS bucket name. Required if bucket_service is set to GCS. | |
blob_sas_url | The blob SAS URL of your Azure container. Required if bucket_service is set to AZURE. | |
s3_bucket | The S3 bucket name. Required if bucket_service is set to S3. | |
s3_role_arn | The Role ARN required for authentication. Required if bucket_service is set to S3. | |
endpoint | You can send your events to https://webhooks.fivetran.com/webhooks/{endpoint}. | |
auth_method | The authentication mechanism you want to use to authenticate incoming events. | NONE, TOKEN_BASED , HMAC |
Authorization
There are the following ways to authorize this connector type:
If you use your bucket service, by specifying the values for the following fields in the request:
blob_sas_url, ifbucket_serviceis set toAZUREgcs_bucket, ifbucket_serviceis set toGCSs3_bucketands3_role_arn, ifbucket_serviceis set toS3
IMPORTANT: If
bucket_serviceis set toGCS, you must share your GCS bucket with Fivetran's service account using the account's auto-generated email address in the following format:g-[group_id]@fivetran-production.iam.gserviceaccount.comwhere
[group_id]is the connector's group ID.If you use Fivetran's container service, by specifying
Fivetranas a value of thebucket_servicefield.By using the Connect Card or the Fivetran dashboard.
Web Scraper Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "web_scraper",
"group_id": "target_group_id",
"config": {
"schema": "web_scraper_schema_name",
"api_token": "your_web_scraper_api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_token | Your Web Scraper API token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_token. - By using the Connect Card or the Fivetran dashboard.
When I Work Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "when_i_work",
"group_id": "target_group_id",
"config": {
"schema": "when_i_work_schema_name",
"username": "when_i_work_username",
"password": "when_i_work_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your When I Work username. |
password | Your When I Work password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Wherefour Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "wherefour",
"group_id": "target_group_id",
"config": {
"schema": "wherefour_schema_name",
"username": "wherefour_username",
"password": "wherefour_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Wherefour username. |
password | Your Wherefour password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Wicked Reports Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "wicked_reports",
"group_id": "target_group_id",
"config": {
"schema": "wicked_reports_schema_name",
"api_key": "your_wicked_reports_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Wicked Reports API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
WooCommerce Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "woocommerce",
"group_id": "target_group_id",
"config": {
"schema": "woocommerce_schema_name",
"word_press_site_id_or_woocommerce_domain_name": "wordpress_site_id or http://your.sub.domain/",
"consumer_key": "your_woocommerce_consumer_key",
"consumer_secret": "your_woocommerce_consumer_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
word_press_site_id_or_woocommerce_domain_name | The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance. |
consumer_key | Your WooCommerce Consumer key. |
consumer_secret | Your WooCommerce Consumer secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
word_press_site_id_or_woocommerce_domain_name,consumer_keyandconsumer_secret. - By using the Connect Card or the Fivetran dashboard.
WordPress Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "wordpress",
"group_id": "target_group_id",
"config": {
"schema": "wordpress_schema_name",
"sub_domain": "your_wordpress_subdomain"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your WordPress subdomain. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessfield in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "wordpress", "group_id": "target_group_id", "config": { "schema": "wordpress_schema_name", "sub_domain": "your_wordpress_sub_domain" }, "auth": { "client_access": { "client_id": "your_wordpress_client_id", "client_secret": "your_wordpress_client_secret" } } }Auth parameters
Name Description client_idYour WordPress client ID. client_secretYour WordPress client secret. By using the Connect Card or the Fivetran dashboard.
Workable Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "workable",
"group_id": "target_group_id",
"config": {
"schema": "workable_schema_name",
"sub_domain": "your_workable_sub_domain",
"access_token": "your_workable_access_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Workable subdomain. |
access_token | Your Workable access token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domainandaccess_token. - By using the Connect Card or the Fivetran dashboard.
Workday Financial Management Beta
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "workday_financial_management",
"group_id": "target_group_id",
"config": {
"schema": "test_workday_financial_management",
"username": "your_workday_username",
"tenant" : "your_workday_tenant",
"integration_system_id": "integration_system_id",
"password": "your_workday_password",
"domain_host_name": "your_workday_hostname"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Your Workday username. |
tenant | Your Workday tenant. |
password | Your Workday password. |
integration_system_id | Your Workday integration system ID to sync custom and calculated fields. |
domain_host_name | Your Workday hostname. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
user_name,tenant,passwordanddomain_host_name. - By using the Connect Card or the Fivetran dashboard.
Workday HCM
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "workday_hcm",
"group_id": "target_group_id",
"config": {
"schema": "test_workday_hcm",
"username": "workday_username",
"password": "workday_password",
"integration_system_id": "integration_system_id",
"domain_host_name": "your_workday_host_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
username | Workday username. |
password | Workday password. |
integration_system_id | Your Workday Integration System ID. To sync custom and calculated fields. |
domain_host_name | Workday host name. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
user_name,passwordanddomain_host_name. - By using the Connect Card or the Fivetran dashboard.
Workday RaaS
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "workday",
"group_id": "target_group_id",
"config": {
"schema": "test_workday",
"table": "workday_report_table",
"user_name": "workday_username",
"password": "workday_password",
"report_url": "workday_report_url",
"report_format_type": "json",
"support_nested_columns": true,
"primary_keys": ["key_1", "key_2", ...]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
table | The table name within the schema to which connector will sync the data. Required for connector creation. | |
user_name | Workday username. | |
password | Workday password. | |
report_url | URL for a live custom report. | |
report_format_type | Workday report format type. Default format: json. | json and csv |
support_nested_columns | Set to true to unpack the nested columns and sync them separately. Otherwise, set to false. By default, we sync the nested columns as JSON objects | |
primary_keys | Primary key(s) to be set in the destination table for the custom report. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following fields in the request:
user_name,passwordandreport_url.By using the Connect Card or the Fivetran dashboard.
Workday Strategic Sourcing Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "workday_strategic_sourcing",
"group_id": "target_group_id",
"config": {
"schema": "workday_strategic_sourcing_schema_name",
"region": "your_workday_strategic_sourcing_region",
"x_api_key": "your_workday_strategic_sourcing_api_key",
"x_user_token": "your_workday_strategic_sourcing_user_token",
"x_user_email": "your_workday_strategic_sourcing_user_email"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
region | Your Workday Strategic Sourcing Region. |
x_api_key | Your Workday Strategic Sourcing API key. |
x_user_token | Your Workday Strategic Sourcing user token. |
x_user_email | Your Workday Strategic Sourcing user email. |
Authorization
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
region,x_api_key,x_user_token, andx_user_email. - By using the Connect Card or the Fivetran dashboard.
Workleap Officevibe Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "workleap_officevibe",
"group_id": "target_group_id",
"config": {
"schema": "workleap_officevibe_schema_name",
"api_key": "your_workleap_officevibe_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Workleap Officevibe API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
WorkRamp Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "workramp",
"group_id": "target_group_id",
"config": {
"schema": "workramp_schema_name",
"access_token": "your_workramp_access_token",
"academy_id": "your_workramp_academy_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
access_token | Your WorkRamp access token. |
academy_id | Your WorkRamp academy ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
access_tokenandacademy_id. - By using the Connect Card or the Fivetran dashboard.
Wrike Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "wrike",
"group_id": "target_group_id",
"config": {
"schema": "wrike_schema_name",
"sub_domain": "your_wrike_subdomain"
},
"auth":{
"client_access":{
"client_id": "your_wrike_client_id",
"client_secret": "your_wrike_client_secret"
}
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Wrike Subdomain. |
client_id | Your Wrike Client ID. |
client_secret | Your Wrike Client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Xactly Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "xactly",
"group_id": "target_group_id",
"config": {
"schema": "xactly_schema",
"application_id": "your_xactly_application_id",
"consumer_name": "your_xactly_consumer_name",
"connect_username": "your_xactly_connect_username",
"connect_password": "your_xactly_connect_password",
"environment": "your_xactly_environment",
"environment_host": "your_xactly_environment_host"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
application_id | Your Xactly application ID. |
consumer_name | Your Xactly consumer name. |
connect_username | Your Xactly connect username. |
connect_password | Your Xactly connect password. |
environment | Your Xactly environment. |
environment_host | Your Xactly environment host. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
application_id,consumer_name,connect_username,connect_password,environment, andenvironment_host. - By using the Connect Card or the Fivetran dashboard.
Xandr Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "xandr",
"group_id": "xandr_group_id",
"config": {
"schema": "xandr_schema_name",
"username": "your_xandr_username",
"password": "your_xandr_password"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
username | Your Xandr username. |
password | Your Xandr password. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
usernameandpassword. - By using the Connect Card or the Fivetran dashboard.
Xero
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "xero",
"group_id": "target_group_id",
"config": {
"schema": "xero_schema",
"client_id": "xero_client_id",
"client_secret": "xero_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Xero Client ID. |
client_secret | Your Xero Client Secret. |
use_webhooks | Set to true if you want to configure webhooks |
webhook_key | Your webhook key. Required if use_webhooks is true. |
webhook_url | (ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO. |
Authorization
This connector type can only be authorized by using the Connect Card or the Fivetran dashboard.
Xray Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "xray",
"group_id": "xray_group_id",
"config": {
"schema": "xray_schema_name",
"client_id": "client_id",
"client_secret": "client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Xray Client ID. |
client_secret | Your Xray Client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_idandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Xsolla Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "xsolla",
"group_id": "target_group_id",
"config": {
"schema": "xsolla_schema_name",
"merchant_id": "your_xsolla_merchant_id",
"api_key": "your_xsolla_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
merchant_id | Your Xsolla Merchant ID. |
api_key | Your Xsolla API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
merchant_idandapi_key. - By using the Connect Card or the Fivetran dashboard.
Yahoo DSP Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "yahoo_dsp",
"group_id": "group_id",
"config": {
"schema": "test_yahoo_dsp",
"sync_mode_seat": "SpecificSeats",
"seats": ["seat1", "seat2"],
"sync_mode_advertiser": "SpecificAdvertisers",
"advertisers_with_seat": ["advertiser1:seat1", "advertiser2:seat1", "advertiser3:seat2"],
"timeframe_months": "THREE",
"reportConfigs": [
{
"configType": "PREBUILT",
"prebuiltReportType": "REPORT_BASIC",
"reportName": "report_1",
"currency": "USD",
"useAdvertiserTimezone": false,
"timeZone": "ETC_GMT",
"intervalType": "DAY"
},
{
"configType": "CUSTOM",
"reportName": "report_2",
"currency": "USD",
"useAdvertiserTimezone": true,
"dimensions": ["ADVERTISER", "CAMPAIGN"],
"metrics": ["IMPRESSIONS", "CLICKS"],
"intervalType": "DAY"
}
]
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
sync_mode_seat | Whether to sync all advertisers or specific advertisers. | AllSeats, SpecificSeats |
seats | Specific Seats to sync. Must be populated if sync_mode_seat is set to SpecificSeats. | |
sync_mode_advertiser | Whether to sync all advertisers or specific advertisers. | AllAdvertisers, SpecificAdvertisers |
advertisers_with_seat | Specific Advertisers to sync. Must be populated if sync_mode_advertiser is set to SpecificAdvertisers. | |
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 |
reportConfigs | The list of report configurations. Each report corresponds to a table within the schema to which connector will sync the data. | |
configType | Type of report. Connector provides two report types - prebuilt or custom. | PREBUILT, CUSTOM |
prebuiltReportType | Type of prebuilt report. Should be populated if configType is set to PREBUILT. | REPORT_BASIC, REPORT_CONVERSIONS, REPORT_LINE_PERFORMANCE, REPORT_CAMPAIGN_PERFORMANCE, REPORT_AD_PERFORMANCE, REPORT_AUDIENCE_SEGMENT, REPORT_SITE_DOMAIN_PERFORMANCE, REPORT_DYNAMIC_PRODUCT_ADS |
reportName | Name of the report | |
currency | Specifies the denomination used in reports. Can be specified at the seat level, advertiser-level, or campaign-level. Default value: USD. | SEAT, ADVERTISER, CAMPAIGN, USD |
useAdvertiserTimezone | Set to true to use advertiser-related time zone to fetch report. Default value: false. | true, false |
timeZone | Time zone to fetch report. Should be populated if useAdvertiserTimezone is set to false. | AMERICA_LOS_ANGELES, AMERICA_DENVER, AMERICA_CHICAGO, AMERICA_EL_SALVADOR, AMERICA_MEXICO_CITY, AMERICA_NEW_YORK, AMERICA_BOGOTA, AMERICA_LIMA, AMERICA_HALIFAX, AMERICA_PUERTO_RICO, AMERICA_ARGENTINA_BUENOS_AIRES, AMERICA_SANTIAGO, AMERICA_SAO_PAULO, ETC_GMT, EUROPE_LONDON, EUROPE_PARIS, ASIA_JERUSALEM, ASIA_DUBAI, ASIA_KARACHI, ASIA_DHAKA, ASIA_JAKARTA, AUSTRALIA_PERTH, ASIA_SHANGHAI, ASIA_TOKYO, AUSTRALIA_SYDNEY, PACIFIC_AUCKLAND |
dimensions | The list of report dimensions. Should be populated if configType is set to CUSTOM. | PUBLISHER, LAYOUT, ADVERTISER, CAMPAIGN, LINE, AD, CREATIVE, DOMAIN, ADVERTISER_CATEGORY_ID, COUNTRY, REGION, CITY, POSTAL_CODE, DEVICE_CATEGORY, BROWSER_TYPE, DESKTOP_OS, AGE, GENDER, AD_POSITION, DEVICE_TYPE, ADVERTISER_SUB_CATEGORY, PIXEL, SUBDOMAIN, APP_NAME, SEAT_ID, LINE_TYPE, ADVERTISER_GROUP, MOBILE_CARRIER, GOAL_TYPE, LINE_BILLING_METHOD, PARENT_LINE, MARKET_AREA, FREQUENCY_BUCKET_1D, FREQUENCY_BUCKET_7D, FREQUENCY_BUCKET_30D, PIXEL_PARAMETER, TARGET_AUDIENCE_ID_GROUP_A, INVENTORY_TYPE, BUCKETED_AGE, DEMO_VENDOR, MOBILE_OS, MOBILE_MAKE, MOBILE_MODEL, CONNECTION_TYPE, ISP, CREATIVE_CUSTOM_ID, DAYS_TO_CONVERSION, PACKAGE, EXCHANGE_DEAL_ID, DOT_RULE, CONNECTED_TV_DEVICE, INVENTORY_AUCTION_TYPE, SUPPLY_GROUP, NATIVE_TYPE, BID_REQUEST_AD_SIZE, WEATHER_CONDITION, TARGET_AUDIENCE_ID_GROUP_B, CHANNEL_TYPE, VIDEO_CONTENT_LENGTH, VIDEO_AD_PLACEMENT, ADS_TXT_DECLARATION, CREATIVE_FORMAT, SITE_NAME, VIDEO_PLAYER_SIZE, SITE_GROUP_NAME, DYNAMIC_CREATIVE_VARIATION, DYNAMIC_CREATIVE_SET, LINE_START_DATE, LINE_END_DATE, PACKAGE_END_DATE, CAMPAIGN_CURRENT_SCHEDULE_TOTAL_BUDGET, PACKAGE_SCHEDULE_NAME, PACKAGE_CURRENT_SCHEDULE_TOTAL_BUDGET, LINE_SCHEDULE_NAME, LINE_SCHEDULE_START_DATE, LINE_SCHEDULE_END_DATE, LINE_DAILY_BUDGET_SCHEDULE, LINE_CURRENT_SCHEDULE_TOTAL_BUDGET, LINE_BUDGET_PACING, LINE_PACING_ACCELERATION, CONNECTED_TV_MAKE, CONNECTED_TV_MODEL, LINE_FLIGHT, PACKAGE_BUDGET_SCHEDULE, DEAL_TYPE, VIDEO_CREATIVE_DURATION, CAMPAIGN_SCHEDULE_NAME, CAMPAIGN_SCHEDULE_END_DATE, CAMPAIGN_START_DATE, CAMPAIGN_END_DATE, PACKAGE_SCHEDULE_START_DATE, PACKAGE_SCHEDULE_END_DATE, CAMPAIGN_TOTAL_BUDGET, CAMPAIGN_DAILY_BUDGET, PACKAGE_TOTAL_BUDGET, PACKAGE_DAILY_BUDGET, LINE_TOTAL_BUDGET, LINE_DAILY_BUDGET, CAMPAIGN_DAILY_BUDGET_SCHEDULE, PACKAGE_DAILY_BUDGET_SCHEDULE, PACKAGE_BUDGET_DISTRIBUTOR, AD_SERVING_COST_NAME, AUDIENCE_MEASUREMENT_COST_NAME, OTHER_COST_NAME, CONTENT_SHOW, CONTENT_CHANNEL, CONTENT_NETWORK, CONTENT_TITLE, CONTENT_GENRE |
metrics | The list of report metrics. Should be populated if configType is set to CUSTOM. | IMPRESSIONS, CLICKS, CTR, CONVERSION, START_VIEWS, COMPLETIONS_25, COMPLETIONS_50, COMPLETIONS_75, COMPLETIONS_100, DROP_RATE_AT_0, DROP_RATE_AT_25, DROP_RATE_AT_50, DROP_RATE_AT_75, CPC, CNVR, CPA, ADVERTISER_SPENDING, ADVERTISER_ECPM, PUBLISHER_EARNINGS, PUBLISHER_EARNINGS_PERCENTAGE, INVENTORY_ECPM, NETWORK_PROFIT, NETWORK_PROFIT_PERCENTAGE, NETWORK_ECPM, AVERAGE_FREQUENCY, COMPLETION_RATE_25, COMPLETION_RATE_50, COMPLETION_RATE_75, COMPLETION_RATE_100, YAHOO_MEASURABLE_IMPRESSIONS, YAHOO_VIEWABLE_IMPRESSIONS, YAHOO_VIEWABLE_RATE, NON_VIEWABLE_IMPRESSIONS, YAHOO_NON_MEASURABLE_IMPRESSIONS, YAHOO_MEASURABLE_RATE, IMPRESSION_DISTRIBUTION_VIEWABLE, IMPRESSION_DISTRIBUTION_NONVIEWABLE, IMPRESSION_DISTRIBUTION_NONMEASURABLE, VIEW_THROUGH_CONVERSION, CLICK_THROUGH_CONVERSION, VIEW_THROUGH_CONVERSION_RATE, CLICK_THROUGH_CONVERSION_RATE, VIEW_THROUGH_CPA, CLICK_THROUGH_CPA, UNIQUE_VIEWERS, SEAT_TECH_FEE, SEAT_DATA_FEE, SEAT_MANAGEMENT_FEE, FILTERED_IMPRESSIONS, FILTERED_CLICKS, CONVERSION_VALUE, ROAS, MOAT_VIEWABLE_RATE, MOAT_VIEWABLE_IMPRESSIONS, MOAT_MEASURABLE_IMPRESSIONS, VCPM, CPCV, CROSS_DEVICE_CONVERSIONS, QUALIFIED_BID_REQUESTS, YAHOO_DATA_FEES, THIRD_PARTY_DATA_FEES, ORDER_MANAGEMENT_FEE, AD_SERVING_COST, AD_VERIFICATION_COST, AUDIENCE_MEASUREMENT_COST, BRAND_SAFETY_COST, VIEWABIILITY_COST, OTHER_COST, TOTAL_VARIABLE_COST, MOAT_IMPRESSIONS_ANALYZED, MOAT_AVOC, MOAT_AVFH, MOAT_MEASURABILITY_RATE, MOAT_AVOC_RATE, SKIPPED_ADS, BID_RESPONSES, TOTAL_VENDOR_FEE, BID_PRICE_WITHOUT_MULTIPLIER, BID_PRICE_WITHOUT_MULTIPLIER_ORDER_CURRENCY, MULTIPLIED_ECPM, BID_CPM, BID_CPM_ORDER_CURRENCY, DYNAMIC_CONVERSION_VALUE, VERY_FIRST_CONVERSION, UNIQUE_CONVERTERS, UNIQUE_CLICK_THROUGH_CONVERTERS, UNIQUE_VIEW_THROUGH_CONVERTERS, AUDIENCE_IMPRESSIONS, COST_PER_VALID_VIDEO_VIEW_CPV, BID_PRICE_WITHOUT_MULTIPLIER_ADVERTISER_CURRENCY, BID_PRICE_WITHOUT_MULTIPLIER_SEAT_CURRENCY, BID_CPM_ADVERTISER_CURRENCY, BID_CPM_SEAT_CURRENCY, COMPANION_IMPRESSIONS, COMPANION_CLICKS, MAIL_AD_OPENS, MAIL_AD_FORM_SUBMITS, MAIL_AD_SAVES, MAIL_AD_FORWARDS, MAIL_AD_CLICK_OUTS, MAIL_AD_SUBMIT_RATE, MAIL_AD_SAVES_RATE, MAIL_AD_FORWARD_RATE, MAIL_AD_CLICK_OUTS_RATE, FILTERED_COMPANION_IMPRESSIONS, FILTERED_COMPANION_CLICKS, ESTIMATED_BILLABLE_AMOUNT, AVERAGE_FREQUENCY_PER_HOUSEHOLD, AVERAGE_IMPRESSION_MULTIPLIER, ESTIMATED_NUMBER_OF_STORE_VISITS, ESTIMATED_UNIQUE_STORE_VISITORS, ESTIMATED_STORE_VISIT_THROUGH_RATE_VTR, ESTIMATED_COST_PER_STORE_VISIT_CPSV, AVERAGE_PEOPLE_FREQUENCY, VERY_FIRST_VIEW_THROUGH_CONVERSION, VERY_FIRST_CLICK_THROUGH_CONVERSION, VIEW_THROUGH_CONVERSION_VALUE, CLICK_THROUGH_CONVERSION_VALUE, VERY_FIRST_VIEW_THROUGH_CONVERSION_VALUE, VERY_FIRST_CLICK_THROUGH_CONVERSION_VALUE, YAHOO_SEGMENT_FEE, THIRD_PARTY_SEGMENT_FEE, AVAILABLE_BID_REQUESTS, AVERAGE_WIN_RATE |
intervalType | Specifies the granularity of report time intervals. Default value: DAY | CUMULATIVE, DAY, MONTH, WEEK, HOUR |
Authorization
There are two ways to authorize this connector type:
By specifying the values of the
client_idandclient_secret.POST https://api.fivetran.com/v1/connectors{ "service": "yahoo_dsp", "group_id": "group_id", "config": { "schema": "test_yahoo_dsp", "client_id": "client_id", "client_secret": "client_secret", "sync_mode_seat": "SpecificSeats", "seats": ["seat1", "seat2"], "sync_mode_advertiser": "SpecificAdvertisers", "advertisers_with_seat": ["advertiser1:seat1", "advertiser2:seat1", "advertiser3:seat2"], "timeframe_months": "THREE", "reportConfigs": [ { "configType": "PREBUILT", "prebuiltReportType": "REPORT_BASIC", "reportName": "report_1", "currency": "USD", "useAdvertiserTimezone": false, "timeZone": "ETC_GMT", "intervalType": "DAY" }, { "configType": "CUSTOM", "reportName": "report_2", "currency": "USD", "useAdvertiserTimezone": true, "dimensions": ["ADVERTISER", "CAMPAIGN"], "metrics": ["IMPRESSIONS", "CLICKS"], "intervalType": "DAY" } ] } }Auth parameters
Name Description client_idClient IDof your Yahoo DSP client application.client_secretClient Secretof your Yahoo DSP client application.By using the Connect Card or through the Fivetran dashboard.
Yahoo Search Ads on Yahoo Japan Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "yahoo_search_ads_yahoo_japan",
"group_id": "target_group_id",
"config": {
"schema": "yahoo_search_ads_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessparameter in theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "yahoo_search_ads_yahoo_japan", "group_id": "target_group_id", "config": { "schema": "yahoo_search_ads_schema_name" }, "auth": { "client_access": { "client_id": "yahoo_search_ads_client_id", "client_secret": "yahoo_search_ads_client_secret" } } }Auth parameters
Name Description client_access.client_idYour Yahoo Search Ads client ID. client_access.client_secretYour Yahoo Search Ads client secret. By using the Connect Card or the Fivetran dashboard.
Yotpo Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "yotpo",
"group_id": "target_group_id",
"config": {
"schema": "yotpo_schema_name",
"app_key": "your_yotpo_app_key",
"secret_key": "your_yotpo_secret_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
app_key | Your Yotpo App Key. |
secret_key | Your Yotpo Secret key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
app_keyandsecret_key. - By using the Connect Card or the Fivetran dashboard.
Yougov Sport Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "yougov_sport",
"group_id": "target_group_id",
"config": {
"schema": "yougov_sport_schema_name",
"api_key": "your_yougov_sport_api_key",
"client_key": "your_yougov_sport_client_key",
"client_secret": "your_yougov_sport_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your YouGov Sport API key. |
client_key | Your YouGov Sport client key. |
client_secret | Your YouGov Sport client secret. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
api_key,client_keyandclient_secret. - By using the Connect Card or the Fivetran dashboard.
Younium Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "younium",
"group_id": "target_group_id",
"config": {
"schema": "younium_schema_name",
"environment": "your_younium_api_environment",
"auth_environment" : "your_younium_auth_environment",
"username": "your_younium_username",
"legal_entity_id": "your_younium_legal_entity_id",
"password": "your_younium_password"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
environment | Your Younium API environment. | Sandbox, Production, US-Sandbox, UX-Production |
auth_environment | Your Younium auth environment. | Sandbox, Production |
username | Your Younium username. | |
password | Your Younium password. | |
legal_entity_id | Your Younium legal entity ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
environment,auth_environment,username,password, andlegal_entity_id. - By using the Connect Card or the Fivetran dashboard.
YouTube Analytics
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "youtube_analytics",
"group_id": "target_group_id",
"config": {
"schema": "test_youtube_analytics",
"content_owner_id": "content_owner_id"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. | |
content_owner_id | Used only for Content Owner reports. The ID of the content owner for whom the API request is being made. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "youtube_analytics", "group_id": "target_group_id", "config": { "schema": "test_youtube_analytics", "content_owner_id": "content_owner_id" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your YouTube Analytics client application.client_secretClient Secretof your YouTube Analytics client application.refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.By using the Connect Card or the Fivetran dashboard.
Zendesk Chat
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zendesk_chat",
"group_id": "target_group_id",
"config": {
"schema": "test_zendesk_chat",
"subdomain": "zendesk_domain",
"client_id": "test_client_id",
"client_secret": "test_client_secret"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
subdomain | Your Zendesk domain. |
client_id | Your Zendesk client ID. |
client_secret | Your Zendesk client secret. |
Authorization
There are two ways to authorize this connector type:
By specifying a value for
access_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "zendesk_chat", "group_id": "target_group_id", "config": { "schema": "zendesk_chat" }, "auth": { "access_token": "my_access_token" } }Auth parameters
Name Description access_tokenThe long-lived Access tokencarries the information necessary to access API resources.By using the Connect Card or through the Fivetran dashboard.
Zendesk Sell
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zendesk_sell",
"group_id": "target_group_id",
"config": {
"schema": "test_zendesk_sell"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying a value for
access_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "zendesk_sell", "group_id": "target_group_id", "config": { "schema": "zendesk_sell" }, "auth": { "access_token": "my_access_token" } }Auth parameters
Name Description access_tokenThe long-lived Access tokencarries the information necessary to access API resources.See Zendesk Sell's guide for instructions to generate the
access_token.By using the Connect Card or through the Fivetran dashboard.
Zendesk Sunshine
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zendesk_sunshine",
"group_id": "target_group_id",
"config": {
"schema": "zendesk_sunshine",
"domain": "domain",
"email": "email",
"api_token": "api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
domain | Zendesk domain. |
email | Zendesk email. |
api_token | Zendesk API tokens are auto-generated passwords in the Support admin interface. |
See Zendesk's guide for instructions to generate the api_token.
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
domain,emailandapi_token. - By using the Connect Card or the Fivetran dashboard.
Zendesk Support
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zendesk",
"group_id": "target_group_id",
"config": {
"schema": "zendesk",
"domain": "domain",
"email": "email",
"api_token": "api_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
domain | Zendesk domain. |
email | Zendesk email. |
api_token | Zendesk API tokens are auto-generated passwords in the Support admin interface. |
See Zendesk's guide for instructions to generate the api_token.
Authorization
There are three ways to authorize this connector type:
By specifying the values for the following fields in the request:
domain,emailandapi_token.By specifying a value for
access_tokenin theauthsection.POST https://api.fivetran.com/v1/connectors{ "service": "zendesk", "group_id": "target_group_id", "config": { "schema": "zendesk" }, "auth": { "access_token": "my_access_token" } }Auth parameters
Name Description access_tokenThe long-lived Access tokencarries the information necessary to access API resources.By using the Connect Card or the Fivetran dashboard.
The following example will allow you to configure the Zendesk API usage limit of an existing connector.
Request
PATCH https://api.fivetran.com/v1/connectors/{connector_id}
{
"config": {
"api_usage": 50.0
}
}
Path parameters
| Name | Description |
|---|---|
connector_id | The unique identifier for the connector. |
Config parameters
| Name | Description |
|---|---|
api_usage | The maximum allowed API usage in percentage. For example, 50.0. |
Zenefits Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zenefits",
"group_id": "target_group_id",
"config": {
"schema": "zenefits_schema_name",
"bearer_token": "your_zenefits_bearer_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
bearer_token | Your Zenefits bearer token. |
Authorization
There are two ways to authorize this connector type:
- By specifying a value for
bearer_tokenthe field in the request. - By using the Connect Card or the Fivetran dashboard.
Zingtree Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zingtree",
"group_id": "target_group_id",
"config": {
"schema": "zingtree_schema_name",
"api_key": "your_zingtree_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
api_key | Your Zingtree API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the value for the
api_keyfield in the request. - By using the Connect Card or the Fivetran dashboard.
Zip Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zip",
"group_id": "target_group_id",
"config": {
"schema": "zip_schema_name",
"sub_domain": "your_zip_subdomain",
"api_key": "your_zip_api_key"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
sub_domain | Your Zip subdomain. |
api_key | Your Zip API key. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
sub_domainandapi_key. - By using the Connect Card or the Fivetran dashboard.
Zoho Books Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zoho_books",
"group_id": "target_group_id",
"config": {
"schema": "zoho_books_schema_name",
"client_id": "your_zoho_books_client_id",
"client_secret": "your_zoho_books_client_secret",
"region": "your_zoho_books_region",
"organization_id": "your_zoho_books_organization_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Zoho Books client ID. |
client_secret | Your Zoho Books client secret. |
region | Your Zoho Books application host region. |
organization_id | Your Zoho Books Organization ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,regionandorganization_id. - By using the Connect Card or the Fivetran dashboard.
Zoho Campaigns Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zoho_campaigns",
"group_id": "target_group_id",
"config": {
"schema": "zoho_campaigns_schema_name",
"client_id": "your_zoho_campaigns_client_id",
"client_secret": "your_zoho_campaigns_client_secret",
"region": "your_zoho_campaigns_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Zoho Campaigns client ID. |
client_secret | Your Zoho Campaigns client secret. |
region | Your Zoho Campaigns application host region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret, andregion. - By using the Connect Card or the Fivetran dashboard.
Zoho CRM
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.
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zoho_crm",
"group_id": "target_group_id",
"config": {
"schema": "test_zoho",
"data_center": "data_center"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
data_center | Data center of the Zoho CRM account. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for
client_accessandrefresh_tokenin theauthsection.POST api.fivetran.com/v1/connectors{ "service": "zoho", "group_id": "target_group_id", "config": { "schema": "test_zoho", "data_center": "data_center" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth parameters
Name Description client_idClient IDof your Zoho client application.client_secretClient Secretof your Zoho client application.refresh_tokenThe long-lived Refresh token, along with theclient_idandclient_secretparameters, carries the information necessary to get a new access token for API resources.By using the Connect Card or through the Fivetran dashboard.
Required scopes
The following scopes are required for this connector:
- ZohoCRM.crmapi.READ
- ZohoCRM.modules.READ
- ZohoCRM.users.READ
- ZohoCRM.org.READ
- ZohoCRM.settings.READ
- ZohoCRM.bulk.READ
- ZohoCRM.notifications.READ
- ZohoCRM.coql.READ
Zoho Desk Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zoho_desk",
"group_id": "target_group_id",
"config": {
"schema": "zoho_desk_schema_name",
"client_id": "your_zoho_desk_client_id",
"client_secret": "your_zoho_desk_client_secret",
"region": "your_zoho_desk_region"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Your Zoho Desk client ID. |
client_secret | Your Zoho Desk client secret. |
region | Your Zoho Desk application host region. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secretandregion. - By using the Connect Card or the Fivetran dashboard.
Zoho Inventory Lite Private Preview
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zoho_inventory",
"group_id": "target_group_id",
"config": {
"schema": "zoho_inventory_schema_name",
"client_id": "your_zoho_inventory_client_id",
"client_secret": "your_zoho_inventory_client_secret",
"region": "your_zoho_inventory_region",
"organization_id": "your_zoho_books_organization_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id | Your Zoho Inventory client ID. |
client_secret | Your Zoho Inventory client secret. |
region | Your Zoho Inventory application host region. |
organization_id | Your Zoho Inventory organization ID. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
client_id,client_secret,region, andorganization_id. - By using the Connect Card or the Fivetran dashboard.
Zonka Feedback Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zonka_feedback",
"group_id": "target_group_id",
"config": {
"schema": "zonka_feedback_schema_name",
"data_center_id": "your_zonka_feedback_data_center_id",
"auth_token": "your_zonka_feedback_auth_token"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the group (destination). Required for connector creation. |
data_center_id | Your Zonka Feedback data center ID. |
auth_token | Your Zonka Feedback auth token. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
data_center_idandauth_token. - By using the Connect Card or the Fivetran dashboard.
Zoom Lite
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zoom",
"group_id": "target_group_id",
"config": {
"schema": "zoom_schema_name"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the following parameters in the
authsection:client_access,refresh_token, andaccess_token.POST https://api.fivetran.com/v1/connectors{ "service": "zoom", "group_id": "target_group_id", "config": { "schema": "freshbooks_schema_name" }, "auth": { "client_access": { "client_id": "zoom_client_id", "client_secret": "zoom_client_secret" }, "refresh_token": "zoom_refresh_token", "access_token": "zoom_access_token" } }Auth parameters
Name Description client_idYour Zoom client ID. client_secretYour Zoom client Secret. refresh_tokenYour Zoom refresh token. access_tokenYour Zoom access token. By using the Connect Card or the Fivetran dashboard.
Zuora
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zuora",
"group_id": "target_group_id",
"config": {
"schema": "test_zuora",
"client_id": "zuora_client_id",
"client_secret": "zuora_client_secret",
"is_multi_entity_feature_enabled": true,
"entity_id": "zuora_entity_id"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Zuora Client ID. |
client_secret | Zuora Client Secret. |
is_multi_entity_feature_enabled | Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false. |
entity_id | If is_multi_entity_feature_enabled is true, then it's EntityId. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,passwordandunique_id. - By using the Connect Card or the Fivetran dashboard.
Zuora Sandbox
Request
POST https://api.fivetran.com/v1/connectors
{
"service": "zuora_sandbox",
"group_id": "target_group_id",
"config": {
"schema": "test_zuora",
"client_id": "zuora_client_id",
"client_secret": "zuora_client_secret",
"is_multi_entity_feature_enabled": true,
"entity_id": "zuora_entity_id",
"environment": "zuora_sandbox_environment"
}
}
Config parameters
| Name | Description |
|---|---|
schema | The connector schema name has to be unique within the destination. Required for connector creation. |
client_id | Zuora Client ID. |
client_secret | Zuora Client Secret. |
is_multi_entity_feature_enabled | Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false. |
entity_id | If is_multi_entity_feature_enabled is true, then it's EntityId. |
environment | Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the following fields in the request:
username,passwordandunique_id. - By using the Connect Card or the Fivetran dashboard.