Connector Config

The connector setup configuration (config field) is different for each connector. Below are several examples of key connectors to help get you started.

We will continue to add more connectors to this list throughout BETA:

• Adjust
• Adobe Analytics
• Adobe Analytics Data Feed
• ADP Workforce Now
• AdRoll
• Airtable
• Amazon Ads
• Amazon S3
• Amplitude
• Anaplan
• Apache Kafka
• Apple App Store
• Apple Search Ads
• AppsFlyer
• Asana
• AWS CloudTrail
• AWS Inventory
• AWS Lambda
• AWS MSK
• Azure Blob Storage
• Azure Functions
• Azure Event Hubs
• Box
• Braintree
• Branch
• Braze
• CloudFront
• Confluent Cloud
• Coupa
• Criteo
• Delighted
• Dropbox
• DynamoDB
• Eloqua
• Email
• Facebook Ad Account
• Facebook Ad Insights
• Facebook Ads
• Facebook Pages
• FinancialForce
• Fivetran Log Connector
• Freshdesk
• Front
• FTP/FTPS
• Gainsight Customer Success
• GitHub
• Google Ad Manager
• Google Ads
• Google Analytics
• Google Analytics 4
• Google Analytics 4 Export
• Google Analytics 360
• Google Analytics (MCF)
• Google Campaign Manager 360
• Google Cloud Functions
• Google Cloud Storage
• Google Display & Video 360
• Google Drive
• Google Play
• Google Search Console
• Google Sheets
• Greenhouse
• Heap
• Height
• Help Scout
• Heroku Kafka
• HubSpot
• Instagram Business
• Intercom
• Iterable
• Jira
• Kinesis
• Klaviyo
• Kustomer
• Lever
• Lightspeed Retail
• LinkedIn Ad Analytics
• LinkedIn Company Pages
• Mailchimp
• Mandrill
• MariaDB
• Marin Software
• Marketo
• Mavenlink
• Medallia
• Microsoft Advertising
• Microsoft Dynamics 365
• Microsoft Dynamics 365 F/O
• Microsoft Lists
• Mixpanel
• MongoDB
• MySQL
• NetSuite SuiteAnalytics
• Optimizely
• Oracle
• Oracle Fusion Cloud Applications
• Outbrain
• Outreach
• Pardot
• Pendo
• Pinterest Ads
• Pipedrive
• Postgres
• Qualtrics
• QuickBooks
• ReCharge
• Recurly
• Sage Intacct
• Sailthru
• Salesforce
• Salesforce Marketing Cloud
• SAP Business ByDesign
• SAP Concur
• SAP HANA
• SAP S/4
• Segment
• SendGrid
• ServiceNow
• SFTP
• SharePoint
• Shopify
• Snapchat Ads
• Snowplow
• Splunk
• SQL Server
• Square
• Stripe
• SurveyMonkey
• Taboola
• The Trade Desk
• TikTok Ads
• Twilio
• Twitter Organic
• Twitter Ads
• Typeform
• UserVoice
• Verizon Media
• Webhooks
• Workday
• Workday HCM
• Xero
• YouTube Analytics
• Zendesk Chat
• Zendesk Sell
• Zendesk Sunshine
• Zendesk Support
• Zoho CRM
• Zuora
• Zuora Sandbox

Adjustlink

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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying 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"
         }
    }
   

   Auth parameters

   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 Analyticslink

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"
            ]
         }
      ]
   }
}

Authorizationlink

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

Adobe Analytics Data Feedlink

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"
    }
}

Amazon S3 Authorizationlink

There are two ways to authorize this connector type:

1. By specifying 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"
    }
}

Azure Blob Authorizationlink

There are two ways to authorize this connector type:

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

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
    }
}

FTP(S) Authorizationlink

There are two ways to authorize this connector type:

1. By specifying 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
    }
}

SFTP Authorizationlink

There are two ways to authorize this connector type:

1. By specifying 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.

ADP Workforce Nowlink

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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying 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.

AdRolllink

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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying 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"
       }
   }
   

   Auth parameters

   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.

Airtablelink

Requestlink

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

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

Authorizationlink

There are two ways to authorize this connector type:

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

Amazon Ads PRIVATE PREVIEWlink

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"
   }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying 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"
       }
   }
   

   Auth parameters

   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 S3link

Requestlink

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

{
    "service": "s3",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_s3",
        "table": "table_name",
        "external_id": "group_id",
        "role_arn": "arn::your_role_arn",
        "bucket": "bucket_name",
        "prefix": "folder_path",
        "pattern": "file_pattern",
        "file_type": "infer",
        "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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Amplitudelink

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"
            }
        ]
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Anaplanlink

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" ]
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

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

Apache Kafkalink

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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Apple App Storelink

Requestlink

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

{
    "service": "itunes_connect",
    "group_id": "target_group_id",
    "config": {
        "schema": "itunes_connect",
        "username": "user",
        "password": "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"
    }
}

Apple Search Adslink

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"
    }
}

Authorizationlink

There are three ways to authorize this connector type:

1. By specifying 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"
       }
   }
   

2. By specifying is_auth2_enabled as true and specifying 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"
       }
   }
   

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

AppsFlyerlink

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"
    }
}

Sync using only webhookslink

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

Authorizationlink

There are three ways to authorize this connector type:

1. By specifying the following fields in the request: access_key_id, secret_key, and home_folder, 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.

Asanalink

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"]
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying 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"
       }
   }
   

   Auth parameters

   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.

AWS CloudTraillink

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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

AWS Inventorylink

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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

AWS Lambdalink

Requestlink

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

{
    "service": "aws_lambda",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_lambda",
        "function": "function_name",
        "role_arn": "arn::your_role_arn",
        "region": "aws_region_code",
        "secrets": "{'secret1':'xxxxxxx', 'secret2':'xxxxxxx'}"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following fields in the request: function, function, role_arn and secrets.
2. By using the Connect Card or the Fivetran dashboard.

AWS MSKlink

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": "SSL",      
        "saslScram512Key": "sasl_key",
        "saslScram512Secret": "sasl_secret",
        "trusted_cert": "test_trusted_cert",
        "client_cert": "test_client_cert",
        "client_cert_key": "test_client_key"
        
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By passing the security protocol secrets:

   • If you select TLS, upload the Trusted Certificate, Client Certificate, and Client Certificate Key files.
   • If you select SASL, enter your secret’s saslScram512Key and saslScram512Secret.

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

Azure Blob Storagelink

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",
        "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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Azure Functionslink

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": "{'secret1':'xxxxxxx', 'secret2':'xxxxxxx'}"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying 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 Hubslink

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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Boxlink

Requestlink

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

{
    "service": "box",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_box",
        "folder_id": "folder_id"
    }
}

Authorizationlink

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

Braintreelink

Requestlink

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

{
    "service": "braintree",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_braintree",
        "public_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "private_key": "your_api_secret",
        "merchant_id": "merchant_id"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following fields in the request: public_key, private_key and merchant_id.
2. By using the Connect Card or the Fivetran dashboard.

Branchlink

NOTE: You will need to register the Fivetran-generated webhooks URL in your Branch dashboard. See the Branch setup guide for more details.

Requestlink

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

{
    "service": "branch",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_branch"
    }
}

Authorizationlink

This type of connector does not require authorization and can be created using the Create a Connector endpoint.

Brazelink

Requestlink

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

{
    "service": "braze",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_braze",
        "api_url": "test_api_url",
        "api_key": "test_api_key",
        "cloud_storage_type": "AWS_S3",
        "s3bucket": "your_s3_bucket",
        "s3role_arn": "arn:aws:iam::XXXXXXXXXXXX:role/your_test_bucket",
        "s3external_id": "_moonbeam",
        "s3folder": "your_s3_folder"
    }
}

{
    "service": "braze",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_braze",
        "api_url": "test_api_url",
        "api_key": "test_api_key",
        "cloud_storage_type": "GCS",
        "gcs_bucket": "your_gcs_bucket",
        "gcs_folder": "your_gcs_folder"
    }
}

Authorizationlink

There are three ways to authorize this connector type:

1. By specifying the following fields in the request: api_url, api_key, s3bucket, s3role_arn, s3external_id and s3folder, if cloud_storage_type is set to AWS_S3 .
2. By specifying the following fields in the request: api_url, api_key, gcs_bucket and gcs_folder , if cloud_storage_type is set to GCS .
3. By using the Connect Card or the Fivetran dashboard.

CloudFrontlink

Requestlink

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

{
    "service": "cloudfront",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_cloudfront",
        "external_id": "group_id",
        "role_arn": "arn::your_role_arn",
        "bucket": "bucket_name",
        "prefix": "cloudfront_folder"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Confluent Cloudlink

Requestlink

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

{
    "service": "confluent_cloud",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_confluent_cloud",
        "consumer_group": "consumer_group",
        "servers": "serveraddress1:8080, serveraddress2:8080",
        "message_type": "Json",
        "sync_type": "Packed",
        "security_protocol": "SASL"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Coupalink

Requestlink

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

{
    "service": "coupa",
    "group_id": "target_group_id",
    "config": {
        "schema": "coupa_schema",
        "instance": "instance",
        "api_key": "api_key"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Criteolink

Requestlink

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

{
    "service": "criteo",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_criteo",
        "client_id": "xxxxx-xxxxxx-x-xxxx",
        "client_secret": "your_api_secret"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Delightedlink

Requestlink

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

{
  "service" : "delighted",
  "group_id" : "target_group_id",
  "config" : {
    "schema" : "test_delighted",
    "api_key" : "******"
  }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Dropboxlink

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
• Merge Mode

Magic Folder Requestlink

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

{
    "service": "dropbox",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_dropbox",
        "folder": "folder_url"
    }
}

Merge Mode Requestlink

To use the Merge Mode sync strategy, specify the is_single_table_mode parameter as true. If you don’t specify the parameter, we will use the default Magic Folder strategy to sync files.

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

{
   "service": "dropbox",
   "group_id": "target_group_id",
   "config": {
      "schema": "test_dropbox",
      "table": "dest_table",
      "prefix": "folder_path",
      "pattern": "file_pattern",
      "file_type": "infer",
      "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"
   }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

   {
      "service": "dropbox",
      "group_id": "target_group_id",
      "config": {
          "schema": "test_dropbox",
          "folder": "folder_url"
           },
      "auth": {
          "client_access": {
              "client_id": "my_client_id",
              "client_secret": "my_client_secret"
          },
          "refresh_token": "my_refresh_token"
      }
   }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Dropbox client application.
   client_secret	Client Secret of your Dropbox client application.
   refresh_token	The long-lived Refresh token along with 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.

DynamoDBlink

Before creating a DynamoDB connection, you must first follow the DynamoDB setup guide

Requestlink

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

{
    "service": "dynamodb",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_dynamodb",
        "external_id": "external_id",
        "role_arn": "arn::your_role_arn",
        "aws_region_code": "aws_region_code"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Eloqualink

Requestlink

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

{
    "service": "eloqua",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_eloqua"
    }
}

Authorizationlink

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

Emaillink

After configuring an Email connector, you’ll send your emails to group_id.schema.table_name@email-connector.fivetran.com

Requestlink

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

{
    "service": "email",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_email",
        "table": "table_name",
        "pattern": "file_pattern",
        "file_type": "infer",
        "compression": "infer",
        "on_error": "skip",
        "archive_pattern": "regex_pattern",
        "null_sequence": "",
        "delimiter": "",
        "escape_char": "",
        "skip_before": "0",
        "skip_after": "0"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the required fields in the request.
2. By using the Connect Card or the Fivetran dashboard.

Facebook Ad Account SUNSETlink

Requestlink

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

{
    "service": "facebook_ad_account",
    "group_id": "target_group_id",
    "config": {
        "schema": "fb_ad_account_test",
        "sync_mode": "SpecificAccounts",
        "accounts": ["acc1","acc2"]
    }
}

Authorizationlink

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

Facebook Ad Insights SUNSETlink

Requestlink

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

{
    "service": "facebook",
    "group_id": "group_id",
    "config": {
        "schema": "facebook",
        "table": "facebook",
        "accounts": [],
        "fields": [],
        "breakdowns": [],
        "action_breakdowns": [],
        "sync_mode": "sync_mode",
        "aggregation": "aggregation",
        "config_type": "config_type",
        "prebuilt_report": "prebuilt_report",
        "action_report_time": "impression",
        "click_attribution_window": "click_attribution_window",
        "view_attribution_window": "view_attribution_window",
        "timeframe_months": "SIX"
    }
}

Authorizationlink

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

Facebook Adslink

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

Requestlink

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

{
    "service": "facebook_ads",
    "group_id": "target_group_id",
    "config": {
        "schema": "facebook_ads",
        "sync_mode": "SpecificAccounts",
        "accounts": ["act_123"],
        "custom_tables": [
            {
                "table_name": "table_1",
                "config_type": "Custom",
                "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"
            },
            {
                "table_name": "basic_ad_set",
                "config_type": "Prebuilt",
                "prebuilt_report_name": "BASIC_AD_SET"   
            }
        ],
        "timeframe_months": "THREE",
        "sync_metadata": "true"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying client_access and access_token in the auth section.

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

    {
     "service": "facebook_ads",
         "group_id": "target_group_id",
         "config": {
             "schema": "facebook_ads",
             "sync_mode": "SpecificAccounts",
             "accounts": ["act_123"],
             "custom_tables": [
                 {
                     "table_name": "table_1",
                     "config_type": "Custom",
                     "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"
                 },
                 {
                     "table_name": "basic_ad_set",
                     "config_type": "Prebuilt",
                     "prebuilt_report_name": "BASIC_AD_SET"
                 }
             ],
              "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_id	Client ID of your Facebook client application.
   client_secret	Client Secret of your Facebook client application.
   access_token	The long-lived Access token along with the client_id and client_secret parameters carry the information necessary to query the Facebook Ads API

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

Facebook Pageslink

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

Requestlink

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

{
    "service": "facebook_pages",
    "group_id": "target_group_id",
    "config": {
        "schema": "facebook_pages",
        "sync_mode" : "SpecificPages",
        "pages" : ["page1","page2"]
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying client_access and access_token in the auth section.

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

    {
        "service": "facebook_pages",
        "group_id": "target_group_id",
        "config": {
                "schema": "facebook_pages",
                "sync_mode" : "SpecificPages",
                "pages" : ["page1","page2"]
            },
        "auth": {
            "client_access": {
                "client_id": "my_client_id",
                "client_secret": "my_client_secret"
            },
          "access_token": "my_access_token"
        }
    }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Facebook client application.
   client_secret	Client Secret of your Facebook client application.
   access_token	The Access Token carries the information necessary for API resources to fetch data

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

Financial Forcelink

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

Requestlink

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

{
    "service": "financial_force",
    "group_id": "target_group_id",
    "config": {
        "schema": "financial_force",
        "base_url": "https://base_url.salesforce.com" 
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

   {
       "service": "financial_force",
       "group_id": "target_group_id",
       "config": {
           "schema": "financial_force",
           "base_url": "https://base_url.salesforce.com" 
       },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Salesforce client application.
   client_secret	Client Secret of your Salesforce client application.
   refresh_token	The long-lived Refresh token along with 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.

Fivetran Log Connectorlink

Requestlink

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

{
    "service": "fivetran_log",
    "group_id": "target_group_id",
    "config": {
        "schema": "fivetran_log_schema"
    }
}

Authorizationlink

To authorize this connector, we reuse the access rights that you use to access the API.

Freshdesklink

Requestlink

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

{
    "service": "freshdesk",
    "group_id": "target_group_id",
    "config": {
        "schema": "freshdesk",
        "subdomain": "company_name",
        "api_key": "your_api_key"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Frontlink

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

Requestlink

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

{
    "service": "front",
    "group_id": "target_group_id",
    "config": {
        "schema": "front"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

    {
        "service": "front",
            "group_id": "target_group_id",
            "config": {
                "schema": "front"
            },
        "auth": {
            "client_access": {
                "client_id": "my_client_id",
                "client_secret": "my_client_secret"
            },
            "refresh_token": "my_refresh_token"
        }
    }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Front client application.
   client_secret	Client Secret of your Front client application.
   refresh_token	The long-lived Refresh token along with 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.

FTPlink

Requestlink

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

{
    "service": "ftp",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_ftp",
        "table": "table_name",
        "host": "ftp.company.com",
        "port": "21",
        "user": "user_name",
        "password": "password",
        "is_secure": "false",
        "prefix": "folder_path",
        "pattern": "file_pattern",
        "file_type": "infer",
        "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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following fields in the request: user, password, host and port.
2. By using the Connect Card or the Fivetran dashboard.

Gainsight Customer Success PRIVATE PREVIEWlink

Requestlink

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

{
    "service": "gainsight_customer_success",
    "group_id": "target_group_id",
    "config": {
        "schema": "testing_gainsight",
        "sub_domain": "test_sub_domain",
        "access_key": "test_access_key"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following fields in the request: sub_domain and access_key.

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

GitHublink

Requestlink

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

{
    "service": "github",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_github",
        "sync_mode": "SpecificRepositories",
        "repositories": ["12345678", "23456789"],
        "use_webhooks": false
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying username, pat and auth_mode in the auth section.

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

   {
       "service": "github",
       "group_id": "target_group_id",
       "config": {
           "schema": "test_github",
           "sync_mode": "SpecificRepositories",
           "repositories": ["12345678", "23456789"],
           "use_webhooks": false
       },
       "auth": {
         "username": "github-login",
         "pat": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
         "auth_mode": "PersonalAccessToken"
       }
   }
   

   Auth parameters

   Name	Description
   username	Login of your GitHub profile.
   pat	The Personal Access Token generated in Github.
   auth_mode	Authorization type.

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

Google Ad Managerlink

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

Requestlink

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

{
    "service": "double_click_publishers",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_ad_manager",
        "table": "test_table",
        "dimensions": ["DATE", "LINE_ITEM_ID", "LINE_ITEM_NAME"],
        "dimension_attributes": ["LINE_ITEM_PRIORITY"],
        "columns": ["TOTAL_LINE_ITEM_LEVEL_CLICKS"],
        "network_code": "0"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

   {
       "service": "double_click_publishers",
       "group_id": "target_group_id",
       "config": {
           "schema": "test_google_ad_manager",
           "table": "test_table",
           "dimensions": ["DATE", "LINE_ITEM_ID", "LINE_ITEM_NAME"],
           "dimension_attributes": ["LINE_ITEM_PRIORITY"],
           "columns": ["TOTAL_LINE_ITEM_LEVEL_CLICKS"],
           "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_id	Client ID of your Google Ad Manager client application.
   client_secret	Client Secret of your Google Ad Manager client application.
   refresh_token	The long-lived Refresh token along with 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.

Google Adslink

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

Requestlink

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

{
    "service": "google_ads",
    "group_id": "target_group_id",
    "config": {
        "schema": "google_ads",
        "customer_id": "xxx-xxx-xxxx",
        "sync_mode": "SpecificAccounts",
        "timeframe_months": "SIX",
        "accounts": [],
        "manager_accounts": [],
        "reports": [
            {
                "table": "table_1",
                "report_type": "customer",
                "fields": [ "segments.date", "customer.id", "segments.ad_network_type", "segments.device", "metrics.clicks", "metrics.cost_micros" ]
            },
            {
                "table": "table_2",
                "report_type": "campaign",
                "fields": [ "segments.date", "campaign.id", "customer.id", "segments.click_type", "segments.ad_network_type", "metrics.clicks", "metrics.impressions" ]
            }
        ],
        "conversion_window_size": 30
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

   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",
               "developer_token": "my_developer_token"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Google Ads client application.
   client_secret	Client Secret of your Google Ads client application.
   user_agent	Your company’s name in your Google Ads client application.
   developer_token	Your approved Developer token to connect to the Google Ads API.
   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.

Google Analyticslink

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

Requestlink

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

{
    "service": "google_analytics",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_analytics",
        "sync_mode": "SpecificAccounts",
        "accounts": ["0123456789"],
        "profiles": ["0123456789", "9876543210"],
        "reports": [
            {
                "table": "table_1",
                "config_type": "Custom",
                "dimensions": ["date", "dimension1", "pagePath", "browser"],
                "metrics": ["pageviews", "sessions", "timeOnPage", "users"],
                "segments": ["Bounced Sessions", "Direct Traffic"],
                "filter": "ga:browser==Chrome"
            },
            {
                "table": "table_2",
                "config_type": "Prebuilt",
                "prebuilt_report": "CHANNEL_TRAFFIC"
            }
        ],
        "timeframe_months": "SIX"
    }
}

Legacy Requestlink

The following request is deprecated and will be removed in the future:

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

{
    "service": "google_analytics",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_analytics",
        "table": "test_table",
        "sync_mode": "SpecificAccounts",
        "accounts": ["0123456789"],
        "profiles": ["0123456789", "9876543210"],
        "config_type": "Custom",
        "dimensions": ["date", "dimension1", "pagePath", "browser"],
        "metrics": ["pageviews", "sessions", "timeOnPage", "users"],
        "segments": ["Bounced Sessions", "Direct Traffic"],
        "filter": "ga:browser==Chrome",
        "timeframe_months": "SIX"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

   {
       "service": "google_analytics",
       "group_id": "target_group_id",
       "config": {
            "schema": "test_google_analytics",
            "sync_mode": "SpecificAccounts",
            "accounts": ["0123456789"],
            "profiles": ["0123456789", "9876543210"],
            "reports": [
                {
                    "table": "table_1",
                    "config_type": "Custom",
                    "dimensions": ["date", "dimension1", "pagePath", "browser"],
                    "metrics": ["pageviews", "sessions", "timeOnPage", "users"],
                    "segments": ["Bounced Sessions", "Direct Traffic"],
                    "filter": "ga:browser==Chrome"
                },
                {
                    "table": "table_2",
                    "config_type": "Prebuilt",
                    "prebuilt_report": "CHANNEL_TRAFFIC"
                }
               ],
               "timeframe_months": "SIX"
       },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Google Analytics client application.
   client_secret	Client Secret of your Google Analytics client application.
   refresh_token	The long-lived Refresh token along with 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.

Google Analytics 4link

Requestlink

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

{
  "service": "google_analytics_4",
  "group_id": "target_group_id",
  "config": {
    "schema": "test_google_analytics",
    "timeframe_months": "SIX",
    "sync_mode": "SPECIFIC_ACCOUNTS",
    "accounts": ["0123456789"],
    "properties": ["0123456789", "9876543210"],
    "reports": [
      {
        "table": "table_1",
        "config_type": "CUSTOM",
        "dimensions": ["date", "firstUserMedium"],
        "metrics": ["newUsers", "totalRevenue", "sessions"],
        "filter_field_name": "browser",
        "filter_field_value": "chrome"
      },
      {
        "table": "table_2",
        "config_type": "PREBUILT",
        "prebuilt_report": "USER_ACQUISITION_FIRST_USER_MEDIUM_REPORT"
      }
    ]
  }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

   {
     "service": "google_analytics_4",
     "group_id": "target_group_id",
     "config": {
       "schema": "test_google_analytics",
       "timeframe_months": "SIX",
       "sync_mode": "SPECIFIC_ACCOUNTS",
       "accounts": ["0123456789"],
       "properties": ["0123456789", "9876543210"],
       "reports": [
         {
           "table": "table_1",
           "config_type": "CUSTOM",
           "dimensions": ["date", "firstUserMedium"],
           "metrics": ["newUsers", "totalRevenue", "sessions"],
           "filter_field_name": "browser",
           "filter_field_value": "chrome"
         },
         {
           "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_id	Client ID of your Google Analytics client application.
   client_secret	Client Secret of your Google Analytics client application.
   refresh_token	The long-lived Refresh token along with 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.

Google Analytics 4 Export PRIVATE PREVIEWlink

Requestlink

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

{
    "service": "google_analytics_4_export",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_analytics_4_export",
        "project_id": "test_project_id",
        "dataset_id": "test_dataset_id",
        "bucket_name": "test_bucket_name"     
    } 
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following fields in the request: project_id, dataset_id, and bucket_name.
2. By using the Connect Card or the Fivetran dashboard.

Initial Configurationlink

To provide Fivetran access perform the following steps:

1. Add the email address in the format g-[group-id]@fivetran-production.iam.gserviceaccount.com as a new member, where [group_id] is the connector’s group ID.
2. Assign the following roles: BigQuery Data Viewer for DatasetId, Storage Object Admin for BucketName, and BigQuery Job User for Project.

Google Analytics 360link

Requestlink

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

{
    "service": "google_analytics_360",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_analytics_360",
        "project_id": "test_project_id",
        "dataset_id": "test_dataset_id",
        "bucket_name": "test_bucket_name"     
    } 
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following fields in the request: project_id, dataset_id and bucket_name.
2. By using the Connect Card or the Fivetran dashboard.

Initial Configurationlink

To provide Fivetran access perform the following steps:

1. Add the email address in the format g-[group-id]@fivetran-production.iam.gserviceaccount.com as a new member, where [group_id] is the connector’s group ID.
2. Assign BigQuery Data Viewer, BigQuery Job User, and BigQuery User roles.

Google Analytics (MCF)link

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

Requestlink

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

{
    "service": "google_analytics_mcf",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_analytics_mcf",
        "sync_mode": "SPECIFIC_ACCOUNTS",
        "accounts": ["0123456789"],
        "profiles": ["0123456789", "9876543210"],
        "timeframe_months": "SIX"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

   {
       "service": "google_analytics_mcf",
       "group_id": "target_group_id",
       "config": {
           "schema": "test_google_analytics_mcf",
           "sync_mode": "SPECIFIC_ACCOUNTS",
           "accounts": ["0123456789"],
           "profiles": ["0123456789", "9876543210"],
           "timeframe_months": "SIX"
       },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Google Analytics client application.
   client_secret	Client Secret of your Google Analytics client application.
   refresh_token	The long-lived Refresh token along with 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.

Google Campaign Manager 360link

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

Requestlink

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

{
    "service": "double_click_campaign_manager",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_double_click_campaign_manager",
        "table": "test_table",
        "sync_mode": "SPECIFIC_PROFILES",
        "user_profiles": ["1234567", "8901234"],
        "timeframe_months": "SIX",
        "report_type": "FLOODLIGHT",
        "dimensions": ["date", "activity"],
        "metrics": ["activeViewPercentAudibleImpressions"],
        "report_configuration_ids": ["12", "34", "56"],
        "enable_all_dimension_combinations": true
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

   {
       "service": "double_click_campaign_manager",
       "group_id": "target_group_id",
       "config": {
           "schema": "test_double_click_campaign_manager",
           "table": "test_table",
           "sync_mode": "SPECIFIC_PROFILES",
           "user_profiles": ["1234567", "8901234"],
           "timeframe_months": "SIX",
           "report_type": "FLOODLIGHT",
           "dimensions": ["date", "activity"],
           "metrics": ["activeViewPercentAudibleImpressions"],
           "report_configuration_ids": ["12", "34", "56"],
           "enable_all_dimension_combinations": true
       },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Google Campaign Manager 360 client application.
   client_secret	Client Secret of your Google Campaign Manager 360 client application.
   refresh_token	The long-lived Refresh token along with 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.

Google Cloud Functionslink

Requestlink

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

{
    "service": "google_cloud_function",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_cloud_function",
        "function_trigger": "https://us-east1-b.projectname.cloudfunctions.net/function_name",
        "secrets": "{'secret1':'xxxxxxx', 'secret2':'xxxxxxx'}"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following fields in the request: function_trigger and secrets.
2. By using the Connect Card or the Fivetran dashboard.

Google Cloud Storagelink

Requestlink

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

{
    "service": "gcs",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_gcs",
        "table": "table_name",
        "bucket": "bucket_name",
        "prefix": "folder_path",
        "pattern": "file_pattern",
        "file_type": "infer",
        "compression": "infer",
        "on_error": "skip",
        "append_file_option": "upsert_file",
        "archive_pattern": "regex_pattern",
        "null_sequence": "",
        "delimiter": "",
        "escape_char": "",
        "skip_before": "0",
        "skip_after": "0",
        "auth_type": "auth_type",
        "secret_key": "secret_key"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the bucket, auth_type and secret_key field in the request.
2. By using the Connect Card or the Fivetran dashboard.

Google Display & Video 360link

Requestlink

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

{
    "service": "google_display_and_video_360",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_display_and_video_360",
        "table": "table_name",
        "config_method": "CREATE_NEW",
        "partners": ["1234567", "123456789"],
        "advertisers": ["1234567", "123456789"],
        "report_type": "TYPE_GENERAL",
        "dimensions": ["FILTER_ADVERTISER", "FILTER_DATE"],
        "metrics": ["METRIC_CLICKS"],
        "query_id": "123456789",
        "update_config_on_each_sync": true
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

   {
       "service": "google_display_and_video_360",
       "group_id": "target_group_id",
       "config": {
           "schema": "test_google_display_and_video_360",
           "table": "table_name",
           "config_method": "CREATE_NEW",
           "partners": ["1234567", "123456789"],
           "advertisers": ["1234567", "123456789"],
           "report_type": "TYPE_GENERAL",
           "dimensions": ["FILTER_ADVERTISER", "FILTER_DATE"],
           "metrics": ["METRIC_CLICKS"],
           "query_id": "123456789",
           "update_config_on_each_sync": true
       },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Google Display & Video 360 client application.
   client_secret	Client Secret of your Google Display & Video 360 client application.
   refresh_token	The long-lived Refresh token along with 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.

Google Drivelink

Requestlink

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

{
    "service": "google_drive",
    "group_id": "target_group_id",
    "config": {
       "schema": "test_google_drive",
       "folder_id": "folder_id"
    }
}

Authorizationlink

1. The created connector can use authentication via the service account. You must share your Google Drive folder with Fivetran’s service account using the account’s auto-generated email address.The Google drive folder needs to be shared with Fivetran’s service account named g-[group_id]@fivetran-production.iam.gserviceaccount.com where [group_id] is the connector’s group ID.
2. By using the Connect Card or the Fivetran dashboard.

Google Playlink

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

Requestlink

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

{
    "service": "google_play",
    "group_id": "target_group_id",
    "config": { 
      "schema": "test_google_play",
      "bucket": "bucket_name"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

   {
       "service": "google_play",
       "group_id": "target_group_id",
       "config": {
         "schema": "test_google_play",
         "bucket": "bucket_name"
       },  
      "auth": {
          "client_access": {
              "client_id": "my_client_id",
              "client_secret": "my_client_secret"
          },
          "refresh_token": "my_refresh_token"
      }
   }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Google Play client application.
   client_secret	Client Secret of your Google Play client application.
   refresh_token	The long-lived Refresh token along with 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.

Google Search Consolelink

Requestlink

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

{
    "service": "google_search_console",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_search_console",
        "sync_mode": "SpecificSites",
        "site_urls": ["https://fivetran.com", "https://support.fivetran.com"],
        "timeframe_months": "SIX"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

   {
       "service": "google_search_console",
       "group_id": "target_group_id",
       "config": {
           "schema": "test_google_search_console",
           "sync_mode": "SpecificSites",
           "site_urls": ["https://fivetran.com", "https://support.fivetran.com"],
           "timeframe_months": "SIX"
       },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Google Search Console client application.
   client_secret	Client Secret of your Google Search Console client application.
   refresh_token	The long-lived Refresh token along with 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.

Google Sheetslink

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

Requestlink

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

{
    "service": "google_sheets",
    "group_id": "target_group_id",
    "config": {
        "schema": "google_sheets",
        "table": "table"
    }
}

Authorizationlink

There are three ways to authorize this connector type:

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

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

   {
       "service": "google_sheets",
       "group_id": "target_group_id",
       "config": {
           "schema": "google_sheets",
           "table": "table",
           "sheet_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
           "named_range": "range"
       },
       "auth": {
           "client_access": {
               "client_id": "my_client_id",
               "client_secret": "my_client_secret"
           },
           "refresh_token": "my_refresh_token"
       }
   }
   

   Config parameters

   Name	Description
   sheet_id	The URL of the sheet that can be copied from the browser address bar, or the ID of the sheet that can be found in the sheet’s URL between /d/ and /edit.
   named_range	The name of the named data range on the sheet that contains the data to be synced.

   Auth parameters

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

2. By specifying the values for the sheet_id and named_range parameters in the request.

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

   {
       "service": "google_sheets",
       "group_id": "target_group_id",
       "config": {
           "schema": "google_sheets",
           "table": "table",
           "sheet_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
           "named_range": "range",
           "auth_type": "ServiceAccount"
       }
   }
   

   Config parameters

   Name	Description
   sheet_id	The URL of the sheet that can be copied from the browser address bar, or the ID of the sheet that can be found in the sheet’s URL between /d/ and /edit.
   named_range	The name of the named data range on the sheet that contains the data to be synced.
   auth_type	The ServiceAccount value must be specified for this type of authorization.

   NOTE: The connector uses service account authentication. You must share the sheet with Fivetran’s service account named g-[group_id]@fivetran-production.iam.gserviceaccount.com, where [group_id] is the connector’s group ID.

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

Greenhouselink

Requestlink

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

{
    "service": "greenhouse",
    "group_id": "target_group_id",
    "config": {
        "schema": "greenhouse",
        "api_key": "xxxxxxxxxxxxxxxx"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Heaplink

Requestlink

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

{
    "service": "heap",
    "group_id": "target_group_id",
    "config": {
        "schema": "heap",
        "bucket": "http://your_test_bucket.s3.amazonaws.com",
        "role_arn": "arn:aws:s3:::your_test_bucket"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Heightlink

Requestlink

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

{
    "service": "height",
    "group_id": "target_group_id",
    "config": {
        "schema": "height",
        "api_key": "xxxxxxxxxxxxxxxx"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Help Scoutlink

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

Requestlink

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

{
    "service": "helpscout",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_helpscout"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

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

    {
        "service": "helpscout",
        "group_id": "target_group_id",
        "config": {
            "schema": "test_helpscout"
        },
        "auth": {
            "client_access": {
                "client_id": "my_client_id",
                "client_secret": "my_client_secret"
            },
            "refresh_token": "my_refresh_token"
        }
    }
   

   Auth parameters

   Name	Description
   client_id	Client ID of your Help Scout client application.
   client_secret	Client Secret of your Help Scout client application.
   refresh_token	The long-lived refresh token along with 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.

Heroku Kafkalink

Requestlink

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

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

Authorizationlink

There are two ways to authorize this connector type:

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

HubSpotlink

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": "hubspot",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_hubspot"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

   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_id	Client ID of your Hubspot client application.
   client_secret	Client Secret of your Hubspot 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.

Instagram Businesslink

Requestlink

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"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying client_access and access_token in the auth section.

   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_id	Client ID of your Facebook client application.
   client_secret	Client Secret of your Facebook client application.
   access_token	The Access Token carries the information necessary for API resources to fetch data

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

Intercomlink

Requestlink

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

{
    "service": "intercom",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_intercom"
    }
}

Authorizationlink

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

Iterablelink

NOTE: You will need to register the Fivetran-generated webhooks URL in your Iterable dashboard. See the Iterable setup guide for more details.

Requestlink

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

{
    "service": "iterable",
    "group_id": "target_group_id",
    "config": {
        "schema": "iterable",
        "api_key": "xxxxxxxxxxxxxxxx"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Jiralink

Requestlink

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
    }
}

Authorizationlink

There are two ways to authorize this connector type:

1. By specifying the following fields in the request: host, port, user and password.
2. By using the Connect Card or the Fivetran dashboard.

Kinesislink

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": ""
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Klaviyolink

Requestlink

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

{
    "service": "klaviyo",
    "group_id": "target_group_id",
    "config": {
        "schema": "klaviyo",
        "api_key": "xxxxxxxxxxxxxxxx"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Kustomerlink

Requestlink

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

{
    "service": "kustomer",
    "group_id": "target_group_id",
    "config": {
        "schema": "kustomer",
        "access_token": "xxxxxxxxxxxxxxxx"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Leverlink

Requestlink

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

{
    "service": "lever",
    "group_id": "target_group_id",
    "config": {
        "schema": "lever",
        "api_key": "xxxxxxxxxxxxxxxx"
    }
}

Authorizationlink

There are two ways to authorize this connector type:

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

Lightspeed Retaillink

Requestlink

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

{
    "service": "light_speed_retail",
    "group_id": "target_group_id",
    "config": {
        "schema": "light_speed_retail_schema"
    }
}

Authorizationlink

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

LinkedIn Ad Analyticslink

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