Connector Configlink

Updated 5 days ago

The connector setup configuration (config field) is different for each connector.

Most of the configuration fields documented in this section can be used both in the Create a connector and Modify a connector requests. The following fields as well as some other connector type-specific fields can only be used when creating a connector:

• schema
• table
• schema_prefix
• timeframe_months

The following connectors can be managed through the Fivetran REST API:

• 6sense
• 15Five
• 360Learning
• ActiveCampaign
• Acumatica
• Ada
• Adjust
• Adobe Analytics
• Adobe Analytics Data Feed
• Adobe Commerce
• ADP Workforce Now
• AdRoll
• Affinity
• Afterpay
• Aha
• Aircall
• Airtable
• Alchemer
• Algolia
• Amazon Ads
• Amazon Attribution
• Amazon Kinesis Firehose
• Amazon S3
• Amazon Selling Partner
• Amplitude
• Anaplan
• Apache Kafka
• Appcues
• Appfigures
• Apple App Store
• Apple Search Ads
• AppsFlyer
• Asana
• Assembled
• Attentive
• Attio
• Aumni
• Auth0
• Autodesk BIM 360
• AvantLink
• Awin
• AWS CloudTrail
• AWS Cost Explorer
• AWS Inventory
• AWS Lambda
• AWS MSK
• Azure Blob Storage
• Azure Boards
• Azure Devops
• Azure Functions
• Azure Event Hubs
• Azure Service Bus
• BallotReady
• BambooHR
• BigCommerce
• BigQuery
• BillingPlatform
• Birdeye
• Bitly
• Box
• Braintree
• Branch
• Braze
• Brevo
• Brex
• Buzzsprout
• Calabrio
• Calendly
• Canny
• Care Quality Commission
• Castor EDC
• Ceridian Dayforce
• Channel Advisor
• Chargebee Product Catalog 1.0
• Chargebee Product Catalog 2.0
• ChargeDesk
• Checkout.com
• Churnkey
• ChurnZero
• Cimis
• Cin7
• CircleCI
• Clari
• ClickUp
• CloudFront
• Coassemble
• Codefresh
• Collibra
• Confluence
• Confluent Cloud
• Contrast Security
• Copper
• Cosmos DB
• Coupa
• Criteo
• Crossbeam
• crowd.dev
• Customer.io
• Cvent
• D2L Brightspace
• dbt Cloud
• DCL Logistics
• DEAR
• Delighted
• Deputy
• Destini
• Dixa
• Docebo
• DocumentDB
• Drata
• Drift
• Drip
• Dropbox
• Dropbox Sign
• DynamoDB
• EasyPost
• e-conomic
• Eloqua
• Email
• Employment Hero
• Eventbrite
• Everhour
• Expensify
• EZOfficeInventory
• Facebook Ads
• Facebook Pages
• FinancialForce
• Firebase
• Fivetran Platform Connector
• Flexport
• Fone Dynamics
• Float
• Forj Community
• Fountain
• FreshBooks
• Freshchat
• Freshdesk
• Freshservice
• Friendbuy
• Front
• Freshteam
• FTP/FTPS
• FullStory
• Gainsight Customer Success
• Gem
• GetFeedback
• GitHub
• GitLab
• Gladly
• GlobalMeet
• GoCardless
• Gong
• Google Ad Manager
• Google Ads
• Google Analytics
• Google Analytics 4
• Google Analytics 4 Export
• Google Analytics 360
• Google Analytics (MCF)
• Google Calendar
• Google Campaign Manager 360
• Google Cloud Functions
• Google Cloud Storage
• Google Display & Video 360
• Google Drive
• Google Play
• Google Search Ads 360
• Google Search Console
• Google Sheets
• Gorgias
• Greenhouse
• GreenPowerMonitor
• Grepsr
• GRIN
• Guru
• Happyfox
• Harvest
• Heap
• Height
• Help Scout
• Helpshift
• Heroku Kafka
• HiBob
• High-Volume Agent Db2 for i
• High-Volume Agent Oracle
• High-Volume Agent SAP ECC on Db2 for i
• High-Volume Agent SAP ECC on Hana
• High-Volume Agent SAP ECC on Hana With NetWeaver
• High-Volume Agent SAP ECC on Oracle
• High-Volume Agent SAP ECC on Oracle With NetWeaver
• High-Volume Agent SAP S/4Hana
• High-Volume Agent SAP S/4Hana With Netweaver
• High-Volume Agent SAP B1 on HANA
• High-Volume Agent SQL Server
• Hopin
• HubSpot
• iLevel
• Impact
• incident.io
• Infobip
• Insightly
• Instagram Business
• Integral Ad Science
• Integrate
• Intercom
• Ironclad
• ironSource
• Iterable
• Jira
• Jira Align
• Jotform
• JustCall
• Kandji
• Katana
• Keypay
• Khoros Care
• Kissmetrics
• Klarna
• Klaviyo
• KnowBe4
• Konnect Insights
• Kustomer
• Lattice
• LaunchDarkly
• LearnUpon
• Lessonly
• Lever
• Liftoff
• Lightspeed Retail
• Linear
• LinkedIn Ad Analytics
• LinkedIn Company Pages
• LiveChat
• LinkSquares
• LiveChat
• Looker
• Loop
• Loopio
• Luma
• Mailchimp
• Mailgun
• Mandrill
• MariaDB
• Marin Software
• Marketo
• Mavenlink
• Maxio Chargify
• Medallia
• Megaphone
• Meltwater
• Mention
• Microsoft Advertising
• Microsoft Dynamics 365 Business Central
• Microsoft Dynamics 365 CRM
• Microsoft Dynamics 365 Finance
• Microsoft Lists
• Microsoft Teams
• Mixpanel
• Mixmax
• MNTN
• Mode
• Moloco
• MongoDB
• MySQL
• Mux
• Namely
• Navan
• Notion
• NetSuite SuiteAnalytics
• Nylas
• Okta
• Ometria
• OneDrive
• Open Exchange Rates
• Opsgenie
• Optimizely
• Oracle
• Oracle Business Intelligence Publisher
• Oracle Fusion CRM
• Oracle Fusion FSCM
• Oracle Fusion HCM
• Oracle Moat Analytics
• Orbit
• Ordway
• Ortto
• Outbrain
• Outreach
• PagerDuty
• PandaDoc
• Papershift
• Pardot
• PartnerStack Vendor
• Paychex
• PayPal
• Pendo
• Persona
• Personio
• Pingdom
• Pinpoint
• Pinterest Ads
• Pipedrive
• Pivotal Tracker
• Piwik PRO
• Playvox
• PostgreSQL
• PostHog
• PowerReviews Enterprise
• Prive
• Productboard
• Qualaroo
• Qualtrics
• QuickBooks
• Recharge
• Recurly
• Reddit Ads
• Redshift
• Reltio
• Reply.io
• RetailNext
• Retently
• Revel Systems
• RevOps
• RevX
• RingCentral
• Rippling
• Rollbar
• Rootly
• RTB House
• Sage HR
• Sage Intacct
• Sailthru
• Salesforce
• Salesforce Commerce Cloud
• Salesforce Marketing Cloud
• Salesloft
• Salsify
• Samsara
• SAP Business ByDesign
• SAP Concur
• SAP HANA
• SAP SuccessFactors
• SAP S/4
• SCORM
• Security Journey
• Segment
• SendGrid
• ServiceNow
• ServiceTitan
• Sensor Tower
• SFTP
• SharePoint
• ShipHero
• ShipStation
• Shopify
• Shortcut
• Shopware
• Short.io
• Simplecast
• Simplesat
• Skilljar
• Skuvault
• Slab
• Slack
• Smadex
• Smartwaiver
• Snapchat Ads
• Snowflake
• Snowplow
• Sonarqube
• Split
• Splunk
• Spotify Ads
• Sprout Social
• SQL Server
• Square
• Squarespace
• StackAdapt
• Standard Metrics
• Statuspage
• Stripe
• Stylight
• Subscript
• SugarCRM
• SurveyMonkey
• Survicate
• Swoogo
• Tableau
• Taboola
• Talkdesk
• Talkwalker
• Teamwork
• Tempo
• The Trade Desk
• Thinkific
• TikTok Ads
• Toggl Track
• Transcend
• Trello
• Trisolute
• Twilio
• Twitter Organic
• Twitter Ads
• Typeform
• Unicommerce
• Upland Software
• UpPromote
• UserVoice
• Verizon Media
• Vitally
• Vonage
• VWO
• Wasabi Cloud Storage
• Webhooks
• When I Work
• Wherefour
• WooCommerce
• WordPress
• Workable
• Workday Financial Management
• Workday HCM
• Workday RaaS
• Workday Strategic Sourcing
• WorkflowMax
• WorkRamp
• Wrike
• Xero
• Xray
• Yahoo DSP
• Yahoo Search Ads on Yahoo Japan
• Yotpo
• YouTube Analytics
• Zendesk Chat
• Zendesk Sell
• Zendesk Sunshine
• Zendesk Support
• Zenefits
• Zoho Books
• Zoho Campaigns
• Zoho CRM
• Zoho Desk
• Zoom
• Zuora
• Zuora Sandbox

6sense Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "6sense",
   "group_id": "target_group_id",
   "config": {
      "schema": "6sense_schema_name",
      "api_key": "your_6sense_API_Key"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying a value for the api_key field in the request.
2. By using the Connect Card or the Fivetran dashboard.

15Five Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "15five",
   "group_id": "target_group_id",
   "config": {
      "schema": "15five_schema_name",
      "api_key": "your_15five_api_key"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying a value for the api_key field in the request.
2. By using the Connect Card or the Fivetran dashboard.

360Learning Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "360learning",
   "group_id": "target_group_id",
   "config": {
      "schema": "360learning_schema_name",
      "api_key": "your_360learning_api_key",
      "company_id": "your_comapny_id"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: api_key and company_id.
2. By using the Connect Card or the Fivetran dashboard.

ActiveCampaign Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "activecampaign",
   "group_id": "target_group_id",
   "config": {
      "schema": "activecampaign_schema_name",
      "api_key": "your_activecampaign_api_key",
      "sub_domain": "http://your.sub.domain/"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: api_key and sub_domain.
2. By using the Connect Card or the Fivetran dashboard.

Acumatica Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "acumatica",
   "group_id": "target_group_id",
   "config": {
      "schema": "acumatica_schema_name",
      "sub_domain": "your_acumatica_subdomain",
      "client_id": "your_acumatica_client_id",
      "client_secret": "your_acumatica_client_secret",
      "instance": "your_acumatica_instance_name"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: sub_domain, client_id, client_secret, and instance.
2. By using the Connect Card or the Fivetran dashboard.

Ada Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "ada",
   "group_id": "target_group_id",
   "config": {
      "schema": "ada_schema_name",
      "bearer_token": "your_ada_bearer_token",
      "sub_domain": "your_bot_handle"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: bearer_token and sub_domain.
2. By using the Connect Card or the Fivetran dashboard.

Adjust link

The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth section to the request body and define its parameters or perform other actions depending on the authorization type.

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "adjust",
    "group_id": "target_group_id",
    "config": {
        "schema": "adjust"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for csv_definition, export_storage_type, bucket_name, and s3_role_arn (optional) in the auth section.

   POST https://api.fivetran.com/v1/connectors

    {
     "service": "adjust",
         "group_id": "target_group_id",
         "config": {
             "schema": "adjust"           
          },
       "auth": {
          "csv_definition" : "my export definition",
          "export_storage_type" : "AWS_S3 or GCS",
          "bucket_name": "bucket",
          "s3_role_arn" : "role_arn"
         }
    }
   content_copy

   Auth parameterslink

   Name	Description	Possible Values
   csv_definition	CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition).
   export_storage_type	Your cloud storage.	GCS, AWS_S3
   bucket_name	Your AWS S3 or GCS bucket.
   s3_role_arn	Used if the export_storage_type is AWS_S3, the Role ARN required for authentication.

   NOTE: If export_storage_type is GCS is, then you will need to grant Fivetran access to your Google Cloud Storage bucket.

2. By using the Connect Card or the Fivetran dashboard.

Adobe Analytics link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "adobe_analytics",
   "group_id": "target_group_id",
   "config": {
      "schema": "adobe_analytics",
      "client_id": "clientId",
      "client_secret": "clientSecret",
      "technical_account_id": "technicalAccountId",
      "organization_id": "organizationId",
      "private_key": "privateKey",
      "date_granularity": "HOUR",
      "timeframe_months": "THREE",
      "adobe_analytics_configurations": [
         {
            "table": "test_table",
            "sync_mode": "SpecificReportSuites",
            "report_suites": [
               "test_report_suites"
            ],
            "elements": [
               "variables/daterangeweek"
            ],
            "metrics": [
               "metrics/videoplay"
            ],
            "calculated_metrics": [
               "cm300009702_5f3af08b41e485452a641b88"
            ],
            "segments": [
               "s300009702_5f3a8781f882e4754a131377"
            ]
         }
      ]
   }
}
content_copy

Config parameterslink

Authorizationlink

This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.

Adobe Analytics Data Feed link

The Adobe Analytics Data Feed connector supports the following cloud file storage services as a source:

• Amazon S3
• Azure Blob Storage
• FTP/FTPS
• SFTP

The API requests are source-specific.

Amazon S3 Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "adobe_analytics_data_feed",
    "group_id": "target_group_id",
    "config": {
        "schema": "adobe_analytics_data_feed_s3",
        "source": "S3",
        "s3bucket": "bucket",
        "s3role_arn": "role_arn"
    }
}
content_copy

Config parameterslink

Amazon S3 Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: s3bucket, s3role_arn and source.
2. By using the Connect Card or the Fivetran dashboard.

Azure Blob Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "adobe_analytics_data_feed",
    "group_id": "target_group_id",
    "config": {
        "schema": "adobe_analytics_data_feed_blob",
        "source": "AZURE_BLOB_STORAGE",
        "abs_connection_string": "connection_string",
        "abs_container_name": "container_name", 
        "abs_connection_method": "SSH_TUNNEL", 
        "abs_container_address": "fivetran.blob.windows.net", 
        "abs_host_ip": "13.120.106.58", 
        "abs_host_user": "fivetran",
    }
}
content_copy

Config parameterslink

Azure Blob Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: abs_connection_string, abs_container_name and source.
2. By using the Connect Card or the Fivetran dashboard.

Azure Service Bus link

POST https://api.fivetran.com/v1/connectors

{
    "service": "azure_service_bus",
    "group_id": "target_group_id",
    "config": {
        "schema": "schema_name",
        "auth_type": "connection_string",
        "has_manage_permissions": "false",
        "subscriber_name": "subscriber_name",
        "message_type": "text",
        "sync_type": "packed",
        "schema_registry_urls" : ["serveraddress1:8080, serveraddress2:8080"],
        "schema_registry_key" : "schema_registry_key",
        "schema_registry_secret" : "schema_registry_secret",
        "connection_method" : "direct",
        "topics" : ["topic1", "topic2"],
        "namespace" : "my_namespace"
    },
    "auth":  {
        "connection_string": "Connection String",
        "client_access" : {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "refresh_token"
    }
}
content_copy

Config parameterslink

Auth parameterslink

Azure Service Bus Authorizationlink

There are three ways to authorize this connector type:

1. By providing the connection string in the auth field when auth_type is ConnectionString.
2. By specifying values for access_token, refresh_token, and scope when auth_type is AzureActiveDirectory.
3. By using the Connect Card or the Fivetran dashboard when auth_type is AzureActiveDirectory.

FTP(S) Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "adobe_analytics_data_feed",
    "group_id": "target_group_id",
    "config": {
        "schema": "adobe_analytics_data_feed_ftp",
        "source": "FTP",
        "ftp_host": "host",
        "ftp_port": 21,
        "ftp_user": "user",
        "ftp_password": "password",
        "is_ftps": true
    }
}
content_copy

Config parameterslink

FTP(S) Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: ftp_host, ftp_port, ftp_user, ftp_password and source.
2. By using the Connect Card or the Fivetran dashboard.

SFTP Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "adobe_analytics_data_feed",
    "group_id": "target_group_id",
    "config": {
        "schema": "adobe_analytics_data_feed_sftp",
        "source": "SFTP",
        "sftp_host": "host",
        "sftp_port": 22,
        "sftp_user": "user",
        "sftp_password": "password",
        "sftp_is_key_pair": true
    }
}
content_copy

Config parameterslink

SFTP Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: sftp_host, sftp_port, sftp_user, sftp_password and source.
2. By using the Connect Card or the Fivetran dashboard.

Adobe Commerce Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "adobe_commerce",
   "group_id": "target_group_id",
   "config": {
      "schema": "adobe_commerce_schema_name",
      "host_url": "your.host.url.com",
      "username": "your_adobe_commerce_username",
      "password": "your_adobe_commerce_password"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: host_url, username and password.
2. By using the Connect Card or the Fivetran dashboard.

ADP Workforce Now link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "adp_workforce_now",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_adp_workforce_now",
        "client_id": "test_client_id",
        "client_secret": "test_client_secret",
        "ws_certificate": "xxxxx-xxxxx-xxxxx-xxxxx",
        "private_key": "xxxxx-xxxxx-xxxxx-xxxxx"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: client_id, client_secret, ws_certificate and private_key .
2. By using the Connect Card or the Fivetran dashboard.

AdRoll link

The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth section to the request body and define its parameters or perform other actions depending on the authorization type.

Requestlink

POST https://api.fivetran.com/v1/connectors

{
  "service" : "adroll",
  "group_id": "target_group_id",
  "config": {
      "schema": "adroll",
      "table": "table", 
      "sync_mode" : "SpecificAdvertisables",
      "advertisables": ["adv1","adv2"],
      "report_type" : "ALL_CAMPAIGNS",
      "dimensions": ["eid","campaigns"],
      "metrics": ["impressions","cost"],
      "timeframe_months": "THREE"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for client_access and refresh_token in the auth section.

   POST https://api.fivetran.com/v1/connectors

   {
       "service" : "adroll",
         "group_id": "target_group_id",
         "config": {
             "schema": "adroll",
             "table": "table", 
             "sync_mode" : "SpecificAdvertisables",
             "advertisables": ["adv1","adv2"],
             "report_type" : "ALL_CAMPAIGNS",
             "dimensions": ["eid","campaigns"],
             "metrics": ["impressions","cost"],
             "timeframe_months": "THREE"
           },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   content_copy

   Auth parameterslink

   Name	Description
   client_id	Client ID of your AdRoll client application.
   client_secret	Client Secret of your AdRoll client application.
   refresh_token	The long-lived Refresh token along with the client_id and client_secret parameters carry the information necessary to get a new access token for API resources.

2. By using the Connect Card or through the Fivetran dashboard.

Affinity Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "affinity",
   "group_id": "target_group_id",
   "config": {
      "schema": "affinity_schema_name",
      "api_key": "your_affinity_api_key"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying a value for the api_key field in the request.
2. By using the Connect Card or the Fivetran dashboard.

Afterpay Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "afterpay",
   "group_id": "target_group_id",
   "config": {
      "schema": "afterpay_schema_name",
      "api_environment": "your_afterpay_api_environment",
      "merchant_id": "your_afterpay_merchant_id",
      "secret_key": "your_afterpay_secret_key"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: api_environment,merchant_id and secret_key.
2. By using the Connect Card or the Fivetran dashboard.

Aha Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "aha",
   "group_id": "target_group_id",
   "config": {
      "schema": "aha_schema_name",
      "base_url": "your_aha_base_url",
      "api_token": "your_aha_api_token"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: base_url and api_token.
2. By using the Connect Card or the Fivetran dashboard.

Aircall Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "aircall",
   "group_id": "target_group_id",
   "config": {
      "schema": "aircall_schema_name",
      "api_id": "your_aircall_api_id",
      "api_token": "your_aircall_api_token"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: api_id and api_token.
2. By using the Connect Card or the Fivetran dashboard.

Airtable link

IMPORTANT: Airtable connectors created on or after June 14, 2023, must authenticate using OAuth 2.0.

Requestlink

OAuth 2.0 authenticationlink

   {
       "service": "airtable",
       "group_id": "target_group_id",
       "config": {
         "schema_prefix": "test_airtable"
       },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
content_copy

Config parameterslink

API key authenticationlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "airtable",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix" : "test_airtable",
        "api_key" : "****"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are three ways to authorize this connector type:

1. By specifying the following fields in the request:
   • For Airtable enterprise accounts: api_key.
   • For Airtable non-enterprise accounts: base_id, table_name and api_key.
2. By specifying client_access and refresh_token in the auth section.
3. By using the Connect Card or the Fivetran dashboard.

Alchemer Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "alchemer",
   "group_id": "target_group_id",
   "config": {
      "schema": "alchemer_schema_name",
      "query_param_value": "your_alchemer_api_key",
      "api_secret_key": "your_alchemer_api_secret_key",
      "sub_domain": "Subdomain name like .com,.eu,-ca.com"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: query_param_value,api_secret_key and sub_domain.
2. By using the Connect Card or the Fivetran dashboard.

Algolia Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "algolia",
   "group_id": "target_group_id",
   "config": {
      "schema": "algolia_schema_name",
      "region": "your_algolia_region",
      "application_id": "your_algolia_application_id",
      "api_key": "your_algolia_api_key"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: region, application_id, and api_key.
2. By using the Connect Card or the Fivetran dashboard.

Amazon Ads link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "amazon_ads",
   "group_id": "target_group_id",
   "config": {
       "schema": "test_amazon_ads",
       "region": "NORTH_AMERICA",
       "sync_mode": "SpecificProfiles",
       "profiles": [12345],
       "attribution_window": "DAY_7"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for client_access and refresh_token in the auth section.

   POST https://api.fivetran.com/v1/connectors

   {
       "service": "amazon_ads",
       "group_id": "target_group_id",
       "config": {
           "schema": "test_amazon_ads",
           "region": "NORTH_AMERICA",
           "sync_mode": "SpecificProfiles",
           "profiles": [12345],
           "attribution_window": "DAY_7"
       },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   content_copy

   Auth parameterslink

   Name	Description
   client_id	Client ID of your Amazon Ads client application.
   client_secret	Client Secret of your Amazon Ads client application.
   refresh_token	The long-lived Refresh token along with the client_id and client_secret parameters carry the information necessary to get a new access token for API resources.

2. By using the Connect Card or through the Fivetran dashboard.

Amazon Attribution Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "amazon_attribution",
   "group_id": "target_group_id",
   "config": {
      "schema": "amazon_attribution_schema_name",
      "region_api_url": "your_amazon_attribution_region_api_url",
      "region_token_url": "your_amazon_attribution_region_token_url",
      "region_auth_url": "your_amazon_attribution_region_auth_url"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following fields in the request: region_api_url,region_token_url,region_auth_url.
2. By using the Connect Card or the Fivetran dashboard.

Amazon Kinesis Firehose link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "kinesis",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_kinesis",
        "table": "kinesis_table",
        "role_arn": "arn::your_role_arn",
        "bucket": "aws_region_code",
        "prefix": "folder_path",
        "json_delivery_mode": "Packed"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: role_arn and bucket.
2. By using the Connect Card or the Fivetran dashboard.

Amazon S3 link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "s3",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_s3",
        "table": "table_name",
        "bucket": "bucket_name",
        "auth_type": "IAM_ROLE",
        "external_id": "group_id",
        "role_arn": "arn::your_role_arn",
        "access_key_id":"access_key_id_value",
        "access_key_secret":"access_key_secret_value",
        "prefix": "folder_path",
        "pattern": "file_pattern",
        "file_type": "infer",
        "json_delivery_mode": "Packed",
        "compression": "infer",
        "on_error": "skip",
        "append_file_option": "upsert_file",
        "archive_pattern": "regex_pattern",
        "null_sequence": "",
        "delimiter": "",
        "escape_char": "",
        "skip_before": "0",
        "skip_after": "0",
        "empty_header": "false",
        "list_strategy": "complete_listing",
        "use_pgp_encryption_options": "true",
        "pgp_secret_key": "<secret-key-used>",
        "pgp_pass_phrase": "<pass-phrase-used>",
        "signer_public_key": "<signer-public-key-used>",
        "line_separator": ";"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the value for the bucket field along with the following fields depending on the auth_type:

   • If IAM_ROLE, specify values for the external_id and role_arn fields.
   • If ACCESS_KEY, specify values for the access_key_id and access_key_secret fields.

2. By using the Connect Card or the Fivetran dashboard.

Amazon Selling Partner Betalink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "amazon_selling_partner",
   "group_id": "target_group_id",
   "config": {
       "schema": "test_amazon_selling_partner",
       "region": "NORTH_AMERICA",
       "merchant_id" : "test_merchant_id",
       "is_vendor" :false
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following parameters in the auth section.

   POST https://api.fivetran.com/v1/connectors

   {
       "service": "amazon_selling_partner",
       "group_id": "target_group_id",
       "config": {
            "schema": "test_amazon_selling_partner",
            "region": "NORTH_AMERICA",
            "merchant_id" : "test_merchant_id",
            "is_vendor" : false
       },
       "auth": {
           "aws_access_key" : "my_aws_access_key",
           "aws_secret_key" : "my_aws_secret_key",
           "role_arn" : "my_iam_role_arn",
           "client_id": "my_client_id",
           "client_secret": "my_client_secret",
           "refresh_token": "my_refresh_token"
       }
   }
   content_copy

   Auth parameterslink

   Name	Description
   aws_access_key	AWS Access Key of your AWS Account User.
   aws_secret_key	AWS Secret Key of your AWS Account User.
   role_arn	IAM Role ARN of your AWS Account.
   client_id	Client ID of your Amazon Seller/Vendor Central client application.
   client_secret	Client Secret of your Amazon Seller/Vendor Central client application.
   refresh_token	The long-lived Refresh token along with the client_id and client_secret parameters carry the information necessary to get a new access token for API resources.

2. By using the Connect Card or the Fivetran dashboard.

Amplitude link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "amplitude",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_amplitude",
        "project_credentials": [
            {
              "project": "projectName1",
              "api_key": "apiKey1",
              "secret_key": "secretKey1"
            },
            {
              "project": "projectName2",
              "api_key": "apiKey2",
              "secret_key": "secretKey2"
            }
        ]
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. When creating by specifying a value for the following field in the request: projects;
2. After creation using the Connect Card or the Fivetran dashboard.

Anaplan link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "anaplan",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_anaplan",
        "auth_mode": "basic",
        "username": "username",
        "password": "password",
        "certificate": "xxxxx-xxxxx-xxxxx-xxxxx",
        "private_key": "your_api_secret",
        "sync_mode": "SpecificExports",
        "selected_exports": [ "8a81b00f68d4b4c50168dc49db4520d4_4CCDDEC7E28C4D3CA4212986182B8EB1_116000000000" ]
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. When creating, depending on the auth-mode:

   • If Basic, by specifying the values for the username and password fields.
   • If Certificate, by specifying the values for the certificate and private_key fields.

2. After creation using the Connect Card or the Fivetran dashboard.

Apache Kafka link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "apache_kafka",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_apache_kafka",
        "consumer_group": "consumer_group",
        "servers": "serveraddress1:8080, serveraddress2:8080",
        "message_type": "Json",
        "sync_type": "Packed",
        "security_protocol": "SSL"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: consumer_group and servers.
2. By using the Connect Card or the Fivetran dashboard.

Appcues Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "appcues",
   "group_id": "target_group_id",
   "config": {
      "schema": "appcues_schema_name",
      "api_key": "your_appcues_api_key",
      "secret": "your_appcues_secret",
      "account_id": "your_appcues_account_id",
      "email": "your_appcues_email"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following fields in the request: api_key, secret, account_id and email.
2. By using the Connect Card or the Fivetran dashboard.

Appfigures Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "appfigures",
   "group_id": "target_group_id",
   "config": {
      "schema": "appfigures_schema_name",
      "client_key": "your_appfigures_client_key",
      "username": "your_appfigures_username",
      "password": "your_appfigures_password"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: client_key,username, and password.
2. By using the Connect Card or the Fivetran dashboard.

Apple App Store link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "itunes_connect",
    "group_id": "target_group_id",
    "config": {
        "schema": "itunes_connect",
        "username": "user",
        "password": "password",  
        "app_specific_password": "your_app_specific_password",
        "apps": ["iTunes_app"],
        "sales_accounts": ["iTunes_sales_account"],
        "finance_accounts": ["iTunes_finance_account"],
        "app_sync_mode" : "SpecificApps",
        "sales_account_sync_mode": "SpecificSalesAccounts",
        "finance_account_sync_mode": "SpecificFinanceAccounts",
        "timeframe_months": "THREE"
    }
}
content_copy

Config parameterslink

Apple Search Ads link

The following example allows you to create a new connector without authorization. If you want to authorize your connector during its creation, use one of the possible authorization methods in the Authorization section.

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "apple_search_ads",
    "group_id": "target_group_id",
    "config": {
        "schema" : "apple_search_ads"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are three ways to authorize this connector type:

1. By specifying the values for the pem_certificate and private_key fields in the request.

   POST https://api.fivetran.com/v1/connectors

   {
       "service": "apple_search_ads",
       "group_id": "target_group_id",
       "config": {
           "schema": "apple_search_ads",
           "pem_certificate": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
           "private_key": "your_api_secret"
       }
   }
   content_copy

2. By specifying is_auth2_enabled as true and specifying values for the following fields client_id, team_id, key_id and pem_private_key.

   POST https://api.fivetran.com/v1/connectors

   {
       "service": "apple_search_ads",
       "group_id": "target_group_id",
       "config": {
           "schema": "apple_search_ads",
           "is_auth2_enabled": true,
           "pem_private_key": "your_api_secret",
           "client_id": "your_api_client_id",
           "team_id": "your_api_team_id",
           "key_id": "your_api_key_id",
           "timeframe_months": "TWELVE"
       }
   }
   content_copy

3. By using the Connect Card or the Fivetran dashboard.

AppsFlyer link

Requestlink

POST https://api.fivetran.com/v1/connectors

Sync using webhooks and Data Lockerlink

{
    "service": "appsflyer",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_appsflyer",
        "access_key_id": "your_access_key_id",
        "secret_key": "your_secret_key",
        "home_folder": "your_home_folder",
        "connection_name": "your_connection_name",
        "sync_data_locker": true,
        "use_customer_bucket": true,
        "bucket": "af-datalocker-your-bucket-name",
        "role_arn": "role_arn_value"
    }
}
content_copy

Config parameterslink

Sync using webhooks and Pull APIlink

{
    "service": "appsflyer",
    "group_id": "target_group_id",
    "config": {
       "schema": "test_appsflyer",
       "sync_data_locker": false,
       "sync_pull_api": true,
       "api_token": "your_appsflyer_api_token",
       "app_ids": [
          {"app_id": "appID1"},
          {"app_id": "appID2"}
       ]
    }
}
content_copy

Config parameterslink

Sync using only webhookslink

{
    "service": "appsflyer",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_appsflyer",
        "sync_data_locker": false
    }
}
content_copy

Config parameterslink

Authorizationlink

There are three ways to authorize this connector type:

1. By specifying the values for the following fields in the request: access_key_id, secret_key, home_folder and connection_name, if you are connecting using webhooks and Data Locker.
2. By specifying the field sync_data_locker as false, if you are connecting using only webhooks.
3. By using the Connect Card or the Fivetran dashboard.

Asana link

The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth section to the request body and define its parameters or perform other actions depending on the authorization type.

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "asana",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_asana",
        "sync_mode": "SpecificProjects",
        "projects": ["12345678", "23456789"]
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for client_access and refresh_token in the auth section.

   POST https://api.fivetran.com/v1/connectors

   {
       "service": "asana",
           "group_id": "target_group_id",
           "config": {
               "schema": "test_asana",
               "sync_mode": "SpecificProjects",
               "projects": ["12345678", "23456789"]
           },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   content_copy

   Auth parameterslink

   | Name | Description | |---|---| | client_id | Client ID of your Asana client application. | | client_secret | Client Secret of your Asana client application. | | refresh_token | The long-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. |

2. By using the Connect Card or through the Fivetran dashboard.

Assembled Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "assembled",
   "group_id": "target_group_id",
   "config": {
      "schema": "assembled_schema_name",
      "api_key": "your_assembled_api_key"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: api_key.
2. By using the Connect Card or the Fivetran dashboard.

Attentive Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "attentive",
   "group_id": "target_group_id",
   "config": {
      "schema": "attentive_schema_name",
      "api_key": "your_attentive_api_key"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying a value for the api_key field in the request.
2. By using the Connect Card or the Fivetran dashboard.

Attio Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
  "service": "attio",
  "group_id": "target_group_id",
  "config": {
     "schema": "attio_schema_name",
     "access_token": "your_attio_access_token"
  }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying a value for the access_token field in the request.
2. By using the Connect Card or the Fivetran dashboard.

Aumni Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "aumni",
   "group_id": "target_group_id",
   "config": {
      "schema": "aumni_schema_name",
      "api_key": "your_aumni_api_key"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the value for the api_key field in the request.
2. By using the Connect Card or the Fivetran dashboard.

Auth0 Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "auth0",
   "group_id": "target_group_id",
   "config": {
      "schema": "auth0_schema_name",
      "client_id": "your_auth0_client_id",
      "client_secret": "your_auth0_client_secret",
      "domain": "your_auth0_domain",
      "audience": "your_auth0_audience"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: client_id,client_secret,domain and audience.
2. By using the Connect Card or the Fivetran dashboard.

Autodesk BIM 360 Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "autodesk_bim_360",
   "group_id": "target_group_id",
   "config": {
      "schema": "autodesk_bim_360_schema_name"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the client_access parameter in the auth section.

   POST https://api.fivetran.com/v1/connectors

   {
      "service": "autodesk_bim_360",
      "group_id": "target_group_id",
      "config": {
         "schema": "autodesk_bim_360_schema_name"
      },
      "auth": {
          "client_access": {
              "client_id": "autodesk_bim_360_client_id",
              "client_secret": "autodesk_bim_360_client_secret"
          },
          "refresh_token": "your_refresh_token",
          "access_token": "your_access_token"
      }
   }
   content_copy

   Auth parameterslink

   Name	Description
   client_access.client_id	Your Autodesk BIM 360 client ID.
   client_access.client_secret	Your Autodesk BIM 360 client secret.
   refresh_token	Your Autodesk BIM 360 refresh token.
   access_token	Your Autodesk BIM 360 access token.

2. By using the Connect Card or the Fivetran dashboard.

AvantLink Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
  "service": "avantlink",
  "group_id": "target_group_id",
  "config": {
    "schema": "avantlink_schema_name",
    "api_key": "your_avantlink_api_key",
    "merchant_id": "your_avantlink_merchant_id"
  }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: api_key and merchant_id.
2. By using the Connect Card or the Fivetran dashboard.

Awin Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "awin",
   "group_id": "target_group_id",
   "config": {
      "schema": "awin_schema_name",
      "api_token": "your_awin_api_token",
      "region": "your_awin_region"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: api_token and region.
2. By using the Connect Card or the Fivetran dashboard.

AWS CloudTrail link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "aws_cloudtrail",
    "group_id": "1k56c2c4xlti6",
    "config": {
        "schema": "aws_cloudtrail_1",
        "external_id": "1k56c2c4xlti6",
        "bucket" : "fivetran-cloudtrail",
        "role_arn": "arn:aws:iam::***********",
        "prefix" : "test_prefix"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: external_id, role_arn and bucket.
2. By using the Connect Card or the Fivetran dashboard.

AWS Cost Explorer Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "aws_cost",
    "group_id": "target_group_id",
    "config": {
        "schema": "aws_cost",
        "role_arn": "arn::your_role_arn"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: role_arn.
2. By using the Connect Card or the Fivetran dashboard.

AWS Inventory link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "aws_inventory",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_aws_inventory",
        "bucket" : "fivetran-config",
        "role_arn": "arn:aws:iam::***********",
        "prefix" : "test_prefix"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: role_arn and bucket.
2. By using the Connect Card or the Fivetran dashboard.

AWS Lambda link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "aws_lambda",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_lambda",
        "function": "function_name",
        "sync_method": "DIRECT",
        "role_arn": "arn::your_role_arn",
        "bucket": "bucket",
        "external_id": "group_id",
        "region": "aws_region_code",
        "is_privatelink_required" : "false",
        "secrets_list": [
            {"key": "secret1", "value": "xxxxxxx"},
            {"key": "secret2", "value": "xxxxxxx"}
        ],
        "custom_payloads": [
            {"key": "payload1", "value": "payload_value2"},
            {"key": "payload2", "value": "payload_value2"}
        ]
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: function, role_arn and secrets_list.

2. By using the Connect Card or the Fivetran dashboard.

AWS MSK link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "aws_msk",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_msk",
        "consumer_group": "consumer_group",
        "servers": ["serveraddress1:8080", "serveraddress2:8080"],
        "message_type": "Json", 
        "sync_type": "Packed",  
        "security_protocol": "SASL",  
        "sasl_mechanism" : "SCRAM_SHA_512",
        "sasl_scram512_key": "sasl_key",
        "sasl_scram512_secret": "sasl_secret",
        "external_id": "group_id",
        "role_arn": "arn::your_role_arn",
        "truststore": "test_truststore",
        "keystore": "test_keystore",
        "keystore_password": "keystore_password",
        "key_password": "key_password",
        "connection_method": "direct"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By passing the security protocol secrets:

   • If you select TLS as Security Protocol, upload the Trusted Certificate, Client Certificate, and Client Certificate Key files.
   • If you select SASL as Security Protocol and SCRAM_SHA_512 as SASL Mechanism, enter your secret's saslScram512Key and saslScram512Secret.
   • If you select SASL as Security Protocol and IAM as SASL Mechanism, enter your External ID and Role ARN.

2. By using the Connect Card or the Fivetran dashboard.

Azure Blob Storage link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "azure_blob_storage",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_azure_blob_storage",
        "table": "table_name",
        "container_name": "container_name",
        "connection_string": "BlobEndpoint=https://abc123.blob.core.windows.net/;TableEndpoint=https://abc123.table.core.windows.net/;SharedAccessSignature=xxxxxxxxx",
        "prefix": "folder_path",
        "pattern": "file_pattern",
        "file_type": "infer",
        "json_delivery_mode": "Packed",
        "compression": "infer",
        "on_error": "skip",
        "append_file_option": "upsert_file",
        "archive_pattern": "regex_pattern",
        "null_sequence": "",
        "delimiter": "",
        "escape_char": "",
        "skip_before": "0",
        "skip_after": "0",
        "connection_method": "SSH_TUNNEL",
        "container_address": "192.168.0.1",
        "host_ip": "192.168.0.2",
        "host_user": "host_username",
        "use_pgp_encryption_options": "false",
        "pgp_secret_key": "<secret-key-used>",
        "pgp_pass_phrase": "<pass-phrase-used>",
        "signer_public_key": "<signer-public-key-used>",
        "line_separator": ";"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: container_name and connection_string.
2. By using the Connect Card or the Fivetran dashboard.

Azure Boards Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
  "service": "azure_boards",
  "group_id": "target_group_id",
  "config": {
    "schema": "azure_boards_schema_name",
    "sub_domain": "your_azure_boards_organization_name"
  }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the client_access parameter in the auth section.

   POST https://api.fivetran.com/v1/connectors

   {
      "service": "azure_boards",
      "group_id": "target_group_id",
      "config": {
         "schema": "azure_boards_schema_name",
         "sub_domain": "your_azure_boards_organization_name"
      },
      "auth": {
          "client_access": {
              "client_id": "your_azure_boards_client_id",
              "client_secret": "your_azure_boards_client_secret"
          }
      }
   }
   content_copy

   Auth parameterslink

   Name	Description
   client_access.client_id	Your Azure Boards Client ID.
   client_access.client_secret	Your Azure Boards Client Secret.

2. By using the Connect Card or the Fivetran dashboard.

Azure Devops Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
  "service": "azure_devops",
  "group_id": "target_group_id",
  "config": {
    "schema": "azure_devops_schema_name",
    "sub_domain": "your_azure_devops_organization_name"
  }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the client_access parameter in the auth section.

   POST https://api.fivetran.com/v1/connectors

   {
      "service": "azure_devops",
      "group_id": "target_group_id",
      "config": {
         "schema": "azure_devops_schema_name",
         "sub_domain": "your_azure_devops_organization_name"
      },
      "auth": {
          "client_access": {
              "client_id": "your_azure_devops_client_id",
              "client_secret": "your_azure_devops_client_secret"
          }
      }
   }
   content_copy

   Auth parameterslink

   Name	Description
   client_access.client_id	Your Azure Devops Client ID.
   client_access.client_secret	Your Azure Devops Client Secret.

2. By using the Connect Card or the Fivetran dashboard.

Azure Functions link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "azure_function",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_azure_function",
        "function_app": "function_app_name",
        "function_name": "function_name",
        "function_key": "function_key",
        "secrets_list": [
          {"key": "secret1", "value": "xxxxxxx"},
          {"key": "secret2", "value": "xxxxxxx"}
        ],
        "custom_payloads": [
          {"key": "payload1", "value": "payload_value2"},
          {"key": "payload2", "value": "payload_value2"}
        ],
        "connection_method": "DIRECT"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: function_app, function_name, function_key and secrets.
2. By using the Connect Card or the Fivetran dashboard.

Azure Event Hubs link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "azure_event_hub",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_azure_event_hub",
        "consumer_group": "consumer_group",
        "connection_string": "connection_string",
        "message_type": "Json",
        "sync_type": "Packed"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the connection_string and consumer_group fields in the request.
2. By using the Connect Card or the Fivetran dashboard.

BallotReady Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "ballotready",
   "group_id": "target_group_id",
   "config": {
      "schema": "ballotready_schema_name",
      "api_key": "your_ballotready_api_key"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying a value for the api_key field in the request.
2. By using the Connect Card or the Fivetran dashboard.

BambooHR link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "bamboohr",
    "group_id": "target_group_id",
    "config": {
        "schema": "bamboohr_schema_name",
        "subdomain": "your_subdomain",
        "api_key": "your_api_key"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: subdomain and api_key.
2. By using the Connect Card or the Fivetran dashboard.

BigQuery Betalink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "bigquery_db",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "schema_prefix",
        "project_id": "projectId",
        "data_set_name": "dataSetName",
        "secret_key": "secretKey",
        "use_service_account": "false"
    }
}
content_copy

Config parameterslink

Initial Configurationlink

Copy the code snippet into the <head> section of your web page.

Authorizationlink

This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.

BigCommerce Betalink

Requestlink

POST https://api.fivetran.com/v1/connectors

{
    "service": "big_commerce",
    "group_id": "target_group_id",
    "config": {
        "schema": "big_commerce_schema_name",
        "store_hash": "your_store_hash",
        "access_token": "your_api_access_token"
    }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields in the request: store_hash and access_token.
2. By using the Connect Card or the Fivetran dashboard.

BillingPlatform Lite Private Previewlink

Requestlink

POST https://api.fivetran.com/v1/connectors

 {
   "service": "billing_platform",
   "group_id": "target_group_id",
   "config": {
      "schema": "billing_platform_schema_name",
      "base_url": "your_billing_platform_base_url"
   }
}
content_copy

Config parameterslink

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the values for the following fields:

   • client_id and client_secret in the config section
   • access_token and refresh_token in the auth section

   POST https://api.fivetran.com/v1/connectors

   {
      "service": "billing_platform",
      "group_id": "target_group_id",
      "config": {
         "schema": "billing_platform_schema_name",
         "base_url": "your_billing_platform_base_url",
         "client_id": "billing_platform_client_id",
         "client_secret": "billing_platform_client_secret"
      },
      "auth": {
          "refresh_token": "your_refresh_token",
          "access_token": "your_access_token"
      }
   }
   content_copy

   Auth parameterslink

   Name	Description
   client_id	Your BillingPlatform client ID.
   client_secret	Your BillingPlatform client secret.
   refresh_token	Your BillingPlatform refresh token.
   access_token	Your BillingPlatform access token.

2. By using the Connect Card or the Fivetran dashboard.

Birdeye Lite link

Requestlink

POST https://api.fivetran.com/v1/connectors

{
   "service": "birdeye",
   "group_id": "target_group_id",
   "config": {
      "schema": "birdeye_schema_name",
      "business_id": "your_birdeye_business_id",
      "query_param_value": "your_birdeye_query_param_value"
   }
}
content_copy

Config parameterslink