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:

6sense Lite Private Preview

Request

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 parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your 6sense API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

360Learning Lite

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your 360Learning API key.
`company_id`	Your 360Learning company ID.

Authorization

There are two ways to authorize this connector type:

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

ActiveCampaign Lite

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your ActiveCampaign API key.
`sub_domain`	Your ActiveCampaign subdomain.

Authorization

There are two ways to authorize this connector type:

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

Ada Lite

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`bearer_token`	Your Ada API access token.
`sub_domain`	Your Ada bot handle.

Authorization

There are two ways to authorize this connector type:

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

Adjust

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

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for csv_definition, export_storage_type, bucket_name, 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 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.

By using the or the Fivetran dashboard.

Adobe Analytics

Request

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

{
   "service": "adobe_analytics",
   "group_id": "target_group_id",
   "config": {
      "schema": "adobe_analytics",
      "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 parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	Client ID from the Service Account (JWT) credentials of your Adobe Project.
`client_secret`	Client Secret from the Service Account (JWT) credentials of your Adobe Project.
`technical_account_id`	Technical Account ID from the Service Account (JWT) credentials of your Adobe Project.
`organization_id`	Organization ID from the Service Account (JWT) credentials of your Adobe Project.
`private_key`	The complete contents of your private key file including the start and end tags (`----BEGIN PRIVATE KEY----`Your key without line breakers`----END PRIVATE KEY----`).
`date_granularity`	The aggregation duration. Default value: `HOUR` .	`HOUR` , `DAY` , `WEEK` , `MONTH` , `QUARTER` , `YEAR`
`timeframe_months`	The number of months' worth of reporting data to include in the initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`
`adobe_analytics_configurations`	The list of configurations of tables you want to sync. The number of tables and their configurations is limited to 5. Required for connector creation.
`table`	The table name unique within the schema to which connector will sync the data. Required for connector creation.
`sync_mode`	Whether to sync all report suites or specific report suites. Default value: `AllReportSuites` .	`AllReportSuites`, `SpecificReportSuites`
`report_suites`	Specific report suites to sync. Must be populated if `sync_mode` is set to `SpecificReportSuites`. Required for connector creation.
`elements`	The elements that you want to sync. Required for connector creation.
`metrics`	The metrics that you want to sync.
`calculated_metrics`	The calculated_metrics that you want to sync.
`segments`	The segments that you want to sync.

Authorization

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

Adobe Analytics Data Feed

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

The API requests are source-specific.

Amazon S3 Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`s3bucket`	The S3 bucket name.
`s3role_arn`	The Role ARN required for authentication.
`source`	The data source.

Amazon S3 Authorization

There are two ways to authorize this connector type:

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

Azure Blob Request

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

{
    "service": "adobe_analytics_data_feed",
    "group_id": "target_group_id",
    "config": {
        "schema": "adobe_analytics_data_feed_blob",
        "source": "AZURE_BLOB_STORAGE",
        "abs_connection_string": "connection_string",
        "abs_container_name": "container_name"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`abs_connection_string`	Azure blob storage connection string.
`abs_container_name`	Azure blob storage container name.
`source`	The data source.

Azure Blob Authorization

There are two ways to authorize this connector type:

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

Azure Service Bus

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 parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`auth_type`	The authentication mode to access the topic	`ConnectionString`, `AzureActiveDirectory`
`has_manage_permissions`	The boolean value specifying whether the connection string has manage permissions	`true`, `false`
`topics`	The comma-separated list of topics which should be synced. Required if you do not have manage permissions
`namespace`	The ASB namespace which we have to sync. Required if `auth_type` is `AzureActiveDirectory`.
`subscriber_name`	The subscriber name. If the connection string does not have manage permission, you need to specify a subscriber name we can use to fetch data. If not specified, we default to `fivetran_sub_<schema>`
`message_type`	The format of messages in the topic	`Text`, `Json`, `Avro`, `Protobuf`, `Xml`
`sync_type`	The sync type, which is based on the message type. For `Text` and `Xml`, `Packed` is supported. For `Protobuf` and `Avro`, `Unpacked` is supported. For `Json`, both `Packed` and `Unpacked` are supported.	`Packed`, `Unpacked`
`schema_registry_urls`	The comma-separated list of schema registry servers in the `server:port` format
`schema_registry_key`	The key used to access the schema registry. Required for the `Avro` and `Protobuf` message types
`schema_registry_secret`	The secret used to access the schema registry. Required for the `Avro` and `Protobuf` message types
`connection_method`	The connection method	`direct`, `sshTunnel`, `privateLink`
`asb_ip`	The IP address (or) the URL of ASB namespace. Required if `connection_method` is `sshTunnel`
`host_ip`	The IP address of the host machine which we use to connect to ASB via ssh. Required if `connection_method` is `sshTunnel`
`host_user`	The username on the host machine which we use to connect to ASB via ssh. Required if `connection_method` is `sshTunnel`

Auth parameters

Name	Description	Possible Values
`connection_string`	The connection string used for authentication. Required if the authentication type is `ConnectionString`
`client_id`	`Client ID` of your Azure application. Required if the authentication type is `AzureActiveDirectory`
`client_secret`	`Client Secret` of your Azure application. Required if the authentication type is `AzureActiveDirectory`
`refresh_token`	The refresh token. Required if the authentication type is `AzureActiveDirectory`

Azure Service Bus Authorization

There are three ways to authorize this connector type:

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

FTP(S) Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`ftp_host`	FTP host.
`ftp_port`	FTP port.
`ftp_user`	FTP user.
`ftp_password`	FTP password.
`is_ftps`	Use Secure FTP (FTPS).	Specify `true` for FTPS, `false` for FTP
`source`	The data source.

FTP(S) Authorization

There are two ways to authorize this connector type:

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

SFTP Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sftp_host`	SFTP host.
`sftp_port`	SFTP port.
`sftp_user`	SFTP user.
`sftp_password`	SFTP password required if sftp_is_key_pair is false
`sftp_is_key_pair`	Log in with key pair or password	`true`, `false`
`source`	The data source.

SFTP Authorization

There are two ways to authorize this connector type:

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

Adobe Commerce Private Preview

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`host_url`	Your Adobe Commerce host url.
`username`	Your Adobe Commerce username.
`password`	Your Adobe Commerce password.

Authorization

There are two ways to authorize this connector type:

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

ADP Workforce Now

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	Your ADP Client ID.
`client_secret`	Your ADP Client Secret.
`ws_certificate`	The contents of your PEM formatted Web Services certificate file.
`private_key`	The contents of your private key file.

Authorization

There are two ways to authorize this connector type:

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

AdRoll

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`sync_mode`	Whether to sync all advertisables or specific advertisables. Default value: `AllAdvertisables`.	`AllAdvertisables`, `SpecificAdvertisables`
`advertisables`	Specific advertisables to sync. Must be populated if `sync_mode` is set to `SpecificAdvertisables`.
`report_type`	The report type you want. Default value: `ALL_ADS`.	`ALL_AUDIENCE` , `ALL_CAMPAIGNS` , `ALL_ADS` , `ALL_ADGROUPS` , `CONVERSIONS` , `ALL_ADVERTISABLES`
`dimensions`	The dimenstions that you want to sync.
`metrics`	The metrics that you want to sync.
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

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

By using the or through the Fivetran dashboard.

Aircall Lite

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_id`	Your Aircall API ID.
`api_token`	Your Aircall API Token.

Authorization

There are two ways to authorize this connector type:

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

Airtable

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

Request

OAuth 2.0 authentication

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

Config parameters

Name	Description
`schema`	The connector schema has to be unique within the group (destination). Required for connector creation.
`client_id`	`Client ID` of your Airtable client application.
`client_secret`	`Client Secret` of your Airtable client application.
`refresh_token`	The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.

API key authentication

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

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

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`api_key`	API key of the Airtable account.

Authorization

There are three ways to authorize this connector type:

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

Alchemer Lite

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`query_param_value`	Your Alchemer API key.
`api_secret_key`	Your Alchemer API Secret key.
`sub_domain`	Your Alchemer subdomain.

Authorization

There are two ways to authorize this connector type:

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

Amazon Ads

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`region`	The region used by the Amazon Ads profile.	`NORTH_AMERICA`, `EUROPE`, `FAR_EAST`
`sync_mode`	Option to select connector should sync all profiles or specific profiles.	`AllProfiles`, `SpecificProfiles`
`profiles`	Specific User Profile IDs to sync. Must be populated if `sync_mode` is set to `SpecificProfiles`.
`attribution_window`	Time period used to attribute conversions based on clicks.	`DAY_1`, `DAY_7`, `DAY_14`, `DAY_30`

Authorization

There are two ways to authorize this connector type:

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

By using the or through the Fivetran dashboard.

Amazon Kinesis Firehose

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`role_arn`	The Role ARN required for authentication.
`bucket`	The name of the Kinesis bucket.
`prefix`	Folder path to the Kinesis files within the bucket.

Authorization

There are two ways to authorize this connector type:

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

Amazon S3

Request

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

{
    "service": "s3",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_s3",
        "table": "table_name",
        "bucket": "bucket_name",
        "auth_type": "IAM_ROLE",
        "external_id": "group_id",
        "role_arn": "arn::your_role_arn",
        "access_key_id":"access_key_id_value",
        "access_key_secret":"access_key_secret_value",
        "prefix": "folder_path",
        "pattern": "file_pattern",
        "file_type": "infer",
        "json_delivery_mode": "packed",
        "compression": "infer",
        "on_error": "skip",
        "append_file_option": "upsert_file",
        "archive_pattern": "regex_pattern",
        "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>",
        "line_separator": ";"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`bucket`	The S3 bucket name. Required for connector creation.
`auth_type`	The S3 Access approach. Required for connector creation. Default value: `IAM_ROLE`.	`IAM_ROLE`, `ACCESS_KEY`, `PUBLIC_BUCKET`
`external_id`	Used for authentication along with the `role_arn`. If not provided, it uses connector's `group_id`. Make sure to choose any of the `group_id` from your Fivetran account as the `external_id` parameter value. To find the `group_id`, use the . Required when `auth_type` is `IAM_ROLE`.
`role_arn`	The Role ARN. Required for authentication when `auth_type` is `IAM_ROLE`.
`access_key_id`	The access key ID. Required for authentication when `auth_type` is `ACCESS_KEY`.
`access_key_secret`	The access key secret. Required for authentication when `auth_type` is `ACCESS_KEY`.
`prefix`	All files and folders under this folder path will be searched for files to sync.
`pattern`	All files in your search path matching this regular expression will be synced.
`file_type`	If your files are saved with improper extensions, you can force them to be synced as the selected file type.	`avro`, `csv`, `json`, `jsonl`, `log`, `parquet`, `tsv`
`json_delivery_mode`	Specifies how Fivetran should handle your JSON data. Default value: `packed`.	`packed`, `unpacked`
`compression`	The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.	`bz2`, `gz`, `gzip`, `tar`, `tar_bz2`, `tar_gz`, `uncompressed`, `zip`
`on_error`	If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as `fail` unless you are certain that you have undesirable, malformed data.	`fail`, `skip`
`append_file_option`	If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.	`append_file`, `upsert_file`
`archive_pattern`	Files inside compressed archives with filenames matching this regular expression will be synced.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`delimiter`	You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`skip_before`	We will skip over the number of lines specified before syncing data.
`skip_after`	We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
`empty_header`	If your CSVs are headerless, set this is as `true`. When `true`, we will generate generic column names following the convention of `column_0`, `column_1`, ... `column_n` to map the rows. Default value: `false`.	`false`, `true`
`list_strategy`	The listing strategy you want to use. Default value: `complete_listing`.	`complete_listing`, `time_based_pattern_listing`
`use_pgp_encryption_options`	Set to `true` if files are encrypted using PGP in the S3 bucket. Default value: `false`.	`false`, `true`
`pgp_secret_key`	The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
`pgp_pass_phrase`	The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.

Authorization

There are two ways to authorize this connector type:

By specifying the 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.
By using the or the Fivetran dashboard.

Amazon Selling Partner Beta

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`region`	The region used by the Amazon Selling Partner profile.	`NORTH_AMERICA`, `EUROPE`, `FAR_EAST`
`merchant_id`	The Merchant ID or Vendor Code.
`is_vendor`	Whether or not you have a Vendor Account. Default value: `false`.	`true`, `false`

Authorization

There are two ways to authorize this connector type:

By specifying the following parameters in the auth section.

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

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

Auth parameters

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.

By using the or the Fivetran dashboard.

Amplitude

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`project`	The project name you wish to use with Fivetran.
`api_key`	The API key of the project.
`secret_key`	The secret key of the project.

Authorization

There are two ways to authorize this connector type:

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

Anaplan

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`auth_mode`	The Anaplan authentication method.	`Basic`, `Certificate`
`username`	Your Anaplan user ID. Must be populated if `auth_mode` is set to `Basic`.
`password`	Your Anaplan password. Must be populated if `auth_mode` is set to `Basic`.
`certificate`	The contents of your PEM certificate file. Must be populated if `auth_mode` is set to `Certificate`.
`private_key`	The contents of your private key file. Must be populated if `auth_mode` is set to `Certificate`.
`sync_mode`	Whether to sync all exports or specific exports.	`AllExports`, `SpecificExports`
`selected_exports`	The list of export IDs in the format `<workspace_id><model_id><export_id>` that the connector will sync. Must be populated if `sync_mode` is set to `SpecificExports`.

Authorization

There are two ways to authorize this connector type:

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.
After creation using the or the Fivetran dashboard.

Apache Kafka

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`consumer_group`	Kafka consumer group name.
`servers`	Comma-separated list of Kafka servers in the format `server:port`.
`message_type`	Kafka message type.	`Json`, `Text`
`sync_type`	Kafka sync type. Unpacked messages must be valid JSON.	`Unpacked`, `Packed`
`security_protocol`	Security protocol for Kafka interaction.	`PLAINTEXT`, `SSL`

Authorization

There are two ways to authorize this connector type:

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

Appcues Lite Private Preview

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Appcues API key.
`secret`	Your Appcues Secret.
`account_id`	Your Appcues Account ID.
`email`	Your Appcues Email.

Authorization

There are two ways to authorize this connector type:

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

Appfigures Lite

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_key`	Your Appfigures client key.
`username`	Your Appfigures username.
`password`	Your Appfigures password.

Authorization

There are two ways to authorize this connector type:

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

Apple App Store

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Apple ID
`password`	Your password
`app_specific_password`	Your app-specific password
`apps`	Specific apps to sync. Must be populated if `app_sync_mode` is set to `SpecificApps`.
`sales_accounts`	Specific sales account to sync. Must be populated if `sales_account_sync_mode` is set to `SpecificSalesAccounts`.
`finance_accounts`	Specific finance accounts to sync. Must be populated if `finance_account_sync_mode` is set to `SpecificFinanceAccounts`.
`app_sync_mode`	Whether to sync all apps or specific apps.	`AllApps`, `SpecificApps`
`sales_account_sync_mode`	Whether to sync all sales accounts or specific sales accounts.	`AllSalesAccounts`, `SpecificSalesAccounts`
`finance_account_sync_mode`	Whether to sync all finance accounts or specific finance accounts.	`AllFinanceAccounts`, `SpecificFinanceAccounts`
`timeframe_months`	Historical sync time frame in months.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Apple Search Ads

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 .

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`is_auth2_enabled`	The contents of your PEM certificate file. Default value: `false`	`true`, `false`
`pem_certificate`	The contents of your PEM certificate file. Must be populated if `is_auth2_enabled` is set to `false`.
`private_key`	The contents of your secret key file. Must be populated if `is_auth2_enabled` is set to `false`.
`client_id`	Apple Search Ads REST API Client ID. Must be populated if `is_auth2_enabled` is set to `true`.
`team_id`	Apple Search Ads REST API Team ID. Must be populated if `is_auth2_enabled` is set to `true`.
`key_id`	Apple Search Ads REST API Key ID. Must be populated if `is_auth2_enabled` is set to `true`.
`pem_private_key`	The contents of your PEM secret key file. Must be populated if `is_auth2_enabled` is set to `true`.
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

There are three ways to authorize this connector type:

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

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

By using the or the Fivetran dashboard.

AppsFlyer

Request

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

Sync using webhooks and Data Locker

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`access_key_id`	Your AWS access key ID.
`secret_key`	Your AWS secret key.
`home_folder`	Your S3 home folder path of the Data Locker.
`sync_data_locker`	Select `true` to sync AppsFlyer data using webhooks and Data Locker.
`use_customer_bucket`	Use Custom S3 Bucket. Should be set to `true` if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket.
`bucket`	Customer S3 Bucket.
`role_arn`	S3 Role ARN.

Sync using webhooks and Pull API

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_data_locker`	Select `false` to sync AppsFlyer data using webhooks and Pull API.
`sync_pull_api`	Select `true` to sync AppsFlyer data using webhooks and Pull API.
`api_token`	Your AppsFlyer API token.
`app_ids`	List of App IDs.
`app_id`	Your App ID.

Sync using only webhooks

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_data_locker`	Select `false` to sync AppsFlyer data using only webhooks.

Authorization

There are three ways to authorize this connector type:

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

Asana

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all projects or specific projects.	`AllProjects`, `SpecificProjects`
`projects`	Specific Project IDs to sync. Must be populated if `syncMode` is set to `SpecificProjects`.

Authorization

There are two ways to authorize this connector type:

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 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. |
By using the or through the Fivetran dashboard.

Awin Lite Private Preview

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_token`	Your Awin API Token.
`region`	Your Awin Region.

Authorization

There are two ways to authorize this connector type:

By specifying the api_token and region field in the request.
By using the or the Fivetran dashboard.

AWS CloudTrail

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`external_id`	This is the same as your `group_id`, used for authentication along with the `role_arn`.
`role_arn`	The Role ARN required for authentication.
`bucket`	The AWS bucket name which is configured for AWS CloudTrail.
`prefix`	If prefix is present when configuring the bucket.

Authorization

There are two ways to authorize this connector type:

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

AWS Cost Explorer Private Preview

Request

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 parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`role_arn`	The Role ARN required for authentication.

Authorization

There are two ways to authorize this connector type:

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

AWS Inventory

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`role_arn`	The Role ARN required for authentication.
`bucket`	The AWS bucket name that is configured for AWS Config.
`prefix`	The prefix if you used one when configuring the bucket.

Authorization

There are two ways to authorize this connector type:

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

AWS Lambda

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`function`	The name of your AWS Lambda Function.
`sync_method`	The sync method. Default value: `DIRECT`.	`DIRECT`, `CLOUD_STORAGE`
`role_arn`	The Role ARN required for authentication.
`s3bucket`	The S3 bucket name.
`external_id`	This is the same as your `group_id`, used for authentication along with the `role_arn`.
`region`	The AWS region code. For example, `us-east-1`.
`is_privatelink_required`	Connect using AWS PrivateLink.	`true`, `false`
`secrets_list`	The list of secrets that should be passed to the function at runtime.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: function, role_arn and secrets_list.
By using the or the Fivetran dashboard.

AWS MSK Beta

Request

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

{
    "service": "aws_msk",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_msk",
        "consumer_group": "consumer_group",
        "servers": "serveraddress1:8080, serveraddress2:8080",
        "message_type": "Json", 
        "sync_type": "Packed",  
        "security_protocol": "SSL",      
        "saslScram512Key": "sasl_key",
        "saslScram512Secret": "sasl_secret",
        "truststore": "test_truststore",
        "keystore": "test_keystore",
        "keystore_password": "keystore_password",
        "key_password": "key_password"
        
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`consumer_group`	The name of consumer group created for Fivetran.
`servers`	Comma-separated list of Kafka servers in the `server:port` format.
`message_type`	The Message type.	`Json`, `Avro`, `Text`, `Protobuf`
`sync_type`	The sync type. Unpacked messages must be valid JSON.	`Packed`, `Unpacked`
`security_protocol`	The security protocol for Kafka interaction.	`PLAINTEXT`, `TLS`, `SASL`
`sasl_scram512_key`	If `security_protocol` is set to `SASL`, enter your secret's `saslScram512Key`.
`sasl_scram512_secret`	If `security_protocol` is set to `SASL`, enter your secret's `saslScram512Key`.
`truststore`	If `security_protocol` is set to `TLS`, add the `Truststore File` as a Base64-encoded string.
`keystore`	If `security_protocol` is set to `TLS`, add the `Keystore File` as a Base64-encoded string.
`keystore_password`	If `security_protocol` is set to `TLS`, enter your `Keystore Password`.
`key_password`	If `security_protocol` is set to `TLS`, enter your `Key Password`.

Authorization

There are two ways to authorize this connector type:

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.
By using the or the Fivetran dashboard.

Azure Blob Storage

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`container_name`	The name of the blob container.
`connection_string`	The blob storage container connection string.
`prefix`	All files and folders under this folder path will be searched for files to sync.
`pattern`	All files in your search path matching this regular expression will be synced.
`file_type`	If your files are saved with improper extensions, you can force them to by synced as the selected file type.	`infer`, `csv`, `json`, `tsv`, `avro`
`json_delivery_mode`	Specifies how Fivetran should handle your JSON data. Default value: `packed`.	`packed`, `unpacked`
`compression`	The secrets that should be passed to the function at runtime.	`infer`, `uncompressed`, `tar`, `tar_bz2`, `tar_gz`
`on_error`	If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.	`fail`, `skip`
`append_file_option`	If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.	`upsert_file`, `append_file`
`archive_pattern`	Files inside of compressed archives with filenames matching this regular expression will be synced.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`delimiter`	You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`skip_before`	We will skip over the number of lines specified before syncing data.
`skip_after`	We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
`connection_method`	Connection Method.	`DIRECT`: Fivetran will connect directly to your storage container,`SSH_TUNNEL`: Fivetran will connect to your storage container using a host machine (commonly used for VPN connections),`PRIVATE_LINK`: Fivetran will connect to your storage container using PrivateLink.
`container_address`	IP Address of Azure Storage Container which is accessible from host machine.
`host_ip`	IP address of host tunnel machine which is used to connect to Storage Container.
`host_user`	Username in the host machine.
`use_pgp_encryption_options`	Set to `true` if files present in the Azure Blob Storage container are encrypted using PGP. Default value: `false`.	`false`, `true`
`pgp_secret_key`	The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
`pgp_pass_phrase`	The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.

Authorization

There are two ways to authorize this connector type:

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

Azure Boards Lite Private Preview

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Azure Boards Organization Name.

Authorization

There are two ways to authorize this connector type:

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 parameters

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

By using the or the Fivetran dashboard.

Azure Devops Private Preview

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Azure Devops Organization Name.

Authorization

There are two ways to authorize this connector type:

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 parameters

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

By using the or the Fivetran dashboard.

Azure Functions

Request

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

{
    "service": "azure_function",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_azure_function",
        "function_app": "function_app_name",
        "function_name": "function_name",
        "function_key": "function_key",
        "secrets": "{'secret1':'xxxxxxx', 'secret2':'xxxxxxx'}",
        "connection_method": "DIRECT"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`function_app`	Function app name in Azure portal.
`function_name`	Name of the function to be triggered.
`function_key`	Function key used for authorization.
`secrets`	The secrets that should be passed to the function at runtime.
`connection_method`	The Fivetran connection method to your function. `DIRECT`: Fivetran connects directly to your function, `PRIVATE_LINK`: Fivetran connects to your function using PrivateLink.

Authorization

There are two ways to authorize this connector type:

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

Azure Event Hubs

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`connection_string`	Connection string of the Event Hub Namespace you want to sync.
`consumer_group`	Name of consumer group created for Fivetran.
`message_type`	Message type.	`Json`, `Text`
`sync_type`	Sync type. Unpacked messages must be valid JSON.	`Packed`, `Unpacked`

Authorization

There are two ways to authorize this connector type:

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

BambooHR

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`subdomain`	The subdomain used to access your account. If you access BambooHR at `mycompany.bamboohr.com`, then the subdomain is `mycompany`.
`api_key`	Your .

Authorization

There are two ways to authorize this connector type:

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

BigQuery Beta

Request

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 parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`project_id`	BigQuery project ID.
`data_set_name`	BigQuery Data set name
`secret_key`	Private key of the customer service account.
`use_service_account`	BigQuery use service account.

Initial Configuration

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

Authorization

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

BigCommerce Beta

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`store_hash`	The in your API path.
`access_token`	Your .

Authorization

There are two ways to authorize this connector type:

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

BillingPlatform Lite Private Preview

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`base_url`	Your BillingPlatform base URL.

Authorization

There are two ways to authorize this connector type:

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 parameters

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

By using the or the Fivetran dashboard.

Birdeye Lite

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`business_id`	Your Birdeye Business ID.
`query_param_value`	Your Birdeye API Key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: business_id and query_param_value.
By using the or the Fivetran dashboard.

Box

The connector supports two sync strategies:

Magic Folder Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`folder_id`	Your Box Folder URL.

Merge Mode Request

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

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

{
   "service": "box",
   "group_id": "target_group_id",
   "config": {
      "schema": "test_box",
      "table": "test_table",
      "prefix": "folder_path",
      "pattern": "file_pattern",
      "file_type": "infer",
      "json_delivery_mode": "packed",
      "compression": "infer",
      "on_error": "fail",
      "append_file_option": "upsert_file",
      "archive_pattern": "regex_pattern",
      "null_sequence": "",
      "delimiter": "|",
      "escape_char": "escape_char",
      "skip_before": "0",
      "skip_after": "0",
      "is_single_table_mode": "true",
      "line_separator": ";"
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema` (required)	The connector schema name has to be unique within the group (destination).
`table` (required)	The table name within the schema to which the connector will sync the data.
`prefix`	All files and folders under this folder path will be searched for files to sync.
`pattern`	All files in your search path matching this regular expression will be synced.
`file_type`	If your files are saved with improper extensions, you can force them to be synced as the selected file type.	`infer`, `csv`, `json`, `tsv`, `avro`, `parquet`
`json_delivery_mode`	Specifies how Fivetran should handle your JSON data. Default value: `packed`.	`packed`, `unpacked`
`compression`	The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.	`infer`, `uncompressed`, `tar`, `tar_bz2`, `tar_gz`
`on_error`	If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.	`fail`, `skip`
`append_file_option`	If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.	`upsert_file`, `append_file`
`archive_pattern`	Files inside of compressed archives with filenames matching this regular expression will be synced.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`delimiter`	You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`skip_before`	We will skip over the number of lines specified before syncing data.
`skip_after`	We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
`is_single_table_mode` (required as `true`)	Allows the creation of connector using Merge Mode strategy.	`true`, `false`
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.

Authorization

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

Braintree

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`public_key`	The contents of your PEM certificate file.
`private_key`	The contents of your secret key file.
`merchant_id`	Your Braintree merchant ID.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: public_key, private_key and merchant_id.
By using the or the Fivetran dashboard.

Branch

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

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

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

Braze

Request

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

AWS S3

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

GCS

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_url`	Your Braze API URL.
`api_key`	Your Braze API Key.
`cloud_storage_type`	Cloud storage type Braze Current is connected to.	`AWS_S3`, `GCS`
`s3bucket`	Your S3 bucket required if `AWS_S3` is the `cloud_storage_type`
`s3role_arn`	The Role ARN required for authentication required if `AWS_S3` is the `cloud_storage_type`
`s3external_id`	This is the same as your `group_id`, used for authentication along with the `role_arn` required if `AWS_S3` is the `cloud_storage_type`
`s3folder`	Your S3 folder name required if `AWS_S3` is the `cloud_storage_type`
`gcs_bucket`	Your GCS bucket. Required if `GCS` is the `cloud_storage_type`
`gcs_folder`	Your GCS folder name. Required if `GCS` is the `cloud_storage_type`

NOTE: If GCS cloud storage type is being used, then you will need to grant Fivetran access to your Google Cloud Storage bucket.

Authorization

There are three ways to authorize this connector type:

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

Brex Lite

Request

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

{
  "service": "brex",
  "group_id": "target_group_id",
  "config": {
    "schema": "brex_schema_name",
    "api_token": "your_brex_api_token",
    "base_url": "your_brex_base_url"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_token`	Your Brex API token
`base_url`	Your Brex Base URL

Authorization

There are two ways to authorize this connector type:

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

Calendly Lite

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following parameters in the auth section: client_access, refresh_token and access_token

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

{
   "service": "calendly",
   "group_id": "target_group_id",
   "config": {
      "schema": "calendly_schema_name"
   },
   "auth": {
       "client_access": {
           "client_id": "your_calendly_client_id",
           "client_secret": "your_calendly_client_secret" 
   },
   "refresh_token": "calendly_refresh_token",
   "access_token": "calendly_access_token"
        }
}
content_copy

Auth parameters

Name	Description
`client_id`	Your Calendly Client ID.
`client_secret`	Your Calendly Client Secret.
`refresh_token`	Your Calendly refresh token.
`access_token`	Your Calendly access token.

By using the or the Fivetran dashboard.

Canny Lite Private Preview

Request

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

{
   "service": "canny",
   "group_id": "target_group_id",
   "config": {
      "schema": "canny_schema_name",
      "api_key": "your_canny_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Canny API key.

Authorization

By specifying the value for the api_key field in the request.
By using the or the Fivetran dashboard.

ChannelAdvisor

Request

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

{
   "service": "channel_advisor",
   "group_id": "target_group_id",
   "config": {
      "schema": "channel_advisor_schema_name"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

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

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

{
   "service": "channel_advisor",
   "group_id": "target_group_id",
   "config": {
      "schema": "channel_advisor_schema_name"
   },
   "auth": {
       "client_access": {
           "client_id": "your_channel_advisor_client_id",
           "client_secret": "your_channel_advisor_client_secret"
       }
   }
}
content_copy

Auth parameters

Name	Description
`client_access.client_id`	Your ChannelAdvisor Client ID.
`client_access.client_secret`	Your ChannelAdvisor Client Secret.

By using the or the Fivetran dashboard.

Chargebee Product Catalog 1.0 Lite

Request

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

{
   "service": "chargebee_product_catalog_1",
   "group_id": "target_group_id",
   "config": {
      "schema": "chargebee_schema_name",
      "sub_domain": "http://your.sub.domain/",
      "api_key": "your_chargebee_API_key",
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Chargebee Product Catalog 1 subdomain.
`api_key`	Your Chargebee Product Catalog 1 API key.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: sub_domain and api_key.
By using the or the Fivetran dashboard.

Chargebee Product Catalog 2.0 {{ typeBadge "chargebee_product_catalog_2" }} {{ availabilityBadge "chargebee_product_catalog_2"}}

Request

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

{
   "service": "chargebee_product_catalog_2",
   "group_id": "target_group_id",
   "config": {
      "schema": "chargebee_schema_name",
      "sub_domain": "http://your_chargebee_subdomain/",
      "api_key": "your_chargebee_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Chargebee subdomain.
`api_key`	Your Chargebee API key.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: sub_domain and api_key.
By using the or the Fivetran dashboard.

ChargeDesk Lite

Request

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

{
   "service": "chargedesk",
   "group_id": "target_group_id",
   "config": {
      "schema": "chargedesk_schema_name",
      "token_id": "your_chargedesk_token_id"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`token_id`	Your ChargeDesk token ID.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the token_id field in the request.
By using the or the Fivetran dashboard.

Churnkey Lite

Request

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

{
  "service": "churnkey",
  "group_id": "target_group_id",
  "config": {
    "schema": "churnkey_schema_name",
    "api_key": "your_churnkey_api_key",
    "app_id": "your_churnkey_app_id"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Churnkey API Key.
`app_id`	Your Churnkey APP ID.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: api_key and app_id.
By using the or the Fivetran dashboard.

ChurnZero Lite

Request

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

{
  "service": "churnzero",
  "group_id": "target_group_id",
  "config": {
     "schema": "churnzero_schema_name",
     "subdomain": "your_churnzero_subdomain",
     "username": "your_churnzero_username",
     "api_key": "your_churnzero_api_key"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`subdomain`	Your ChurnZero subdomain.
`username`	Your ChurnZero username.
`api_key`	Your ChurnZero API key.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: subdomain, username, and api_key.
By using the or the Fivetran dashboard.

Cimis Lite Private Preview

Request

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

{
   "service": "cimis",
   "group_id": "target_group_id",
   "config": {
      "schema": "cimis_schema_name",
      "api_key": "your_cimis_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Cimis API key.

Authorization

There are two ways to authorize this connector type:

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

Cin7 Lite

Request

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

{
   "service": "cin7",
   "group_id": "target_group_id",
   "config": {
      "schema": "cin7_schema_name",
      "username": "your_cin7_api_username",
      "password": "your_cin7_api_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Cin7 API Username.
`password`	Your Cin7 API Key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username and password.
By using the or the Fivetran dashboard.

Clari Lite

Request

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

{
   "service": "clari",
   "group_id": "target_group_id",
   "config": {
      "schema": "clari_schema_name",
      "forecast_id": "your_clari_forecast_id",
      "api_token": "your_clari_api_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`forecast_id`	Your Clari forecast ID.
`api_token`	Your Clari API token.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: api_token and forecast_id.
By using the or the Fivetran dashboard.

ClickUp Lite

Request

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

{
   "service": "clickup",
   "group_id": "target_group_id",
   "config": {
      "schema": "clickup_schema_name",
      "api_key": "your_clickup_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your ClickUp API token.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

CloudFront

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`external_id`	This is the same as your `group_id`, used for authentication along with the `role_arn`.
`role_arn`	The Role ARN required for authentication.
`bucket`	The bucket name for CloudFront.
`prefix`	The name of the CloudFront folder in the bucket.

Authorization

There are two ways to authorize this connector type:

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

Collibra Lite

Request

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

{
   "service": "collibra",
   "group_id": "target_group_id",
   "config": {
      "schema": "collibra_schema_name",
      "username": "your_collibra_username",
      "password": "your_collibra_password",
      "sub_domain": "your_collibra_subdomain"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Collibra username.
`password`	Your Collibra password.
`sub_domain`	Your Collibra subdomain.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: user_name, password and sub_domain.
By using the or the Fivetran dashboard.

Confluence Lite Private Preview

Request

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

{
  "service": "confluence",
  "group_id": "target_group_id",
  "config": {
     "schema": "confluence_schema_name",
     "username": "your_email",
     "sub_domain": "your_organization_name",
     "password": "your_api_token"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Confluence email address.
`sub_domain`	Your Confluence Organization name.
`password`	The Confluence API token.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username, sub_domain and password.
By using the or the Fivetran dashboard.

Confluent Cloud

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`consumer_group`	Confluent Cloud consumer group name.
`servers`	Comma-separated list of Confluent Cloud servers in the format `server:port`.
`message_type`	Confluent Cloud message type.	`Json`, `Avro`, `Text`
`sync_type`	Kafka sync type. Unpacked messages must be valid JSON.	`Unpacked`, `Packed`
`security_protocol`	Security protocol for Confluent Cloud interaction.	`PLAINTEXT`, `SASL_SSL`

Authorization

There are two ways to authorize this connector type:

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

Contrast Security Lite Private Preview

Request

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

{
   "service": "contrast_security",
   "group_id": "target_group_id",
   "config": {
      "schema": "contrast_security_schema_name",
      "username": "your_contrast_security_username",
      "password": "your_contrast_security_password",
      "api_key": "your_contrast_security_api_key",
      "sub_domain": "your contrast_security_subdomain"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Contrast Security username.
`password`	Your Contrast Security password.
`api_key`	Your Contrast Security API key.
`sub_domain`	Your Contrast Security subdomain.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username, password, api_key and sub_domain.
By using the or the Fivetran dashboard.

Cosmos DB

Request with `account_key`

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

{
    "service": "cosmos",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix":"schema_prefix",
        "uri":"cosmos_host_uri",
        "data_access_method":"ACCOUNT_KEY",
        "account_key": "account_key",
        "sync_pack_mode":"sync_pack_mode"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`uri`	The base host URI of the database account.
`data_access_method`	The source data access method. Supported values: `ACCOUNT_KEY`- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants. `RESOURCE_TOKEN`- Fine-grained permission model based on native Azure Cosmos DB users and permissions. Learn more in our .
`account_key`	The read-only primary or secondary account key for the database account. Required for the `ACCOUNT_KEY` data access method.
`sync_pack_mode`	The packing mode type. Supported values: `STANDARD_UNPACKED_MODE`- Unpacks one layer of nested fields and infers types. `PACKED_MODE`- Delivers packed data as a single destination column value. Learn more in our .

Request with `resource_token`

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

{
    "service": "cosmos",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix":"schema_prefix",
        "uri":"cosmos_host_uri",
        "data_access_method":"RESOURCE_TOKEN",
        "resource_token":"resource_token",
        "token_authenticated_database":"token_authenticated_database",
        "token_authenticated_container":"token_authenticated_container",
        "sync_pack_mode":"sync_pack_mode"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`uri`	The base host URI of the database account.
`data_access_method`	The source data access method. Supported values: `ACCOUNT_KEY`- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants. `RESOURCE_TOKEN`- Fine-grained permission model based on native Azure Cosmos DB users and permissions. Learn more in our .
`resource_token`	A token that provides access to a specific Cosmos DB resource. Required for the `RESOURCE_TOKEN` data access method.
`token_authenticated_database`	The database name. Required for the `RESOURCE_TOKEN` data access method.
`token_authenticated_container`	The container name. Required for the `RESOURCE_TOKEN` data access method.
`sync_pack_mode`	The packing mode type. Supported values: `STANDARD_UNPACKED_MODE`- Unpacks one layer of nested fields and infers types. `PACKED_MODE`- Delivers packed data as a single destination column value. Learn more in our .

Coupa

Request

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

{
    "service": "coupa",
    "group_id": "target_group_id",
    "config": {
        "schema": "coupa_schema",
        "instance": "instance",
        "client_id": "client_id",
        "client_secret": "client_secret"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`instance`	The instance name of your Coupa account in the URL.
`client_id`	Your Coupa client_id.
`client_secret`	Your Coupa client_secret.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: instance and api_key.
By using the or the Fivetran dashboard.

Criteo

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	Your Criteo Client ID.
`client_secret`	Your Criteo client secret key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: client_id and client_secret.
By using the or the Fivetran dashboard.

Crossbeam Lite

Request

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

{
  "service": "crossbeam",
  "group_id": "target_group_id",
  "config": {
    "schema": "crossbeam_schema_name"
  },
  "auth": {
    "client_access": {
      "client_id": "my_client_id",
      "client_secret": "my_client_secret"
    }
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	Your Crossbeam Client ID.
`client_secret`	Your Crossbeam Client secret.

Authorization

There are two ways to authorize this connector type:

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

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

{
   "service": "crossbeam",
   "group_id": "target_group_id",
   "config": {
      "schema": "crossbeam_schema_name"
   },
   "auth": {
       "client_access": {
           "client_id": "crossbeam_client_id",
           "client_secret": "crossbeam_client_secret"
       }
   }
}
content_copy

Auth parameters

Name	Description
`client_access.client_id`	Your Crossbeam `Client ID`.
`client_access.client_secret`	Your Crossbeam `Client Secret`.

By using the or the Fivetran dashboard.

Customer.io Private Preview

Request

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

{
   "service": "customerio",
   "group_id": "target_group_id",
   "config": {
      "schema": "customerio_schema_name",
      "bearer_token": "your_customerio_app_api_key",
      "sub_domain": "your_customerio_subdomain (api or api-eu)"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`bearer_token`	Your Customer.io App API Key.
`sub_domain`	Your Customer.io subdomain.

Authorization

There are two ways to authorize this connector type:

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

DCL Logistics Lite Private Preview

Request

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

{
   "service": "dcl_logistics",
   "group_id": "target_group_id",
   "config": {
      "schema": "dcl_logistics_schema_name",
      "api_key": "your_dcl_logistics_api_key",
      "username": "your_dcl_logistics_username"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your DCL Logistics API key.
`username`	Your DCL Logistics username.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: api_key and username.
By using the or the Fivetran dashboard.

DEAR Lite

Request

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

{
   "service": "dear",
   "group_id": "target_group_id",
   "config": {
      "schema": "dear_schema_name",
      "account_id": "your_dear_account_id",
      "application_key": "your_dear_application_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`account_id`	Your DEAR account ID.
`application_key`	Your DEAR application key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: account_id and application_key.
By using the or the Fivetran dashboard.

Delighted

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	API Key for your Delighted account

Authorization

There are two ways to authorize this connector type:

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

Destini Lite Private Preview

Request

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

{
   "service": "destini",
   "group_id": "target_group_id",
   "config": {
      "schema": "destini_schema_name",
      "client_name": "your_destini_client_name",
      "api_key": "your_destini_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_name`	Your Destini client name.
`api_key`	Your Destini API key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: client_name and api_key.
By using the or the Fivetran dashboard.

Dixa Lite

Request

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

{
   "service": "dixa",
   "group_id": "target_group_id",
   "config": {
      "schema": "dixa_schema_name",
      "api_token": "your_dixa_api_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_token`	Your Dixa API token.

Authorization

There are two ways to authorize this connector type:

By specifying the api_token field in the request.
By using the or the Fivetran dashboard.

Docebo Lite

Request

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

{
   "service": "docebo",
   "group_id": "target_group_id",
   "config": {
      "schema": "docebo_schema_name",
      "sub_domain": "your_docebo_domain_name"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Docebo subdomain.

Authorization

There are two ways to authorize this connector type:

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

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

{
   "service": "docebo",
   "group_id": "target_group_id",
   "config": {
      "schema": "docebo_schema_name",
      "sub_domain": "your_docebo_domain_name"
   },
   "auth": {
       "client_access": {
           "client_id": "docebo_client_id",
           "client_secret": "docebo_client_secret"
       },
       "refresh_token": "my_refresh_token",
       "access_token": "my_access_token"
   }
}
content_copy

Auth parameters

Name	Description
`client_access.client_id`	Your Docebo Client ID.
`client_access.client_secret`	Your Docebo Client Secret.
`refresh_token`	Your Docebo Refresh Token.
`access_token`	Your Docebo Access Token.

By using the or the Fivetran dashboard.

DocumentDB

Fivetran supports the following DocumentDB configuration:

To learn more, see the setup guide for your DocumentDB connector type.

Request

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

{
    "service": "documentdb",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_documentdb",
        "host": "documentdbinstance.mycompany.com",
        "port": 27017,
        "user": "test_user",
        "password": "test_password",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "sync_pack_mode":"sync_pack_mode"
    }
}
content_copy

Config parameters

Name	Description	Notes
`schema_prefix`	Connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	A host/IP address of the primary node.
`port`	A port of the primary node.
`user`	The user name.
`password`	The user's password.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values:`SshTunnel`, `PrivateLink` . `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
`sync_pack_mode`	The packing mode type. Supported values: `UNPACKED_MODE`- Unpacks one layer of nested fields and infers types. `PACKED_MODE`- Delivers packed data as a single destination column value. Learn more in our .

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user and password.
By using the or the Fivetran dashboard.

Drift Lite

Request

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

{
   "service": "drift",
   "group_id": "target_group_id",
   "config": {
      "schema": "drift_schema_name",
      "sub_domain": "your_drift_subdomain"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Drift subdomain.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following parameter in the auth section: client_access, refresh_token, and access_token.

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

{
   "service": "drift",
   "group_id": "target_group_id",
   "config": {
      "schema": "drift_schema_name",
      "sub_domain": "your_drift_domain_name"
   },
   "auth": {
       "client_access": {
           "client_id": "drift_client_id",
           "client_secret": "drift_client_secret"
       },
       "refresh_token": "my_refresh_token",
       "access_token": "my_access_token"
   }
}
content_copy

Auth parameters

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

By using the or the Fivetran dashboard.

Drip Lite

Request

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

{
   "service": "drip",
   "group_id": "target_group_id",
   "config": {
      "schema": "drip_schema_name",
      "api_key": "your_drip_API_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Drip API Token.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_token field in the request.
By using the or the Fivetran dashboard.

Dropbox

The connector supports two sync strategies:

Magic Folder Request

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

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

NOTE: For Magic Folder mode, ensure that the "schema" name doesn't contain a . If you are switching from Merge mode, don't include a "table" name in the "config" parameter.

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`folder`	Your Dropbox Folder URL.

Merge Mode Request

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

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

{
   "service": "dropbox",
   "group_id": "target_group_id",
   "config": {
      "schema": "test_dropbox",
      "table": "dest_table",
      "prefix": "folder_path",
      "pattern": "file_pattern",
      "file_type": "infer",
      "json_delivery_mode": "packed",
      "compression": "infer",
      "on_error": "fail",
      "append_file_option": "upsert_file",
      "archive_pattern": "regex_pattern",
      "null_sequence": "",
      "delimiter": "|",
      "escape_char": "escape_char",
      "skip_before": "0",
      "skip_after": "0",
      "is_single_table_mode": "true",
      "line_separator": ";"
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema` (required)	The connector schema name has to be unique within the group (destination).
`table` (required)	The table name within the schema to which the connector will sync the data.
`prefix`	All files and folders under this folder path will be searched for files to sync.
`pattern`	All files in your search path matching this regular expression will be synced.
`file_type`	If your files are saved with improper extensions, you can force them to be synced as the selected file type.	`infer`, `csv`, `json`, `tsv`, `avro`, `parquet`
`json_delivery_mode`	Specifies how Fivetran should handle your JSON data. Default value: `packed`.	`packed`, `unpacked`
`compression`	The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.	`infer`, `uncompressed`, `tar`, `tar_bz2`, `tar_gz`
`on_error`	If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.	`fail`, `skip`
`append_file_option`	If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.	`upsert_file`, `append_file`
`archive_pattern`	Files inside of compressed archives with filenames matching this regular expression will be synced.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`delimiter`	You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`skip_before`	We will skip over the number of lines specified before syncing data.
`skip_after`	We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
`is_single_table_mode` (required as `true`)	Allows the creation of connector using Merge Mode strategy.	`true`, `false`
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.

Authorization

There are two ways to authorize this connector type:

By specifying the 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"
   }
}
content_copy

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.

By using the or the Fivetran dashboard.

Dropbox Sign Lite Private Preview

Request

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

{
   "service": "dropbox_sign",
   "group_id": "target_group_id",
   "config": {
      "schema": "dropbox_sign_schema_name",
      "api_key": "dropbox_sign_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Dropbox Sign API key.

Authorization

There are two ways to authorize this connector type:

By specifying the value for the api_key field in the request.
By using the or the Fivetran dashboard.

DynamoDB

Before creating a DynamoDB connection, you must first follow the

Request

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

{
    "service": "dynamodb",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_dynamodb",
        "external_id": "external_id",
        "role_arn": "arn::your_role_arn",
        "aws_region_code": "aws_region_code",
        "sync_mode": "UseUnpackedModeOnly",
        "packed_mode_tables": []
    }
}
content_copy

Config parameters

Name	Description	Notes
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`external_id`	This is the same as your `group_id`, used for authentication along with the `role_arn`.
`role_arn`	The Role ARN required for authentication.
`aws_region_code`	The AWS region code for the DynamoDB instance, e.g. `us-east-1`.
`sync_mode`	Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.	`UseUnpackedModeOnly`, `SelectTablesForPackedMode`.
`packed_mode_tables`	Specific tables to sync. Must be populated if `sync_mode` is set to `SelectTablesForPackedMode`.	Use the following format: `<db>.<table>` (case-sensitive).

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: external_id, role_arn and aws_region_code.
By using the or the Fivetran dashboard.

EasyPost Lite

Request

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

{
   "service": "easypost",
   "group_id": "target_group_id",
   "config": {
      "schema": "easypost_schema_name",
      "api_key": "your_easypost_API_Key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your EasyPost API Key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the following field in the request: api_key.
By using the or the Fivetran dashboard.

e-conomic Lite Private Preview

Request

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

{
  "service": "e-conomic",
  "group_id": "target_group_id",
  "config": {
     "schema": "e-conomic_schema_name",
     "agreement_grant_token": "your_agreement_grant_token",
     "app_secret_token": "your_app_secret_token"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`agreement_grant_token`	Your e-conomic AgreementGrantToken.
`app_secret_token`	Your e-conomic AppSecretToken.

Authorization

There are two ways to authorize this connector type:

By specifying the agreement_grant_token and app_secret_token fields in the request.
By using the or the Fivetran dashboard.

Eloqua

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

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

Email

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

Request

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

{
    "service": "email",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_email",
        "table": "table_name",
        "pattern": "file_pattern",
        "file_type": "infer",
        "json_delivery_mode": "packed",
        "compression": "infer",
        "archive_pattern": "regex_pattern",
        "null_sequence": "",
        "delimiter": "",
        "escape_char": "",
        "skip_before": "0",
        "skip_after": "0",
        "line_separator": ";"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`pattern`	All files in your search path matching this regular expression will be synced.
`file_type`	If your files are saved with improper extensions, you can force them to by synced as the selected file type.	`infer`, `csv`, `json`, `tsv`, `avro`
`json_delivery_mode`	Specifies how Fivetran should handle your JSON data. Default value: `packed`.	`packed`, `unpacked`
`compression`	The secrets that should be passed to the function at runtime.	`infer`, `uncompressed`, `tar`, `tar_bz2`, `tar_gz`
`archive_pattern`	Files inside of compressed archives with filenames matching this regular expression will be synced.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`delimiter`	You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`skip_before`	We will skip over the number of lines specified before syncing data.
`skip_after`	We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.

Authorization

There are two ways to authorize this connector type:

By specifying the required fields in the request.
By using the or the Fivetran dashboard.

Eventbrite Lite

Request

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

{
   "service": "eventbrite",
   "group_id": "target_group_id",
   "config": {
      "schema": "eventbrite_schema_name"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_access field in the auth section.

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

{
   "service": "eventbrite",
   "group_id": "target_group_id",
   "config": {
      "schema": "eventbrite_schema_name"         
   },
   "auth": {
       "client_access": {
           "client_id": "your_eventbrite_client_id",
           "client_secret": "your_eventbrite_client_secret"
       }
   }
}
content_copy

Auth parameters

Name	Description
`client_access.client_id`	Your Eventbrite Client ID.
`client_access.client_secret`	Your Eventbrite Client Secret.

By using the or the Fivetran dashboard.

Everhour Lite

Request

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

{
   "service": "everhour",
   "group_id": "target_group_id",
   "config": {
     "schema": "everhour_schema_name",
     "api_key": "your_everhour_api_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Everhour API Token.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Expensify {{ typeBadge "expensify" }} {{ availabilityBadge "expensify"}}

Request

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

{
   "service": "expensify",
   "group_id": "target_group_id",
   "config": {
     "schema": "expensify_schema_name",
     "partner_user_id": "your_expensify_partner_user_id",
     "partner_user_secret": "your_expensify_partner_user_secret"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`partner_user_id`	Your Expensify Partner User ID.
`partner_user_secret`	Your Expensify Partner User Secret.

Authorization

There are two ways to authorize this connector type:

By specifying the following field in the request partner_user_id and partner_user_secret
By using the or the Fivetran dashboard.

Facebook Ad Account Sunset

Request

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.	`AllAccounts`, `SpecificAccounts`
`accounts`	Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.

Authorization

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

Facebook Ad Insights Sunset

Request

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`accounts`	List of accounts of which connector will sync the data.
`fields`	List of fields which connector will sync. .
`breakdowns`	List of breakdowns which connector will sync. .
`action_breakdowns`	List of action_breakdowns which connector will sync. .
`sync_mode`	Option to select connector should sync all accounts or specific accounts. .
`aggregation`	Options to select aggregation duration. .
`config_type`	Option to select Prebuilt Reports or Custom Reports. .
`prebuilt_report`	The name of report of which connector will sync the data. .
`action_report_time`	The report time of action stats. .
`click_attribution_window`	Time period to attribute conversions based on clicks. .
`view_attribution_window`	Time period to attribute conversions based on views. .
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

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

Facebook Ads

Request

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

{
    "service": "facebook_ads",
    "group_id": "target_group_id",
    "config": {
        "schema": "facebook_ads",
        "sync_mode": "SpecificAccounts",
        "accounts": ["act_123"],
        "custom_tables": [
            {
                "table_name": "table_1",
                "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"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Option to select connector should sync all accounts or specific accounts. .
`accounts`	List of accounts of which connector will sync the data.
`custom_tables`	List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data.
`table_name`	The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with .
`fields`	List of fields which connector will sync. .
`breakdowns`	List of breakdowns which connector will sync. .
`action_breakdowns`	List of action_breakdowns which connector will sync. .
`aggregation`	Options to select aggregation duration. .
`config_type`	Option to select Prebuilt Reports or Custom Reports. .
`prebuilt_report_name`	The report name to which connector will sync the data. .
`action_report_time`	The report time of action stats. .
`click_attribution_window`	Time period to attribute conversions based on clicks. .
`view_attribution_window`	Time period to attribute conversions based on views. .
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`
`sync_metadata`	Parameter defining whether to enable or disable metadata synchronisation. Default value: `TRUE`.	`TRUE`, `FALSE`

Authorization

There are two ways to authorize this connector type:

By specifying the values for client_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"
   }
 }
content_copy

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

By using the or through the Fivetran dashboard.

Facebook Pages

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all accounts or specific accounts. Default value: `AllPages`.	`AllPages`, `SpecificPages`
`pages`	Specific pages to sync. Must be populated if `sync_mode` is set to `SpecificPages`.

Authorization

There are two ways to authorize this connector type:

By specifying the values for 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"
     }
 }
content_copy

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

By using the or through the Fivetran dashboard.

Financial Force Beta

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`base_url`	(Optional) The custom Salesforce domain. Make sure that the `base_url` starts with `https://`.

Authorization

There are two ways to authorize this connector type:

By specifying the values for 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"
    }
}
content_copy

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.

By using the or the Fivetran dashboard.

Firebase Beta

Before creating a Firebase connection, you must first follow .

Request

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

{
   "service": "firebase",
   "group_id": "target_group_id",
   "config": {
       "schema": "test_firebase",
       "service_account_key": "your_service_account_key",
       "packing_mode": "UseUnpackedModeOnly",
       "packed_mode_tables": "[]"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`service_account_key`	The contents of your service account key file. Required for authentication.
`packing_mode`	Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.
`packed_mode_tables`	Specific tables to sync. Must be populated if `packing_mode` is set to `SelectTablesForPackedMode`.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the service_account_key field in the request.
By using the or the Fivetran dashboard.

Fivetran Platform Connector

Request

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

{
    "service": "fivetran_log",
    "group_id": "target_group_id",
    "config": {
        "schema": "fivetran_log_schema",
        "group_name" : "group_name",
        "is_account_level_connector": true
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`group_name`	(Optional) The group name of the `target_group_id`.
`is_account_level_connector`	(Optional) Retrieve account-level logs.	`true`, `false`

Authorization

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

Flexport Lite Private Preview

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

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

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

{
   "service": "flexport",
   "group_id": "target_group_id",
   "config": {
      "schema": "flexport"
   },
   "auth": {
       "client_access": {
           "client_id": "your_flexport_client_id",
           "client_secret": "your_flexport_client_secret"
       },
        "access_token": "my_access_token"
   }
}
content_copy

Auth parameters

Name	Description
`client_access.client_id`	Your Flexport Client ID.
`client_access.client_secret`	Your Flexport Client Secret.

By using the or the Fivetran dashboard.

Fountain Lite

Request

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

{
  "service": "fountain",
  "group_id": "target_group_id",
  "config": {
    "schema": "fountain_schema_name",
    "sub_domain": "your_fountain_subdomain",
    "api_token": "your_fountain_api_token"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Fountain subdomain.
`api_token`	Your Fountain API token.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_token field in the request.
By using the or the Fivetran dashboard.

FreshBooks Lite

Request

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

{
   "service": "freshbooks",
   "group_id": "target_group_id",
   "config": {
      "schema": "freshbooks_schema_name"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following parameters in the auth section: client_access, refresh_token, and access_token.

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

{
   "service": "freshbooks",
   "group_id": "target_group_id",
   "config": {
      "schema": "freshbooks_schema_name"
   },
   "auth": {
       "client_access": {
           "client_id": "freshbooks_client_id",
           "client_secret": "freshbooks_client_secret"
       },
       "refresh_token": "freshbooks_refresh_token",
       "access_token": "freshbooks_access_token"
   }
}

content_copy

Auth parameters

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

By using the or the Fivetran dashboard.

Freshchat Lite

Request

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

{
    "service": "freshchat",
    "group_id": "target_group_id",
    "config": {
        "schema": "freshchat",
        "sub_domain": "sub_domain",
        "bearer_token": "your_api_token"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Freshchat subdomain.
`bearer_token`	Your Freshchat API token.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: sub_domain and api_token.
By using the or the Fivetran dashboard.

Freshdesk

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`subdomain`	Your company's freshdesk subdomain (usually company.freshdesk.com).
`api_key`	Your Freshdesk API Key.

Authorization

There are two ways to authorize this connector type:

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

Freshservice

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`subdomain`	Your company's freshservice subdomain (usually company.freshservice.com).
`api_key`	Your Freshservice API Key.

Authorization

There are two ways to authorize this connector type:

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

Friendbuy Lite

Request

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

{
   "service": "friendbuy",
   "group_id": "target_group_id",
   "config": {
      "schema": "friendbuy_schema_name",
      "api_key": "your_friendbuy_api_key",
      "api_secret": "your_friendbuy_api_secret"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Friendbuy API key.
`api_secret`	Your Friendbuy API secret.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: api_key and api_secret.
By using the or the Fivetran dashboard.

Freshteam Lite

Request

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

{
    "service": "freshteam",
    "group_id": "target_group_id",
    "config": {
        "schema": "freshteam",
        "base_domain": "your_base_domain",
        "api_key": "your_api_key"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`domain_name`	Your company's Freshteam base domain name (usually company.freshteam.com).
`api_key`	Your Freshteam API key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: domain_name and api_key.
By using the or the Fivetran dashboard.

Front

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for 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"
     }
 }
content_copy

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.

By using the or the Fivetran dashboard.

FTP

Request

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

{
    "service": "ftp",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_ftp",
        "table": "table_name",
        "host": "ftp.company.com",
        "port": "21",
        "user": "user_name",
        "password": "password",
        "is_secure": "false",
        "prefix": "folder_path",
        "pattern": "file_pattern",
        "file_type": "infer",
        "json_delivery_mode": "packed",
        "compression": "infer",
        "on_error": "skip",
        "append_file_option": "upsert_file",
        "archive_pattern": "regex_pattern",
        "null_sequence": "",
        "delimiter": "",
        "escape_char": "",
        "skip_before": "0",
        "skip_after": "0",
        "line_separator": ""
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`host`	FTP host address.
`port`	FTP port.
`user`	FTP user.
`password`	FTP password.
`is_secure`	Whether the server supports FTPS.	`true`, `false`
`prefix`	All files and folders under this folder path will be searched for files to sync.
`pattern`	All files in your search path matching this regular expression will be synced.
`file_type`	If your files are saved with improper extensions, you can force them to by synced as the selected file type.	`infer`, `csv`, `json`, `tsv`, `avro`
`json_delivery_mode`	Specifies how Fivetran should handle your JSON data. Default value: `packed`.	`packed`, `unpacked`
`compression`	The secrets that should be passed to the function at runtime.	`infer`, `uncompressed`, `tar`, `tar_bz2`, `tar_gz`
`on_error`	If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.	`fail`, `skip`
`append_file_option`	If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.	`upsert_file`, `append_file`
`archive_pattern`	Files inside of compressed archives with filenames matching this regular expression will be synced.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`delimiter`	You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`skip_before`	We will skip over the number of lines specified before syncing data.
`skip_after`	We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: user, password, host and port.
By using the or the Fivetran dashboard.

FullStory Lite

Request

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

{
    "service": "fullstory",
    "group_id": "target_group_id",
    "config": {
        "schema": "fullstory",
        "api_key": "your_api_key"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your FullStory API key.

Authorization

There are two ways to authorize this connector type:

By specifying the api_key field in the request.
By using the or the Fivetran dashboard.

Gainsight Customer Success

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	The subdomain of your Gainsight account.
`access_key`	The access key for API authentication.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: sub_domain and access_key.
By using the or through the Fivetran dashboard.

Gem Lite Private Preview

Request

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

{
  "service": "gem",
  "group_id": "target_group_id",
  "config": {
     "schema": "gem_schema_name",
     "api_key": "your_gem_api_key"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Gem API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
After creating the connector, by using the or the Fivetran dashboard.

GitHub

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all repositories or specific repositories.	`AllRepositories`, `SpecificRepositories`
`repositories`	Specific Repository IDs to sync. Must be populated if `syncMode` is set to `SpecificRepositories`.
`use_webhooks`	Whether to use webhook payloads from GitHub to perform incremental updates.	`true`, `false`

Authorization

There are two ways to authorize this connector type:

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

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

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

Auth parameters

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

By using the or through the Fivetran dashboard.

Gladly Lite

Request

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

{
   "service": "gladly",
   "group_id": "target_group_id",
   "config": {
      "schema": "gladly_schema_name",
      "username": "your_gladly_username",
      "api_token": "your_gladly_api_token",
      "organization": "your_gladly_organization_name"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Gladly Username.
`api_token`	Your Gladly API Token.
`organization`	Your Gladly Organization Name.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username and api_token.
By using the or the Fivetran dashboard.

GoCardless Lite

Request

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

{
   "service": "gocardless",
   "group_id": "target_group_id",
   "config": {
      "schema": "gocardless_schema_name",
      "sandbox_account": "your_gocardless_account_type",
      "access_token": "your_gocardless_access_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sandbox_account`	Your GoCardless account type.
`access_token`	Your GoCardless access token.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: sandbox_account and access_token.
By using the or the Fivetran dashboard.

Gong Lite

Request

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

{
   "service": "gongio",
   "group_id": "target_group_id",
   "config": {
      "schema": "gong_schema_name",
      "username": "your_gong_api_username",
      "password": "your_gong_api_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Gong API key.
`password`	Your Gong API key secret.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username and password.
By using the or the Fivetran dashboard.

Google Ad Manager

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`dimensions`	Report dimensions to include in the sync. The `date` dimension is mandatory for all the report types.	See
`dimension_attributes`	Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions.	See
`columns`	Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.	See
`custom_field_ids`	Custom field IDs to include in the sync. Custom fields can only be selected with their corresponding Dimensions.	See
`ad_unit_view`	The ad unit view for the report. Defaults to TOP_LEVEL.	See
`network_code`	Network code is a unique, numeric identifier for your Ad Manager network.	See

Authorization

There are two ways to authorize this connector type:

By specifying the 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"],
        "custom_field_ids": [432432, 545345],
        "ad_unit_view": "TOP_LEVEL",
        "network_code": "0"
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

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.

By using the or the Fivetran dashboard.

Google Ads

Request

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

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

Config parameters

Name	Description	Supported Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`customer_id`	ID of the customer, can be retrieved from your Google Ads dashboard.
`sync_mode`	Whether to sync all accounts or specific accounts.	`AllAccounts`, `SpecificAccounts`, `ManagerAccounts`
`timeframe_months`	The number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`
`accounts`	The list of Account IDs to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
`manager_accounts`	The list of the Manager Account IDs whose clients will be synced. Must be populated if `sync_mode` is set to `ManagerAccounts`.
`reports`	The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
`table`	The table name within the schema to which connector will sync the data of the specific report.
`report_type`	The name of the Google Ads report from which the connector will sync the data. You can use all that support segmenting by date as report types.
`fields`	A list of the fields to sync.
`conversion_window_size`	The time frame of the to capture conversions.	From `1` to `90` days, or `0` for automatic detection.

NOTE: The segments.date field is required for . Make sure the segments.date field is present for every table.

Authorization

There are two ways to authorize this connector type:

By specifying the values for 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"
    }
}
content_copy

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.

By using the or the Fivetran dashboard.

Google Analytics

Request

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

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

Legacy Request

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

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

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

Config parameters

Name	Description	Supported Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all accounts or specific accounts.	`AllAccounts`, `SpecificAccounts`
`accounts`	The list of specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
`profiles`	Specific User Profile IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
`reports`	The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
`table`	The table name within the schema to which connector will sync the data of the specific report.
`config_type`	Whether to use the .	`Prebuilt`, `Custom`
`prebuilt_report`	The name of the Prebuilt Report from which the connector will sync the data.	See .
`dimensions`	The report dimensions to include into a sync. The `date` dimension is mandatory for all the report types.	See
`metrics`	The report metrics to include into a sync.	See
`segments`	A segment is a subset of your Analytics data that is made up of one or more non-destructive filters (filters that do not alter the underlying data). Those filters isolate subsets of users, sessions, and hits.	See
`filter`	String parameter restricts the data returned for your report. To use the filters parameter, specify a dimension or metric on which to filter, followed by the filter expression	See
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. The default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR` and `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

By specifying the 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"
    }
}
content_copy

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.

By using the or the Fivetran dashboard.

Google Analytics 4

Request

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

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

Config parameters

Name	Description	Supported Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`timeframe_months`	The number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. The default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR` and `ALL_TIME`
`sync_mode`	Whether to sync all accounts or specific accounts.	`ALL_ACCOUNTS`, `SPECIFIC_ACCOUNTS`
`accounts`	The list of specific Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
`properties`	The list of specific Google Analytics 4 property IDs. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
`reports`	The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
`table`	The table name within the schema to which connector will sync the data of the specific report.
`config_type`	Whether to use the Prebuilt Reports or Custom Reports.	`PREBUILT`, `CUSTOM`
`prebuilt_report`	The name of the Prebuilt Report from which the connector will sync the data.	See .
`dimensions`	The report dimensions to include into a sync.	See
`metrics`	The report metrics to include into a sync.	See
`filter_field_name`	The dimension name to filter on.
`filter_field_value`	The dimension value to filter on. It is case-insensitive.

Authorization

There are two ways to authorize this connector type:

By specifying the 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"
    }
}
content_copy

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.

By using the or the Fivetran dashboard.

Google Analytics 4 Export Beta

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`project_id`	The Project ID.
`dataset_id`	The Dataset ID.
`bucket_name`	The name of the bucket.
`list_sync_mode`	The sync mode.	`COLUMNS`, `JSON`

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: project_id, dataset_id, and bucket_name.
By using the or the Fivetran dashboard.

Initial Configuration

To provide Fivetran access perform the following steps:

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

Google Analytics 360

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`project_id`	The project ID.
`dataset_id`	The dataset ID.
`bucket_name`	The name of the bucket.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: project_id, dataset_id and bucket_name.
By using the or the Fivetran dashboard.

Initial Configuration

To provide Fivetran access perform the following steps:

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

Google Analytics (MCF) Beta

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all accounts or specific accounts. Default value: `ALL_ACCOUNTS`	`ALL_ACCOUNTS`, `SPECIFIC_ACCOUNTS`
`accounts`	Specific Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
`profiles`	Specific User Profile IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR` and `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

By specifying the 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"
    }
}
content_copy

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.

By using the or the Fivetran dashboard.

Google Calendar Lite

Request

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

{
   "service": "google_calendar",
   "group_id": "target_group_id",
   "config": {
      "schema": "google_calendar_schema_name"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following parameters in the auth section: client_access, refresh_token, and access_token.

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

{
   "service": "google_calendar",
   "group_id": "target_group_id",
   "config": {
      "schema": "google_calendar_schema_name"
   },
   "auth": {
       "client_access": {
           "client_id": "google_calendar_client_id",
           "client_secret": "google_calendar_client_secret"
       },
       "refresh_token": "google_calendar_refresh_token",
       "access_token": "google_calendar_access_token"
   }
}

content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Google Calendar client application.
`client_secret`	`Client ID` of your Google Calendar client application.
`refresh_token`	The long-lived `Refresh token` of your Google Calendar client application.
`access_token`	The `Access Token` that carries the information necessary for API resources to fetch data.

By using the or the Fivetran dashboard.

Google Campaign Manager 360

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`sync_mode`	Whether to sync all user profiles or specific ones. Default value: `ALL_PROFILES`.	`ALL_PROFILES`, `SPECIFIC_PROFILES`
`user_profiles`	IDs of specific User Profiles to sync. Must be populated if `sync_mode` is set to `SPECIFIC_PROFILES`.
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR` and `ALL_TIME`
`report_type`	Type of reporting data to sync. Default value: `STANDARD`.	`FLOODLIGHT`, `REACH` and `STANDARD`
`dimensions`	Report dimensions to include into a sync. The `date` dimension is mandatory for all the report types. The `advertiser` dimension is mandatory for `REACH` report type	See
`metrics`	Report metrics to include into a sync.	See
`report_configuration_ids`	You can select only one Floodlight Configuration ID per account.
`enable_all_dimension_combinations`	Whether to enable all reach dimension combinations in the report. Default value: `false`
`conversion_dimensions`	Conversion Dimensions.	See
`per_interaction_dimensions`	Per Interaction Dimensions.	See
`custom_floodlight_variables`	Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_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"
    }
}
content_copy

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.

By using the or the Fivetran dashboard.

Google Cloud Functions

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`function_trigger`	The trigger URL of the cloud function.
`secrets`	The secrets that should be passed to the function at runtime.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: function_trigger and secrets.
By using the or the Fivetran dashboard.

Google Cloud Storage

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`bucket`	The name of the GCS bucket.
`prefix`	All files and folders under this folder path will be searched for files to sync.
`pattern`	All files in your search path matching this regular expression will be synced.
`file_type`	If your files are saved with improper extensions, you can force them to by synced as the selected file type.	`infer`, `csv`, `json`, `tsv`, `avro`
`json_delivery_mode`	Specifies how Fivetran should handle your JSON data. Default value: `packed`.	`packed`, `unpacked`
`compression`	The secrets that should be passed to the function at runtime.	`infer`, `uncompressed`, `tar`, `tar_bz2`, `tar_gz`
`on_error`	If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.	`fail`, `skip`
`append_file_option`	If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.	`upsert_file`, `append_file`
`archive_pattern`	Files inside of compressed archives with filenames matching this regular expression will be synced.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`delimiter`	You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`skip_before`	We will skip over the number of lines specified before syncing data.
`skip_after`	We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
`auth_type`	Authorization type. Required for storage bucket authentication.	`FIVETRAN_SERVICE_ACCOUNT`, `CUSTOM_SERVICE_ACCOUNT`
`secret_key`	Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket.
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the bucket, auth_type and secret_key fields in the request.
By using the or the Fivetran dashboard.

Google Display & Video 360

Request

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`config_method`	The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is `CREATE_NEW`.	`CREATE_NEW`, `REUSE_EXISTING`
`partners`	The list of partners to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.
`advertisers`	The list of advertisers to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.
`report_type`	The type of the report to create. This is a required parameter when `config_method` is set to `CREATE_NEW`.	See
`dimensions`	The report dimensions (filters) to include into a sync. The dimension names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.	See
`metrics`	The report metrics to include into a sync. The metric names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.	See
`query_id`	The ID of the query whose configuration you want to reuse. This is a required parameter when `config_method` is set to `REUSE_EXISTING`.
`update_config_on_each_sync`	Specifies whether the configuration is updated before each sync or only when the connector settings are saved. This parameter only takes effect when `config_method` is set to `REUSE_EXISTING`. The default value is `true`.	`true`, `false`

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_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"
    }
}
content_copy

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.

By using the or the Fivetran dashboard.

Google Drive

The connector supports two sync strategies:

Magic Folder Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`folder_id`	Your Google Drive Folder URL.

Merge Mode Request

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

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

{
   "service": "google_drive",
   "group_id": "target_group_id",
   "config": {
      "schema": "test_google_drive",
      "table": "test_table",
      "prefix": "folder_path",
      "pattern": "file_pattern",
      "file_type": "infer",
      "json_delivery_mode": "packed",
      "compression": "infer",
      "on_error": "fail",
      "append_file_option": "upsert_file",
      "archive_pattern": "regex_pattern",
      "null_sequence": "",
      "delimiter": "|",
      "escape_char": "escape_char",
      "skip_before": "0",
      "skip_after": "0",
      "is_single_table_mode": "true",
      "line_separator": ";"
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema` (required)	The connector schema name has to be unique within the group (destination).
`table` (required)	The table name within the schema to which the connector will sync the data.
`prefix` (required)	All files and folders under this folder path will be searched for files to sync, this can be the entire drive link or a folder URL
`pattern`	All files in your search path matching this regular expression will be synced.
`file_type`	If your files are saved with improper extensions, you can force them to be synced as the selected filetype.	`infer`, `csv`, `json`, `tsv`, `avro`, `parquet`
`json_delivery_mode`	Specifies how Fivetran should handle your JSON data. Default value: `packed`.	`packed`, `unpacked`
`compression`	The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.	`infer`, `uncompressed`, `tar`, `tar_bz2`, `tar_gz`
`on_error`	If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.	`fail`, `skip`
`append_file_option`	If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.	`upsert_file`, `append_file`
`archive_pattern`	Files inside of compressed archives with filenames matching this regular expression will be synced.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`delimiter`	You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`skip_before`	We will skip over the number of lines specified before syncing data.
`skip_after`	We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
`is_single_table_mode` (required as `true`)	Allows the creation of connector using Merge Mode strategy.	`true`, `false`
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.

Authorization

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

Google Play

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`bucket`	The Google Cloud Storage source bucket.

Authorization

There are two ways to authorize this connector type:

By specifying the 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"
   }
}
content_copy

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.

By using the or the Fivetran dashboard.

Google Search Ads 360 Beta

Request

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

{
    "service": "google_search_ads_360",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_search_ads_360",
        "advertisers_sync_mode": "SPECIFIC_ADVERTISERS",
        "advertisers": ["111111"],
        "accounts_sync_mode": "SPECIFIC_ACCOUNTS",
        "accounts": ["222222", "333333"],
        "reports": [
            {
                "table": "account_report",
                "report_type": "ACCOUNT",
                "attributes": [
                    "STATUS",
                    "CREATION_TIMESTAMP",
                    "LAST_MODIFIED_TIMESTAMP"
                ],
                "metrics": [
                    "CLICKS",
                    "COST",
                    "IMPR"
                ]
            }
        ],
        "timeframe_months": "SIX"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`advertisers_sync_mode`	Whether to sync all advertisers or specific advertisers.	`ALL_ADVERTISERS`, `SPECIFIC_ADVERTISERS`
`advertisers`	Specific advertisers to sync. Must be populated if `advertisers_sync_mode` is set to `SPECIFIC_ADVERTISERS`.
`accounts_sync_mode`	Whether to sync all accounts or specific accounts.	`ALL_ACCOUNTS`, `SPECIFIC_ACCOUNTS`
`accounts`	Specific accounts to sync. Must be populated if `accounts_sync_mode` is set to `SPECIFIC_ACCOUNTS`.
`reports`	The list of reports. Each report corresponds to a table within the schema to which connector syncs the data.
`table`	The name of a table within the schema to which connector syncs the data of a given report.
`report_type`	The type of report	See the for details.
`attributes`	The report dimensions included to sync.	See the list of attributes for each report type in the .
`metrics`	The report dimensions included to sync.	See the list of metrics for each report type in the .
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR` and `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

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

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

{
    "service": "google_search_ads_360",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_search_ads_360",
        "advertisers_sync_mode": "SPECIFIC_ADVERTISERS",
        "advertisers": ["111111"],
        "accounts_sync_mode": "SPECIFIC_ACCOUNTS",
        "accounts": ["222222", "333333"],
        "reports": [
            {
                "table": "account_report",
                "report_type": "ACCOUNT",
                "attributes": [
                    "STATUS",
                    "CREATION_TIMESTAMP",
                    "LAST_MODIFIED_TIMESTAMP"
                ],
                "metrics": [
                    "CLICKS",
                    "COST",
                    "IMPR"
                ]
            }
        ],
        "timeframe_months": "SIX"
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

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

By using the or the Fivetran dashboard.

Google Search Console

Request

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

{
    "service": "google_search_console",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_google_search_console",
        "sync_mode": "SpecificSites",
        "site_urls": ["https://fivetran.com", "https://support.fivetran.com"],
        "reports": [
            {
                "table": "search_report",
                "report_type": "SEARCH_RESULTS",
                "search_types": [
                    "WEB",
                    "IMAGE",
                    "VIDEO",
                    "NEWS"
                ],
                "dimensions": [
                    "DATE",
                    "COUNTRY",
                    "DEVICE"
                ],
                "aggregation": "BY_PAGE"
            }
        ],
        "timeframe_months": "SIX"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all sites or specific sites.	`AllSites`, `SpecificSites`
`site_urls`	Specific Site URLs to sync. Must be populated if `sync_mode` is set to `SpecificSites`.
`reports`	The list of reports. Each report corresponds to a table within the schema to which connector syncs the data.
`table`	The name of a table within the schema to which connector syncs the data of a given report.
`report_type`	The type of report	`SEARCH_RESULTS`, `DISCOVER`, `GOOGLE_NEWS`
`search_types`	Search types included to sync. Supported only for the `SEARCH_RESULTS` report type	`WEB`, `IMAGE`, `VIDEO`, `NEWS`
`dimensions`	The report dimensions included to sync.	`DATE`, `COUNTRY`, `DEVICE`, `QUERY`, `PAGE`
`aggregation`	(Optional) Aggregation type. Supported only for the `SEARCH_RESULTS` report type	`BY_PAGE`, `BY_PROPERTY`
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR` and `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

By specifying the values for 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"
    }
}
content_copy

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.

By using the or the Fivetran dashboard.

Google Sheets

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group. Required for connector creation.
`table`	The table name within the schema for which the connector will sync the data. Required for connector creation.

Authorization

There are three ways to authorize this connector type:

By specifying the values for the client_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"
    }
}
content_copy

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.

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

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 . You must share the sheet with Fivetran's service account named g-[group_id]@fivetran-production.iam.gserviceaccount.com, where [group_id] is the connector's group ID.

By using the or the Fivetran dashboard.

Gorgias Lite

Request

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

{
  "service": "gorgias",
  "group_id": "target_group_id",
  "config": {
     "schema": "gorgias_schema_name",
     "username": "your_gorgias_username",
     "subdomain": "your_gorgias_subdomain",
     "api_key": "your_gorgias_api_key"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Gorgias username.
`subdomain`	Your Gorgias subdomain.
`api_key`	Your Gorgias API key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: subdomain, username, and api_key.
By using the or the Fivetran dashboard.

Greenhouse

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Greenhouse API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Grepsr Lite Private Preview

Request

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

{
   "service": "grepsr",
   "group_id": "target_group_id",
   "config": {
      "schema": "grepsr_schema_name",
      "api_key": "your_grepsr_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Grepsr API Key.

Authorization

There are two ways to authorize this connector type:

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

GRIN Lite Private Preview

Request

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

{
   "service": "grin",
   "group_id": "target_group_id",
   "config": {
      "schema": "grin_schema_name",
      "api_key": "your_grin_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your GRIN API key.

Authorization

There are two ways to authorize this connector type:

When creating the connector, by specifying the following field in the request: api_key.
By using the or the Fivetran dashboard.

Guru Lite

Request

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

{
   "service": "guru",
   "group_id": "target_group_id",
   "config": {
      "schema": "guru_schema_name",
      "username": "your_guru_username",
      "password": "your_guru_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Guru username.
`password`	Your Guru password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: user_name and password.
By using the or the Fivetran dashboard.

Harvest {{ typeBadge "harvest" }} {{ availabilityBadge "harvest"}}

Request

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

{
   "service": "harvest",
   "group_id": "target_group_id",
   "config": {
      "schema": "harvest_schema_name",
      "account_id": "your_harvest_account_id",
      "personal_access_token": "your_harvest_personal_access_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`account_id`	Your Harvest Account ID.
`personal_access_token`	Your Harvest Personal Access Token.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: account_id and personal_access_token.
By using the or the Fivetran dashboard.

Heap

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`bucket`	The S3 bucket name.
`role_arn`	The Role ARN required for authentication.

Authorization

There are two ways to authorize this connector type:

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

Height

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Height API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Help Scout

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for 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"
     }
 }
content_copy

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.

By using the or the Fivetran dashboard.

Helpshift Lite Private Preview

Request

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

{
   "service": "helpshift",
   "group_id": "target_group_id",
   "config": {
      "schema": "helpshift_schema_name",
      "api_key": "your_helpshift_api_key",
      "domain_name": "your_helpshift_domain_name"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Helpshift API key.
`domain_name`	Your Helpshift domain name.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: api_key and domain_name.
By using the or the Fivetran dashboard.

Heroku Kafka

Request

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

{
    "service": "heroku_kafka",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_heroku_kafka",
        "consumer_group": "consumer_group",
        "servers": "serveraddress1:8080, serveraddress2:8080",
        "message_type": "Json",
        "sync_type": "Packed",
        "security_protocol": "TLS",
        "trusted_cert": "trusted_certificate_value",
        "client_cert": "client_certificate_value",
        "client_cert_key": "client_certificate_key",
        "trust_store_type": "PKCS12",
        "key_store_type": "PKCS12"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`consumer_group`	Heroku Kafka consumer group name.
`servers`	Comma-separated list of Heroku Kafka servers in the format `server:port`.
`message_type`	Heroku Kafka message type.	`Json`, `Text`
`sync_type`	Heroku Kafka sync type. Unpacked messages must be valid JSON.	`Unpacked`, `Packed`
`security_protocol`	Security protocol for Heroku Kafka interaction.	`PLAINTEXT`, `SSL`, `TLS`
`trusted_cert`	Heroku Kafka trusted certificate. Required for `TLS` security protocol.
`client_cert`	Heroku Kafka client certificate. Required for `TLS` security protocol.
`client_cert_key`	Heroku Kafka client certificate key. Required for `TLS` security protocol.
`trust_store_type`	Heroku Kafka trust store type. Default value: `PKCS12`. Required for `TLS` security protocol.
`key_store_type`	Heroku Kafka key store type. Default value: `PKCS12`. Required for `TLS` security protocol.

Authorization

There are two ways to authorize this connector type:

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

HiBob Lite

Request

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

{
  "service": "hibob",
  "group_id": "target_group_id",
  "config": {
     "schema": "hibob_schema_name",
     "api_token": "your_hibob_api_token"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_token`	Your HiBob API token.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_token in the request.
By using the or the Fivetran dashboard.

High-Volume Agent Db2 for i Beta

Request

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

{
    "service": "db2i_hva",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_db2i",
        "host": "host.com",
        "port": 8471,
        "database": "db2i",
        "user": "test_user",
        "password": "test_password",
        "log_journal_schema": "test_log_journal_schema",
        "log_journal": "test_log_journal",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "connection_type": "SshTunnel",
        "always_encrypted": true,
        "agent_host": "host.com",
        "agent_port": 4343,
        "agent_user": "hvr",
        "agent_password": "agent_password",
        "agent_public_cert": "CERTIFICATE"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The username.
`password`	The user's password.
`database`	The database name.
`log_journal_schema`	The log journal schema.
`log_journal`	The log journal name.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
`agent_host`	The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
`agent_port`	The port number of the agent.
`agent_user`	The agent's user.
`agent_password`	The agent user's password. It must have a minimum length of 10 characters.
`agent_public_cert`	The agent public certificate.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the config section of the request: host, port, user, password, agent_host, agent_port, agent_public_cert, agent_user, and agent_password.
By using the or the Fivetran dashboard.

High-Volume Agent Oracle

Request

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

{
    "service": "oracle_hva",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_oracle",
        "host": "host.com",
        "port": 1521,
        "database": "oracledb",
        "pdb_name": "pdb_name",
        "user": "test_user",
        "password": "test_password",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "connection_type": "SshTunnel",
        "update_method": "TELEPORT",
        "always_encrypted": true,
        "agent_host": "host.com",
        "agent_port": 4343,
        "agent_user": "hvr",
        "agent_password": "agent_password",
        "agent_public_cert": "CERTIFICATE",
        "tns": "localhost:1521/TNS",
        "use_oracle_rac": false,
        "asm_option": false,
        "agent_ora_home": "/opt/oracle/product/19c/dbhome_1",
        "asm_user": "asm_user",
        "asm_password": "asm_password",
        "asm_oracle_home": "/asm/oracle/home",
        "asm_tns": "localhost:1521/ASM_TNS"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The username.
`password`	The user's password.
`database`	The database name.
`pdb_name`	(Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`update_method`	The method used to detect new or changed rows. Supported values: > - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. This is the default value. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
`agent_host`	The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
`agent_port`	The port number of the agent.
`agent_user`	The agent's user.
`agent_password`	The agent user's password. It must have a minimum length of 10 characters.
`agent_public_cert`	The agent public certificate.
`agent_ora_home`	The home directory of the Oracle database.
`tns`	Single-tenant database: The database SID. Multi-tenant database: The database TNS.
`use_oracle_rac`	Default value: `false`. Set to `true` if you're using a RAC instance.
`asm_option`	Default value: `false`. Set to `true` if you are using ASM on a non-RAC instance.
`asm_user`	The ASM user. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
`asm_password`	Th ASM user's password. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
`asm_oracle_home`	The Oracle ASM home directory.
`asm_tns`	ASM TNS.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the config section of the request: host, port, user, password, agent_host, agent_port, agent_public_cert, agent_user, and agent_password.
By using the or the Fivetran dashboard.

High-Volume Agent SAP ECC on Db2 for i Private Preview

Request

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

{
    "service": "db2i_sap_hva",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_db2i_sap",
        "host": "host.com",
        "port": 8471,
        "database": "db2i",
        "user": "test_user",
        "password": "test_password",
        "log_journal_schema": "test_log_journal_schema",
        "log_journal": "test_log_journal",
        "sap_schema": "test_sap_schema",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "connection_type": "SshTunnel",
        "always_encrypted": true,
        "agent_host": "host.com",
        "agent_port": 4343,
        "agent_user": "hvr",
        "agent_password": "agent_password",
        "agent_public_cert": "CERTIFICATE"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The username.
`password`	The user's password.
`database`	The database name.
`log_journal_schema`	The log journal schema.
`log_journal`	The log journal name.
`sap_schema`	SAP schema name.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
`agent_host`	The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
`agent_port`	The port number of the agent.
`agent_user`	The agent's user.
`agent_password`	The agent user's password. It must have a minimum length of 10 characters.
`agent_public_cert`	The agent public certificate.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the config section of the request: host, port, user, password, agent_host, agent_port, agent_public_cert, agent_user, and agent_password.
By using the or the Fivetran dashboard.

High-Volume Agent SAP ECC on Hana Private Preview

Request

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

{
    "service": "hana_sap_hva_ecc",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_sap_ecc_hana",
        "host": "host.com",
        "port": 1521,
        "user": "test_user",
        "password": "test_password",
        "database": "hanadb",
        "sap_source_schema": "sap_schema",
        "instance_number": "02",
        "hana_mode": "MultiContainersTenant",
        "uses_netweaver": false,
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "connection_type": "SshTunnel",
        "always_encrypted": true,
        "agent_host": "host.com",
        "agent_port": 4343,
        "agent_user": "hvr",
        "agent_password": "agent_password",
        "agent_public_cert": "CERTIFICATE"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The username.
`password`	The user's password.
`database`	The Hana database name.
`sap_source_schema`	The Hana schema name where the SAP tables reside.
`instance_number`	Two-digit number (00-97) of the SAP instance within its host.
`hana_mode`	The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
`uses_netweaver`	Default value: `false`. Set to `true` if you are using Netweaver to connect.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`agent_host`	The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
`agent_port`	The port number of the agent.
`agent_user`	The agent's user.
`agent_password`	The agent user's password. It must have a minimum length of 10 characters.
`agent_public_cert`	The agent public certificate.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the config section of the request: host, port, user, password, sap_source_schema, agent_host, agent_port, agent_public_cert, agent_user, and agent_password.
By using the or the Fivetran dashboard.

High-Volume Agent SAP ECC on Hana With NetWeaver Private Preview

Request

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

{
    "service": "hana_sap_hva_ecc_netweaver",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_sap_ecc_hana_nw",
        "host": "host.com",
        "port": 1521,
        "user": "test_user",
        "password": "test_password",
        "database": "hanadb",
        "sap_source_schema": "sap_schema",
        "instance_number": "02",
        "hana_mode": "MultiContainersTenant",
        "client_id": "800",
        "rfc_library_path": "/opt/nwlibs",
        "uses_netweaver": true,
        "uses_snc": true,
        "snc_name": "SAP_SNC_Name",
        "snc_partner_name": "SAP_SNC_Partner_Name",
        "snc_library_path": "SAP_SNC_Library_Path",
        "system_id":  "System_Id",
        "service_name" : "Service_Name",
        "log_on_group": "Log_On_Group",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "connection_type": "SshTunnel",
        "always_encrypted": true,
        "agent_host": "host.com",
        "agent_port": 4343,
        "agent_user": "hvr",
        "agent_password": "agent_password",
        "agent_public_cert": "CERTIFICATE",
        "archive_log_path": "Archive_Log_Path",
        "archive_log_format":"Archive_Log_Format",
        "backint_executable_path": "Backint_Executable_Path",
        "backint_configuration_path": "Backint_Configuration_Path"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The username.
`password`	The user's password.
`database`	The Hana database name.
`sap_source_schema`	The Hana schema name where the SAP tables reside.
`instance_number`	Two-digit number (00-97) of the SAP instance within its host.
`hana_mode`	The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
`client_id`	Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
`rfc_library_path`	Directory path containing the SAP NetWeaver RFC SDK library files.
`uses_netweaver`	Default value: `false`. Set to `true` if you are using Netweaver to connect.
`uses_snc`	Default value: `false`. Set to `true` if you are using secure network communications.
`snc_name`	Client SNC name.
`snc_partner_name`	Communication partner's SNC name.
`snc_library_path`	Path to the external security product’s library.
`system_id`	Unique identifier `<sapsid>` of the SAP system. This field is displayed only when the `REMOTE SERVICE IDENTIFICATION` is set to `System ID`.
`service_name`	Unique identifier `<sapsid>` of the SAP system. This field is displayed only when the `REMOTE SERVICE IDENTIFICATION` is set to `Service`.
`log_on_group`	Name of the SAP logon group. The default value is `PUBLIC`.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`agent_host`	The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
`agent_port`	The port number of the agent.
`agent_user`	The agent's user.
`agent_password`	The agent user's password. It must have a minimum length of 10 characters.
`agent_public_cert`	The agent public certificate.
`archive_log_path`	The log backups directory in addition to the default log backup location for the source database.
`archive_log_format`	The filename format (template) of the transaction log archive files stored in the directory specified by the Archive_Log_Path property.
`backint_executable_path`	Backint executable path.
`backint_configuration_path`	Backint configuration path.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the config section of the request: host, port, user, password, sap_source_schema, agent_host, agent_port, agent_public_cert, agent_user, and agent_password.
By using the or the Fivetran dashboard.

High-Volume Agent SAP ECC on Oracle Beta

Request

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

{
    "service": "oracle_sap_hva",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_sap_ecc_oracle",
        "host": "host.com",
        "port": 1521,
        "user": "test_user",
        "password": "test_password",
        "database": "oracledb",
        "pdb_name": "pdb_name",
        "sap_user": "sap_test_user",
        "uses_netweaver": false,
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "connection_type": "SshTunnel",
        "update_method": "TELEPORT",
        "always_encrypted": true,
        "agent_host": "host.com",
        "agent_port": 4343,
        "agent_user": "hvr",
        "agent_password": "agent_password",
        "agent_public_cert": "CERTIFICATE",
        "tns": "localhost:1521/TNS",
        "use_oracle_rac": false,
        "asm_option": false,
        "agent_ora_home": "/opt/oracle/product/19c/dbhome_1",
        "asm_user": "asm_user",
        "asm_password": "asm_password",
        "asm_oracle_home": "/asm/oracle/home",
        "asm_tns": "localhost:1521/ASM_TNS"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The username.
`password`	The user's password.
`database`	The database name.
`pdb_name`	(Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
`sap_user`	The Oracle schema name where the SAP tables reside.
`uses_netweaver`	Default value: `false`. Set to `true` if you are using Netweaver to connect.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`update_method`	The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
`agent_host`	The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
`agent_port`	The port number of the agent.
`agent_user`	The agent's user.
`agent_password`	The agent user's password. It must have a minimum length of 10 characters.
`agent_public_cert`	The agent public certificate.
`agent_ora_home`	The home directory of the Oracle database.
`tns`	Single-tenant database: The database SID. Multi-tenant database: The database TNS.
`use_oracle_rac`	Default value: `false`. Set to `true` if you're using a RAC instance.
`asm_option`	Default value: `false`. Set to `true` if you are using ASM on a non-RAC instance.
`asm_user`	The ASM user. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
`asm_password`	The ASM user's password. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
`asm_oracle_home`	The Oracle ASM home directory.
`asm_tns`	ASM TNS.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the config section of the request: host, port, user, password, sap_user, agent_host, agent_port, agent_public_cert, agent_user, and agent_password.
By using the or the Fivetran dashboard.

High-Volume Agent SAP ECC on Oracle With NetWeaver Beta

Request

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

{
    "service": "oracle_sap_hva_netweaver",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_sap_ecc_oracle",
        "host": "host.com",
        "port": 1521,
        "user": "test_user",
        "password": "test_password",
        "database": "oracledb",
        "pdb_name": "pdb_name",
        "sap_user": "sap_test_user",
        "client_id": "800",
        "instance_number": "00",
        "rfc_library_path": "/opt/nwlibs",
        "uses_netweaver": true,
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "connection_type": "SshTunnel",
        "always_encrypted": true,
        "agent_host": "host.com",
        "agent_port": 4343,
        "agent_user": "hvr",
        "agent_password": "agent_password",
        "agent_public_cert": "CERTIFICATE",
        "tns": "localhost:1521/TNS",
        "use_oracle_rac": false,
        "asm_option": false,
        "agent_ora_home": "/opt/oracle/product/19c/dbhome_1",
        "asm_user": "asm_user",
        "asm_password": "asm_password",
        "asm_oracle_home": "/asm/oracle/home",
        "asm_tns": "localhost:1521/ASM_TNS"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The username.
`password`	The user's password.
`database`	The database name.
`pdb_name`	(Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
`sap_user`	The Oracle schema name where the SAP tables reside.
`client_id`	Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
`instance_number`	Two-digit number (00-97) of the SAP instance within its host.
`rfc_library_path`	Directory path containing the SAP NetWeaver RFC SDK library files.
`uses_netweaver`	Default value: `false`. Set to `true` if you are using Netweaver to connect.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`agent_host`	The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
`agent_port`	The port number of the agent.
`agent_user`	The agent's user.
`agent_password`	The agent user's password. It must have a minimum length of 10 characters.
`agent_public_cert`	The agent public certificate.
`agent_ora_home`	The home directory of the Oracle database.
`tns`	Single-tenant database: The database SID. Multi-tenant database: The database TNS.
`use_oracle_rac`	Default value: `false`. Set to `true` if you're using a RAC instance.
`asm_option`	Default value: `false`. Set to `true` if you are using ASM on a non-RAC instance.
`asm_user`	The ASM user. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
`asm_password`	The ASM user's password. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
`asm_oracle_home`	The Oracle ASM home directory.
`asm_tns`	ASM TNS.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the config section of the request: host, port, user, password, sap_user, agent_host, agent_port, agent_public_cert, agent_user, and agent_password.
By using the or the Fivetran dashboard.

High-Volume Agent SAP S/4Hana Private Preview

Request

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

{
    "service": "hana_sap_hva_s4",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_sap_hana_s4",
        "host": "host.com",
        "port": 1521,
        "user": "test_user",
        "password": "test_password",
        "database": "hanadb",
        "sap_source_schema": "sap_schema",
        "instance_number": "02",
        "hana_mode": "MultiContainersTenant",
        "uses_netweaver": false,
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "connection_type": "SshTunnel",
        "always_encrypted": true,
        "agent_host": "host.com",
        "agent_port": 4343,
        "agent_user": "hvr",
        "agent_password": "agent_password",
        "agent_public_cert": "CERTIFICATE",
        "hana_backup_password": "HANA_Root_Keys_Backup_Password"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The username.
`password`	The user's password.
`database`	The Hana database name.
`sap_source_schema`	The Hana schema name where the SAP tables reside.
`instance_number`	Two-digit number (00-97) of the SAP instance within its host.
`hana_mode`	The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
`uses_netweaver`	Default value: `false`. Set to `true` if you are using Netweaver to connect.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`agent_host`	The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
`agent_port`	The port number of the agent.
`agent_user`	The agent's user.
`agent_password`	The agent user's password. It must have a minimum length of 10 characters.
`agent_public_cert`	The agent public certificate.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the config section of the request: host, port, user, password, sap_source_schema, agent_host, agent_port, agent_public_cert, agent_user, and agent_password.
By using the or the Fivetran dashboard.

High-Volume Agent SAP S/4Hana With NetWeaver Private Preview

Request

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

{
    "service": "hana_sap_hva_s4_netweaver",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_sap_hana_s4_nw",
        "host": "host.com",
        "port": 1521,
        "user": "test_user",
        "password": "test_password",
        "database": "hanadb",
        "sap_source_schema": "sap_schema",
        "instance_number": "02",
        "hana_mode": "MultiContainersTenant",
        "client_id": "800",
        "rfc_library_path": "/opt/nwlibs",
        "uses_netweaver": true,
        "uses_snc": true,
        "snc_name": "SAP_SNC_Name",
        "snc_partner_name": "SAP_SNC_Partner_Name",
        "snc_library_path": "SAP_SNC_Library_Path",
        "system_id":  "System_Id",
        "service_name" : "Service_Name",
        "log_on_group": "Log_On_Group",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "connection_type": "SshTunnel",
        "always_encrypted": true,
        "agent_host": "host.com",
        "agent_port": 4343,
        "agent_user": "hvr",
        "agent_password": "agent_password",
        "agent_public_cert": "CERTIFICATE",
        "archive_log_path": "Archive_Log_Path",
        "archive_log_format":"Archive_Log_Format",
        "backint_executable_path": "Backint_Executable_Path",
        "backint_configuration_path": "Backint_Configuration_Path"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The username.
`password`	The user's password.
`database`	The Hana database name.
`sap_source_schema`	The Hana schema name where the SAP tables reside.
`instance_number`	Two-digit number (00-97) of the SAP instance within its host.
`hana_mode`	The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
`client_id`	Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
`rfc_library_path`	Directory path containing the SAP NetWeaver RFC SDK library files.
`uses_netweaver`	Default value: `false`. Set to `true` if you are using Netweaver to connect.
`uses_snc`	Default value: `false`. Set to `true` if you are using secure network communications.
`snc_name`	Client SNC name.
`snc_partner_name`	Communication partner's SNC name.
`snc_library_path`	Path to the external security product’s library.
`system_id`	Unique identifier `<sapsid>` of the SAP system. This field is displayed only when the `REMOTE SERVICE IDENTIFICATION` is set to `System ID`.
`service_name`	Unique identifier `<sapsid>` of the SAP system. This field is displayed only when the `REMOTE SERVICE IDENTIFICATION` is set to `Service`.
`log_on_group`	Name of the SAP logon group. The default value is `PUBLIC`.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`agent_host`	The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
`agent_port`	The port number of the agent.
`agent_user`	The agent's user.
`agent_password`	The agent user's password. It must have a minimum length of 10 characters.
`agent_public_cert`	The agent public certificate.
`archive_log_path`	The log backups directory in addition to the default log backup location for the source database.
`archive_log_format`	The filename format (template) of the transaction log archive files stored in the directory specified by the Archive_Log_Path property.
`backint_executable_path`	Backint executable path.
`backint_configuration_path`	Backint configuration path.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the config section of the request: host, port, user, password, sap_source_schema, agent_host, agent_port, agent_public_cert, agent_user, and agent_password.
By using the or the Fivetran dashboard.

Hopin Lite Private Preview

Request

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

{
   "service": "hopin",
   "group_id": "target_group_id",
   "config": {
      "schema": "hopin_schema_name",
      "bearer_token": "your_hopin_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`bearer_token`	Your Hopin API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the bearer_token field in the request.
By using the or the Fivetran dashboard.

HubSpot

Request

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

{
    "service": "hubspot",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_hubspot"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for 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"
     }
 }
content_copy

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.

By using the or through the Fivetran dashboard.

Impact Lite

Request

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

{
   "service": "impact",
   "group_id": "target_group_id",
   "config": {
      "schema": "impact_schema_name",
      "account_sid": "your_impact_account_sid",
      "account_token": "your_impact_account_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`account_sid`	Your Impact Account SID.
`account_token`	Your Impact Account Token.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: account_sid and account_token.
By using the or the Fivetran dashboard.

incident.io Lite Private Preview

Request

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

{
   "service": "incidentio",
   "group_id": "target_group_id",
   "config": {
      "schema": "incidentio_schema_name",
      "api_key": "your_incidentio_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your incident.io API key.

Authorization

There are two ways to authorize this connector type:

When creating the connector, by specifying a value for the following field in the request: api_key.
After creating the connector, by using the or the Fivetran dashboard.

Infobip Lite Private Preview

Request

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

{
   "service": "infobip",
   "group_id": "target_group_id",
   "config": {
      "schema": "infobip_schema_name",
      "api_key": "your_infobip_api_key",
      "sub_domain": "your_infobip_subdomain"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Infobip API key.
`sub_domain`	Your Infobip subdomain.

Authorization

There are two ways to authorize this connector type:

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

Insightly Lite Private Preview

Request

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

{
    "service": "insightly",
    "group_id": "target_group_id",
    "config": {
        "schema": "insightly_schema_name",
        "sub_domain": "your_insightly_subdomain",
        "api_key": "your_insightly_api_key"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Insightly subdomain name.
`api_key`	Your Insightly API key.

Authorization

There are two ways to authorize this connector type:

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

Integral Ad Science {{ typeBadge "integral_ad_science" }} {{ availabilityBadge "integral_ad_science" }}

Request

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

{
   "service": "integral_ad_science",
   "group_id": "target_group_id",
   "config": {
      "schema": "integral_ad_science_schema_name",
      "username": "your_integral_ad_science_username",
      "password": "your_integral_ad_science_password",
      "client_id": "your_integral_ad_science_client_id",
      "client_secret": "your_integral_ad_science_client_secret"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your integral_ad_science username.
`password`	Your integral_ad_science password.
`client_id`	Your integral_ad_science client id.
`client_secret`	Your integral_ad_science client secret.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: username,password,client_id,client_secret.
By using the or the Fivetran dashboard.

Instagram Business

Request

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

{
    "service": "instagram_business",
    "group_id": "target_group_id",
    "config": {
        "schema": "instagram_business_test",
        "sync_mode": "SpecificAccounts",
        "accounts": ["123","456"],
        "timeframe_months": "THREE"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.	`AllAccounts`, `SpecificAccounts`
`accounts`	Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
`timeframe_months`	Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`

Authorization

There are two ways to authorize this connector type:

By specifying the values for client_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"
     }
 }
content_copy

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

By using the or through the Fivetran dashboard.

Intercom

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying a value for access_token in the auth section.
POST https://api.fivetran.com/v1/connectors
```
{
  "service": "intercom",
  "group_id": "target_group_id",
  "config": {
     "schema": "test_intercom"
  },
  "auth": {
     "access_token": "my_access_token"
  }
}
content_copy
```
Auth parameters
Name Description
access_token The long-lived Access Token carries the information necessary for API resources to fetch data.
By using the or through the Fivetran dashboard.

Ironclad Lite

Request

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

{
   "service": "ironclad",
   "group_id": "target_group_id",
   "config": {
      "schema": "ironclad_schema_name",
      "base_url": "your_ironclad_base_url",
      "access_token": "your_ironclad_access_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`base_url`	Your Ironclad base url.
`access_token`	Your Ironclad access token.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: base_url and access_token.
By using the or the Fivetran dashboard.

ironSource Lite Private Preview

Request

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

{
   "service": "ironsource",
   "group_id": "target_group_id",
   "config": {
      "schema": "ironsource_schema_name",
      "secret_key": "your_ironsource_secret_key",
      "refresh_token": "your_ironsource_refresh_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`secret_key`	Your ironSource secret key.
`refresh_token`	Your ironSource refresh token.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: secret_key and refresh_token.
By using the or the Fivetran dashboard.

Iterable

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

Request

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

{
    "service": "iterable",
    "group_id": "target_group_id",
    "config": {
        "schema": "iterable",
        "api_key": "xxxxxxxxxxxxxxxx",
        "sync_mode": "SelectedEvents",
        "events": ["emailSend", "emailClick"],
        "custom_event_sync_mode": "SelectedEvents",
        "custom_events": ["customEvent"]
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Iterable API key.
`sync_mode`	Sync all events or specific events. Default value: `AllEvents`.	`AllEvents`, `SelectedEvents`
`custom_event_sync_mode`	Sync all custom events, specific custom events, or no custom events. Default value: `AllEvents`.	`AllEvents`, `NoEvents`, `SelectedEvents`
`events`	Sync specific events. Must be populated if `sync_mode` is set to `SelectedEvents`.	`customEvent`, `emailSend`, `emailSendSkip`, `emailOpen`, `emailClick`, `emailUnSubscribe`, `emailSubscribe`, `emailBounce`, `emailComplaint`, `hostedUnsubscribeClick`, `inAppSend`, `inAppOpen`, `inAppClick`, `inAppClose`, `inAppDelete`, `inAppDelivery`, `inAppSendSkip`, `inboxMessageImpression`, `inboxSession`, `pushSend`, `pushSendSkip`, `pushBounce`, `pushOpen`, `pushUninstall`, `purchase`, `smsClick`, `smsSend`, `smsSendSkip`, `smsBounce`, `smsReceived`, `webPushSend`, `webPushClick`, `webPushSendSkip`
`custom_events`	Specific custom events to sync. Must be populated if `custom_event_sync_mode` is set to `SelectedEvents`.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Jira

Request

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

{
    "service": "jira",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_jira",
        "host": "mycompany.atlassian.net",
        "port": 443,
        "user": "user",
        "password": "password",
        "path": "path",
        "on_premise": false
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`host`	The Jira service host address.
`port`	The Jira service host port.
`user`	The Jira username.
`password`	The Jira user's password.
`path`	A URL subdirectory where the Jira instance is working.
`on_premise`	Whether the Jira instance is local or in cloud.	`true`, `false`

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user and password.
By using the or the Fivetran dashboard.

Jira Align Lite

Request

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

{
   "service": "atlassian_jira_align",
   "group_id": "target_group_id",
   "config": {
      "schema": "jira_align_schema_name",
      "api_key": "your_jira_align_api_key",
      "sub_domain": "your_jira_align_base_url"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Jira Align API key.
`sub_domain`	Your Jira Align base URL.

Authorization

There are two ways to authorize this connector type:

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

Kandji Lite Private Preview

Request

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

{
   "service": "kandji",
   "group_id": "target_group_id",
   "config": {
      "schema": "kandji_schema_name",
      "api_token": "your_kandji_api_token",
      "sub_domain": "your_kandji_subdomain"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_token`	Your Kandji API token.
`sub_domain`	Your Kandji subdomain.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: api_token and sub_domain.
By using the or the Fivetran dashboard.

Khoros CareLite

Request

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

{
   "service": "khoros_care",
   "group_id": "target_group_id",
   "config": {
      "schema": "khoros_care_schema_name",
      "sub_domain": "your_khoros_care_subdomain",
      "username": "your_khoros_care_username",
      "password": "your_khoros_care_password",
      "company_key": "your_khoros_care_company_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Khoros Care subdomain.
`username`	Your Khoros Care username.
`password`	Your Khoros Care password.
`company_key`	Your Khoros Care company key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: sub_domain, username, password, and company_key.
By using the or the Fivetran dashboard.

Kissmetrics Lite

Request

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

{
   "service": "kissmetrics",
   "group_id": "target_group_id",
   "config": {
      "schema": "kissmetrics_schema_name",
      "username": "your_kissmetrics_api_username",
      "password": "your_kissmetrics_api_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Kissmetrics API Username.
`password`	Your Kissmetrics API Password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username and password.
By using the or the Fivetran dashboard.

Klaviyo

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Klaviyo API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Konnect Insights Lite Private Preview

Request

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

{
    "service": "konnect_insights",
    "group_id": "target_group_id",
    "config": {
        "schema": "konnect_insights",
        "account_token": "your_konnect_insights_account_token",
        "user_token": "your_konnect_insights_user_token"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`account_token`	Your Konnect Insights account token.
`user_token`	Your Konnect Insights user token.

Authorization

There are two ways to authorize this connector type:

By specifying the account_token and user_token fields in the request.
By using the or the Fivetran dashboard.

Kustomer

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`access_token`	Your Kustomer API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the access_token field in the request.
By using the or the Fivetran dashboard.

Lattice Lite

Request

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

{
   "service": "lattice",
   "group_id": "target_group_id",
   "config": {
      "schema": "lattice_schema_name",
      "access_token": "your_lattice_access_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`access_token`	Your Lattice API access token.

Authorization

There are two ways to authorize this connector type:

By specifying the access_token field in the request.
By using the or the Fivetran dashboard.

Learnupon Lite In Dev

Request

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

{
   "service": "learnupon",
   "group_id": "target_group_id",
   "config": {
      "schema": "learnupon_schema_name",
      "username": "your_learnupon_username",
      "api_key": "your_learnupon_api_key",
      "base_url": "your_learnupon_base_url"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Learnupon username.
`api_key`	Your Learnupon API Key.
`base_url`	Your Learnupon Base Url.

Authorization

There are two ways to authorize this connector type:

By specifying the username,api_key and base_url fieldd in the request.
By using the or the Fivetran dashboard.

Lessonly Lite

Request

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

{
   "service": "lessonly",
   "group_id": "target_group_id",
   "config": {
      "schema": "lessonly_schema_name",
      "username": "your_lessonly_username",
      "password": "your_lessonly_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Lessonly username.
`password`	Your Lessonly password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username and password.
By using the or the Fivetran dashboard.

Lever

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Lever API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Liftoff Lite Private Preview

Request

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

{
   "service": "liftoff",
   "group_id": "target_group_id",
   "config": {
      "schema": "liftoff_schema_name",
      "api_key": "your_liftoff_api_key",
      "api_secret": "enter_your_api_secret"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Liftoff API Key.
`api_secret`	Enter your API Secret.

Authorization

There are two ways to authorize this connector type:

By specifying the values for api_key and api_secret in the request .
By using the or the Fivetran dashboard.

Lightspeed Retail

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

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

LinkedIn Ad Analytics

Request

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

{
    "service": "linkedin_ads",
    "group_id": "target_group_id",
    "config": {
        "schema": "linkedin_ads",
        "sync_mode": "SpecificAccounts",
        "accounts": ["123","234","345"],
        "ad_analytics": "SpecificReports",
        "reports": ["abc","bcd","cde"],
        "view_through_attribution_window_size": "DAY_1",
        "post_click_attribution_window_size" : "DAY_30", 
        "timeframe_months": "THREE"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all accounts or specific accounts. Default value: `AllAccounts`	`SpecificAccounts`, `AllAccounts`
`accounts`	Specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
`ad_analytics`	Whether to sync all reports or specific reports. Default value: `AllReports`	`SpecificReports`, `AllReports`
`reports`	Specific Reports to sync. Must be populated if `ad_analytics` is set to `SpecificReports`.
`view_through_attribution_window_size`	The time period to attribute conversions based on views. Default value: `DAY_7`	`DAY_1`, `DAY_7`, `DAY_28`, `DAY_30`
`post_click_attribution_window_size`	The time period to attribute conversions based on clicks. Default value: `DAY_30`	`DAY_1`, `DAY_7`, `DAY_28`, `DAY_30`
`timeframe_months`	Number of months for which to query reporting data included in the initial sync. This number cannot be modified once the connector is created. Default value: `ALL_TIME`	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

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

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

{
    "service": "linkedin_ads",
    "group_id": "target_group_id",
    "config": {
        "schema": "linkedin_ads",
        "sync_mode": "SpecificAccounts",
        "accounts": ["123","234","345"],
        "ad_analytics": "SpecificReports",
        "reports": ["abc","bcd","cde"],
        "view_through_attribution_window_size": "DAY_1",
        "post_click_attribution_window_size" : "DAY_30",
        "timeframe_months": "THREE"
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your LinkedIn client application.
`client_secret`	`Client Secret` of your LinkedIn 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.

By using the or through the Fivetran dashboard.

LinkedIn Company Pages

Request

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

{
    "service": "linkedin_company_pages",
    "group_id": "target_group_id",
    "config": {
        "schema": "linkedin_company_pages", 
        "social_data_sync_timeframe": "SIX"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`social_data_sync_timeframe`	The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: `SIX` .	`THREE`, `SIX`, `TWELVE`

Authorization

There are two ways to authorize this connector type:

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

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

{
    "service": "linkedin_company_pages",
    "group_id": "target_group_id",
    "config": {
        "schema": "linkedin_company_pages", 
        "social_data_sync_timeframe": "SIX"
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your LinkedIn client application.
`client_secret`	`Client Secret` of your LinkedIn 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.

By using the or through the Fivetran dashboard.

LiveChat Lite

Request

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

{
   "service": "livechat",
   "group_id": "target_group_id",
   "config": {
      "schema": "livechat_schema_name",
      "api_token": "your_livechat_api_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_token`	Your LiveChat API token.

Authorization

There are two ways to authorize this connector type:

By specifying the api_token field in the request.
By using the or the Fivetran dashboard.

Loop Lite Private Preview

Request

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

{
   "service": "loop",
   "group_id": "target_group_id",
   "config": {
      "schema": "loop_schema_name",
      "api_key": "your_loop_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Loop API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Loopio {{ typeBadge "loopio" }} {{ availabilityBadge "loopio"}}

Request

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

{
   "service": "loopio",
   "group_id": "target_group_id",
   "config": {
      "schema": "loopio_schema_name",
      "client_id": "your_loopio_client_id",
      "client_secret": "your_loopio_client_secret"
 
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	Your Loopio Client ID.
`client_secret`	Your Loopio Client Secret.

Authorization

There are two ways to authorize this connector type:

By specifying values for the client_id and client_secret.
By using the or the Fivetran dashboard.

Mailchimp

Request

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

{
    "service": "mailchimp",
    "group_id": "target_group_id",
    "config": {
        "schema": "schema_name"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

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

Mailgun Lite

Request

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

{
  "service": "mailgun",
  "group_id": "target_group_id",
  "config": {
     "schema": "mailgun_schema_name",
     "username": "your_mailgun_api_username",
     "base_url": "https://your_mailgun_base_url",
     "api_key": "your_mailgun_api_key"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Mailgun API username.
`base_url`	Your Mailgun base URL.
`api_key`	Your Mailgun API key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username, base_url, and api_key.
By using the or the Fivetran dashboard.

Mandrill

Request

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

{
    "service": "mandrill",
    "group_id": "target_group_id",
    "config": {
        "schema": "mandrill",
        "api_key": "xxxxxxxxxxxxxxxx",
        "use_api_keys": "false",
        "api_keys": "key_1, key_2, key_3"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Mandrill API key.
`use_api_keys`	Whether to use multiple API keys for interaction.
`api_keys`	Comma-separated list of API keys. Required if `use_api_keys` is set to `true`.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: api_key or use_api_keys and api_keys.
By using the or the Fivetran dashboard.

MariaDB

Fivetran supports a few different incarnations of MariaDB. To configure MariaDB connectors, use the instructions, with the appropriate service name:

- "service": "maria_azure"
- "service": "maria"
- "service": "maria_rds"

Marin Software

Request

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

{
    "service": "marin",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_marin",
        "host": "marin_host_address",
        "user": "marin_user",
        "password": "marin_password",
        "prefix": ""
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`host`	The Marin host address.
`user`	The Marin username.
`password`	The Marin user's password.
`prefix`	Folder path to the Marin manifest file.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, user and password.
By using the or the Fivetran dashboard.

Marketo

Request

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

{
    "service": "marketo",
    "group_id": "target_group_id",
    "config": {
        "schema": "marketo",
        "endpoint": "https://my.mktorest.com/rest",
        "identity": "https://my.mktorest.com/identity",
        "user_id": "MKTOWS_58-LBZ-000_Y",
        "encryption_key": "your_encryption_key",
        "soap_uri": "https://58-LBZ-000.mktoapi.com/soap/mktows/3_1",
        "client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "client_secret": "your_api_secret",
        "api_quota": 10000
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`endpoint`	Marketo REST API endpoint.
`identity`	Marketo REST API identity URL.
`user_id`	Marketo SOAP API User ID.
`encryption_key`	Marketo SOAP API Encryption Key.
`soap_uri`	Marketo SOAP API Endpoint.
`client_id`	Marketo REST API Client ID.
`client_secret`	Marketo REST API Client Secret.
`api_quota`	Allowed number of API requests to Marketo instance per day, the default value is 10000.

Check out our to configure Marketo permissions and obtain the relevant account information, including ID and secret.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: endpoint, identity, client_id, client_secret and api_quota.
By using the or the Fivetran dashboard.

Mavenlink

Request

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

{
    "service": "mavenlink",
    "group_id": "target_group_id",
    "config": {
        "schema": "mavenlink_schema"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

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

Medallia

Request

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

{
    "service": "medallia",
    "group_id": "target_group_id",
    "config": {
        "schema": "medallia_analytics",
        "subdomain": "subdomain",
        "domain_type": "eu",
        "client_name": "companyName"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`subdomain`	The Medallia subdomain.
`domain_type`	The domain type of your Medallia URL (`com`, `eu`, `ca`, etc.). `com` by default.
`client_name`	Your Medallia company name.

Authorization

There are two ways to authorize this connector type:

By specifying values for the following fields in the auth section: client_id, client_secret, and access_token.

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

{
    "service": "medallia",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_medallia",
        "subdomain": "subdomain",
        "domain_type": "eu",
        "client_name": "companyName"
    },
     "auth": {
         "client_id": "my_client_id",
         "client_secret": "my_client_secret",
         "access_token": "my_access_token"
     }
}
content_copy

Auth parameters

Name	Description
`client_id`	Your Medallia client ID.
`client_secret`	Your Medallia client secret key.
`access_token`	Your Medallia access token that contains all the information necessary for the API resources to fetch your data.

By using the or through the Fivetran dashboard.

Microsoft Advertising

Request

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

{
    "service": "bingads",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_bingads",
        "sync_mode": "SpecificAccounts",
        "accounts": ["123","234","345"],
        "timeframe_months": "THREE",
        "rollback_window_size": 30
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.	`SpecificAccounts`, `AllAccounts`
`accounts`	Specific accounts to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`
`rollback_window_size`	The time frame of the to capture conversions. Default value: `35`.	`35`, `40`, `45`, `50`, `55`, `60`, `65`, `70`, `75`, `80`, `85`, `90` or `95` days.

Authorization

There are two ways to authorize this connector type:

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

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

{
    "service": "bingads",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_bingads",
        "sync_mode": "SpecificAccounts",
        "accounts": ["123","234","345"],
        "timeframe_months": "THREE"
    },
     "auth": {
         "client_access": {
             "client_id": "my_client_id",
             "client_secret": "my_client_secret"
         },
         "refresh_token": "my_refresh_token"
     }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Microsoft Advertising client application.
`client_secret`	`Client Secret` of your Microsoft Advertising 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.

By using the or through the Fivetran dashboard.

Microsoft Dynamics 365 CRM

Request

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

{
    "service": "dynamics_365",
    "group_id": "target_group_id",
    "config": {
        "schema": "dynamics_365_schema",
        "domain_name": "domain_name",
        "resource_url": "resource_url"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`domain_name`	The custom domain name associated with Dynamics 365.
`resource_url`	The Dynamics 365 URL.

Authorization

There are two ways to authorize this connector type:

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

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

{
    "service": "dynamics_365",
    "group_id": "target_group_id",
    "config": {
        "schema": "dynamics_365_schema",
        "domain_name": "domain_name",
        "resource_url": "resource_url"
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Dynamic 365 client application.
`client_secret`	`Client Secret` of your Dynamic 365 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.

By using the or the Fivetran dashboard.

Microsoft Dynamics 365 Finance Sunset

Request

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

{
    "service": "dynamics_365_fo",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_sql",
        "host": "sqlinstance.mycompany.com",
        "port": 1433,
        "database": "sqldb",
        "user": "test_user",
        "password": "test_password",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The user name. The format must be `user@domain`.
`password`	The user's password.
`database`	The database name.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, password, user and database.
By using the or the Fivetran dashboard.

Microsoft Dynamics 365 Finance ADLS

Request

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

{
    "service": "microsoft_dynamics_365_fo",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_dynamics_365_fo",
        "container_name": "container_name",
        "connection_string": "BlobEndpoint=https://abc123.blob.core.windows.net/;TableEndpoint=https://abc123.table.core.windows.net/;SharedAccessSignature=xxxxxxxxx",
        "prefix": "folder_name"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`container_name`	The name of the blob container.
`connection_string`	The blob storage container connection string.
`prefix`	Folder name in which the exported dynamics 365 data resides.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: container_name, connection_string, and prefix.
By using the or the Fivetran dashboard.

Microsoft Lists

Request

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

{
    "service": "microsoft_lists",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_list",
        "site_id": "target_site_id",
        "site_name" : "target_site_name"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema has to be unique within the group (destination). Required for connector creation.
`site_id`	The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the `id` field in the response for sites.
`site_name`	The Name of the SharePoint site. The Site Name is the `name` field in the Graph API response for sites.

Authorization

There are two ways to authorize this connector type:

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

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

{
 "service": "microsoft_lists",
 "group_id": "target_group_id",
 "config": {
     "schema": "test_list",
     "site_id": "target_site_id",
     "site_name" : "target_site_name"
 },
 "auth": {
     "client_access": {
         "client_id": "my_client_id",
         "client_secret": "my_client_secret"
     },
     "refresh_token":  "my_refresh_token"
 }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Microsoft client application.
`client_secret`	`Client Secret` of your Microsoft client application.
`refresh_token`	The long-lived Refresh token carries the information necessary to get a new access token for API resources.

By using the or the Fivetran dashboard.

Microsoft Teams Lite Private Preview

Request

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

{
   "service": "microsoft_teams",
   "group_id": "target_group_id",
   "config": {
      "schema": "microsoft_teams_schema_name"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following parameters in the auth section: client_access, refresh_token, and access_token.

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

{
   "service": "microsoft_teams",
   "group_id": "target_group_id",
   "config": {
      "schema": "microsoft_teams_schema_name"
   },
   "auth": {
       "client_access": {
           "client_id": "microsoft_teams_client_id",
           "client_secret": "microsoft_teams_client_secret"
       },
       "refresh_token": "microsoft_teams_refresh_token",
       "access_token": "microsoft_teams_access_token"
   }
}

content_copy

Auth parameters

Name	Description
`client_id`	Your Microsoft Teams client ID.
`client_secret`	Your Microsoft Teams client secret.
`refresh_token`	Your Microsoft Teams refresh token.
`access_token`	Your Microsoft Teams access token.

By using the or the Fivetran dashboard.

Mixpanel

Request

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

{
    "service": "mixpanel",
    "group_id": "target_group_id",
    "config": {
        "schema": "mixpanel",
        "api_secret": "your_api_secret"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_secret`	Mixpanel API Secret.
`region`	Mixpanel Data Region.

To find the API Secret, log in to your Mixpanel account, then click on the Account section and click on Project (see our ). Please ensure your account has access to this information.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_secret field in the request.
By using the or the Fivetran dashboard.

MongoDB

Fivetran supports two different MongoDB configurations. Each configuration has its own service value:

- "service": "mongo"
- "service": "mongo_sharded"

To learn more, see the setup guide for your MongoDB connector type.

Request

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

{
    "service": "mongo",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_mongo",
        "hosts": ["mongoinstance.mycompany.com:27017"],
        "user": "test_user",
        "password": "test_password",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "packing_mode": "UseUnpackedModeOnly",
        "packed_mode_tables": []
    }
}
content_copy

Config parameters

Name	Description	Notes
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`hosts`	A list of host addresses of the primary node and all replicas. Each list item is either: a DB instance host/IP address with a port number, or SRV host record.
`user`	The user name.
`password`	The user's password.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`packing_mode`	Whether to sync all tables in unpacked mode, all tables in packed mode, or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.	`UseUnpackedModeOnly`, `UsePackedModeOnly`, `SelectTablesForPackedMode`.
`packed_mode_tables`	Specific tables to sync. Must be populated if `sync_mode` is set to `SelectTablesForPackedMode`.	Use the following format: `<db>.<table>` (case-sensitive).

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user and password.
By using the or the Fivetran dashboard.

MySQL

Fivetran supports a few different incarnations of MySQL. Each type of connector has its own service value:

- "service": "aurora"
- "service": "mysql_azure"
- "service": "maria_azure"
- "service": "maria"
- "service": "mysql"
- "service": "google_cloud_mysql"
- "service": "magento_mysql"
- "service": "magento_mysql_rds"
- "service": "maria_rds"
- "service": "mysql_rds"

Check out our setup guide for your type of connector.

Request

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

{
    "service": "mysql",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_mysql",
        "host": "mysqlinstance.mycompany.com",
        "port": 3306,
        "database": "mysqldb",
        "user": "test_user",
        "password": "test_password",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "update_method": "BINLOG",
        "replica_id": "4573961"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The user name.
`password`	The user's password.
`database`	The database name.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`update_method`	The method to detect new or changed rows. Supported values: `BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
`connection_type`	Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`replica_id`	Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user and password.
By using the or the Fivetran dashboard.

Mux Lite

Request

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

{
   "service": "mux",
   "group_id": "target_group_id",
   "config": {
      "schema": "mux_schema_name",
      "token_id": "your_mux_token_id",
      "token_secret_key": "your_mux_token_secret_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`token_id`	Your Mux token ID.
`token_secret_key`	Your Mux token secret key.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: token_id and token_secret_key.
By using the or the Fivetran dashboard.

Namely Lite Private Preview

Request

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

{
   "service": "namely",
   "group_id": "target_group_id",
   "config": {
      "schema": "namely_schema_name",
      "sub_domain": "your_namely_subdomain"
   },
   "auth":{
      "client_access":{
         "client_id": "your_namely_client_id",
         "client_secret": "your_namely_client_secret"
      }
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Namely subdomain.
`client_id`	Your Namely Client ID.
`client_secret`	Your Namely Client Secret.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: client_id and client_secret.
By using the or the Fivetran dashboard.

Notion Lite

Request

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

{
  "service": "notion",
  "group_id": "target_group_id",
  "config": {
    "schema": "notion_schema_name"
  },
  "auth":{
    "client_access":{
      "client_id": "your_notion_client_id",
      "client_secret": "your_notion_client_secret"
    }
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	Your Notion Client ID.
`client_secret`	Your Notion Client Secret.

NetSuite SuiteAnalytics

Request

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

Sync using the NetSuite.com data source

{
    "service": "netsuite_suiteanalytics",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_netsuite",
        "host": "netsuite_service_host",
        "port": "netsuite_service_port",
        "datasource": "NetSuite.com",
        "account": "netsuite_account_id",
        "role": "netsuite_role_id",
        "email": "netsuite_email",
        "password": "netsuite_password"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`host`	The NetSuite service host address.
`port`	The NetSuite service host port.
`datasource`	The NetSuite data source value: `NetSuite.com`.
`account`	The NetSuite Account ID.
`role`	The NetSuite Role ID for connection.
`email`	The NetSuite user's email address.
`password`	The NetSuite user's password.

Sync using the NetSuite2.com data source

{
    "service": "netsuite_suiteanalytics",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_netsuite",
        "host": "netsuite_service_host",
        "port": "netsuite_service_port",
        "datasource": "NetSuite2.com",
        "account": "netsuite_account_id",
        "role": "netsuite_role_id",
        "consumer_key": "netsuite_consumer_key",
        "consumer_secret": "netsuite_consumer_secret",
        "token_key": "netsuite_token_key",
        "token_secret": "netsuite_token_secret"	
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`host`	The NetSuite service host address.
`port`	The NetSuite service host port.
`datasource`	The NetSuite2 data source value: `NetSuite2.com`.
`account`	The NetSuite Account ID.
`role`	The NetSuite Role ID for connection.
`consumer_key`	The NetSuite consumer key obtained when creating an Integration Record.
`consumer_secret`	The NetSuite consumer secret obtained when creating an Integration Record.
`token_key`	The NetSuite token ID obtained when creating an Access Token.
`token_secret`	The NetSuite token password obtained when creating an Access Token.

Authorization

There are three ways to authorize this connector type:

If you use the NetSuite.com data source, by specifying the values for the following fields in the request: host, port, datasource, account, email and password.
If you use the NetSuite2.com data source, by specifying the values for the following fields in the request: host, port, datasource, account, role, consumer_key, consumer_secret, token_key and token_secret.
By using the or the Fivetran dashboard.

Nylas Lite Private Preview

Request

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

{
  "service": "nylas",
  "group_id": "target_group_id",
  "config": {
     "schema": "nylas_schema_name",
     "sub_domain": "your_nylas_sub_domain",
     "access_token": "your_nylas_access_token"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Nylas subdomain.
`access_token`	Your Nylas access token.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: sub_domain and access_token.
By using the or the Fivetran dashboard.

Okta Lite

Request

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

{
   "service": "okta",
   "group_id": "target_group_id",
   "config": {
      "schema": "okta_schema_name",
      "api_token": "your_okta_api_token",
      "sub_domain": "yourSubDomain",
      "domain": "yourDomain"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_token`	Your Okta API token.
`sub_domain`	Your Okta subdomain.
`domain`	Your Okta domain.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: api_token, domain and sub_domain.
By using the or the Fivetran dashboard.

OneDrive

Request

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

{
    "service": "one_drive",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_one_drive",
        "folder_path": "target_folder_path"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema has to be unique within the group (destination). Required for connector creation.
`folder_path`	Your Onedrive folder URL. You can find the folder URL by following the steps mentioned in the .

Authorization

There are two ways to authorize this connector type:

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

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

{
 "service": "one_drive",
 "group_id": "target_group_id",
 "config": {
     "schema": "test_one_drive",
     "folder_path": "target_folder_path"
},     
"auth": {
     "client_access": {
         "client_id": "my_client_id",
         "client_secret": "my_client_secret"
     },
     "refresh_token":  "my_refresh_token"
 }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Microsoft OneDrive client application.
`client_secret`	`Client Secret` of your Microsoft OneDrive client application.
`refresh_token`	The long-lived `Refresh token` carries the information necessary to get a new access token for API resources.

By using the or the Fivetran dashboard.

Open Exchange Rates Lite

Request

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

{
  "service": "open_exchange_rates",
  "group_id": "target_group_id",
  "config": {
    "schema": "open_exchange_rates_schema_name",
    "app_id": "your_app_id",
    "base_currency": "your_base_currency"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`app_id`	Your Open Exchange Rates app ID.
`base_currency`	Your Open Exchange Rates base currency.

Authorization

There are two ways to authorize this connector type:

By specifying values for the app_id and base_currency fields in the request.
By using the or the Fivetran dashboard.

Opsgenie Lite

Request

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

{
    "service": "atlassian_ops_genie",
    "group_id": "target_group_id",
    "config": {
        "schema": "atlassian_ops_genie_schema",
        "region": "your_region",
        "api_key": "your_api_key"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`region`	Your company's Opsgenie region (usually company.opsgenie.com).	`api`, `api.eu`
`api_key`	Your Opsgenie API key.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: region and api_key.
By using the or the Fivetran dashboard.

Optimizely

Request

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

{
    "service": "optimizely",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_optimizely",
        "account_id" : "test_account_id"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`account_id`	Your Optimizely account ID.

Authorization

There are two ways to authorize this connector type:

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

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

{
    "service": "optimizely",
        "group_id": "target_group_id",
        "config": {
            "schema": "test_optimizely",
            "account_id" : "test_account_id"
        },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Optimizely client application.
`client_secret`	`Client Secret` of your Optimizely 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.

By using the or the Fivetran dashboard.

Oracle

Fivetran supports a few different incarnations of Oracle. Each type of connector has its own service value:

- "service": "oracle"
- "service": "oracle_rac"
- "service": "oracle_rds"
- "service": "oracle_ebs"

Check out our setup guide for your type of connector.

Request

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

{
    "service": "oracle",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_oracle",
        "host": "oracleinstance.mycompany.com",
        "port": 1521,
        "database": "oracledb",
        "user": "test_user",
        "password": "test_password",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "update_method": "TELEPORT"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The user name.
`password`	The user's password.
`database`	The database name.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`update_method`	The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user, and password.
By using the or the Fivetran dashboard.

Oracle Fusion Cloud Applications

The request and response and their parameters (except service) are identical for the following Oracle Fusion Cloud Applications connectors:

- "service": "oracle_fusion_cloud_apps_crm"
- "service": "oracle_fusion_cloud_apps_fscm"
- "service": "oracle_fusion_cloud_apps_hcm"

Request

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

{
    "service": "oracle_fusion_cloud_apps_crm",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_oracle_fusion_cloud",
        "server_url": "https://<oracle_fusion_cloud_instance>:<port>",
        "username": "test_username",
        "password": "test_password"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`server_url`	The Oracle Fusion Cloud Instance URL.
`username`	The Oracle Fusion Cloud username.
`password`	The Oracle Fusion Cloud user password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username and password.
By using the or the Fivetran dashboard.

Orbit Lite

Request

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

{
   "service": "orbit",
   "group_id": "target_group_id",
   "config": {
      "schema": "orbit_schema_name",
      "bearer_token": "your_orbit_api_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`bearer_token`	Your Orbit API token.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the bearer_token field in the request.
By using the or the Fivetran dashboard.

Ortto Lite Private Preview

Request

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

{
   "service": "ortto",
   "group_id": "target_group_id",
   "config": {
      "schema": "ortto_schema_name",
      "api_key": "your_ortto_api_key",
      "base_url": "api.eu"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Ortto API key.
`base_url`	Your Ortto base URL. Possible values: `api`, `api.au`, `api.eu`.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: api_key and base_url
By using the or the Fivetran dashboard.

Outbrain

Request

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

{
    "service": "outbrain",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_outbrain",
        "user": "outbrain_user",
        "password": "outbrain_password",
        "timeframe_months": "THREE"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`user`	The username or email of the Outbrain user.
`password`	The Outbrain user's password.
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. The default value is `TWELVE`. NOTE: The more months of reporting data you sync, the longer your initial sync will take.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: user and password.
By using the or the Fivetran dashboard.

Outreach

Request

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

{
    "service": "outreach",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_outreach"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

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

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

  {
    "service": "outreach",
        "group_id": "target_group_id",
        "config": {
            "schema": "test_outreach",
            "domain": "domain"
        },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
 }
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Outreach client application.
`client_secret`	`Client Secret` of your Outreach 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.

By using the or the Fivetran dashboard.

PagerDuty Lite Private Preview

Request

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

{
   "service": "pagerduty",
   "group_id": "target_group_id",
   "config": {
      "schema": "pagerduty_schema_name",
      "api_key": "your_pagerduty_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your PagerDuty API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Papershift Lite

Request

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

{
   "service": "papershift",
   "group_id": "target_group_id",
   "config": {
      "schema": "papershift_schema_name",
      "api_key": "your_papershift_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Papershift API key.

Authorization

There are two ways to authorize this connector type:

By specifying the api_key field in the request.
By using the or the Fivetran dashboard.

PandaDoc Lite In Dev

Request

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

{
   "service": "pandadoc",
   "group_id": "target_group_id",
   "config": {
      "schema": "pandadoc_schema_name",
      "api_key": "your_pandadoc_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your PandaDoc API key.

Authorization

There are two ways to authorize this connector type:

By specifying the api_key field in the request.
By using the or the Fivetran dashboard.

Pardot

Request

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

{
    "service": "pardot",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_pardot",
        "email": "pardot_user_email",
        "password": "pardot_password",
        "business_unit_id": "pardot_business_unit_id",
        "salesforce_security_token": "pardot_salesforce_security_token",
        "api_version": "V4", 
        "rest_api_limit": 150000,
        "time_zone": "GMT+05:30"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`email`	The email of the Pardot user.
`password`	The Pardot user's password.
`business_unit_id`	The Pardot user's Business Unit ID.
`salesforce_security_token`	The Pardot user's Salesforce SSO Account Security Token.
`api_version`	The Pardot API Version Fivetran should use. An empty value defaults to `V3`.	`V3`, `V4`
`rest_api_limit`	The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
`time_zone`	The time zone configured in your Pardot instance. An empty value defaults to `UTC+00:00`.	`GMT+01:00`, `GMT+02:00`, `GMT+03:00`, `GMT+03:30`, `GMT+04:00`, `GMT+04:30`, `GMT+05:00`, `GMT+05:30`, `GMT+05:45`, `GMT+06:00`, `GMT+06:30`, `GMT+07:00`, `GMT+08:00`, `GMT+08:45`, `GMT+09:00`, `GMT+09:30`, `GMT+10:00`, `GMT+10:30`, `GMT+11:00`, `GMT+12:00`, `GMT+12:45`, `GMT+13:00`, `GMT+13:45`, `GMT+14:00`, `GMT+00:00`, `GMT-01:00`, `GMT-02:00`, `GMT-02:30`, `GMT-03:00`, `GMT-03:30`, `GMT-04:00`, `GMT-05:00`, `GMT-06:00`, `GMT-07:00`, `GMT-08:00`, `GMT-09:00`, `GMT-09:30`, `GMT-10:00`, `GMT-11:00`, `GMT-12:00`

Authorization

There are two ways to authorize this connector type:

By specifying the values for client_access in the auth section.

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

 {
     "service": "pardot",
     "group_id": "target_group_id",
     "config": {
        "schema": "test_pardot",
        "email": "pardot_user_email",
        "password": "pardot_password",
        "business_unit_id": "pardot_business_unit_id",
        "salesforce_security_token": "pardot_salesforce_security_token",
        "api_version": "V4", 
        "rest_api_limit": 150000,
        "time_zone": "GMT+05:30"
     },
     "auth": {
         "client_access": {
             "client_id": "my_client_id",
             "client_secret": "my_client_secret"
         }
     }
 }
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Pardot client application.
`client_secret`	`Client Secret` of your Pardot client application.

By using the or the Fivetran dashboard.

PayPal

Fivetran supports sandbox mode for PayPal connectors. Provide "paypal_sandbox" as a service to use sandbox mode.

Request

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

{
    "service": "paypal",
    "group_id": "target_group_id",
    "config": {
        "schema": "paypal",
        "client_id": "my_client_id",
        "secret_key": "my_secret_key" 
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	`Client ID` of your PayPal client application.
`secret_key`	`Secret Key` of your PayPal client application.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: client_id and secret_key.
By using the or the Fivetran dashboard.

Pendo

Request

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

{
    "service": "pendo",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_pendo",
        "integration_key": "pendo_integration_key",
        "region": "pendo_region",
        "sync_mode": "SpecificAppIds",
        "app_ids": ["appId1(234)","appId2(456)"]
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`integration_key`	The integration key of the Pendo account.
`region`	The Pendo account region.	`US`, `EU`
`sync_mode`	Whether to sync all App IDs or specific App IDs. Default value: `AllAppIds`.	`AllAppIds`, `SpecificAppIds`
`app_ids`	Specific App IDs to sync. Must be populated if `sync_mode` is set to `SpecificAppIds`.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: integration_key and region.
By using the or the Fivetran dashboard.

Pingdom Lite Private Preview

Request

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

{
   "service": "pingdom",
   "group_id": "target_group_id",
   "config": {
      "schema": "pingdom_schema_name",
      "username": "your_pingdom_username"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Pingdom username.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the following field in the request: username.
By using the or the Fivetran dashboard.

Pinterest Ads

Request

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

{
   "service": "pinterest_ads",
   "group_id": "group_id",
   "config": {
       "schema": "test_pinterest",
       "sync_mode": "SpecificAdvertisers",
       "advertisers": ["advertiser1", "advertiser2"],
       "click_attribution_window": "THIRTY",
       "engagement_attribution_window": "THIRTY",
       "view_attribution_window": "ONE",
       "conversion_report_time": "AD_EVENT",
       "timeframe_months": "THREE"
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all advertisers or specific advertisers.	`AllAdvertisers`, `SpecificAdvertisers`
`advertisers`	Specific Advertisers to sync. Must be populated if `sync_mode` is set to `SpecificAdvertisers`.
`click_attribution_window`	The number of days to use as the conversion attribution window for a 'click' action.	`ONE`, `SEVEN`, `THIRTY`, `SIXTY`
`engagement_attribution_window`	The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action.	`ONE`, `SEVEN`, `THIRTY`, `SIXTY`
`view_attribution_window`	The number of days to use as the conversion attribution window for a 'view' action.	`ONE`, `SEVEN`, `THIRTY`, `SIXTY`
`conversion_report_time`	The date that the user interacted with the ad OR completed a conversion event.	`AD_EVENT`, `CONVERSION_EVENT`
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

By specifying the values of the client_id, client_secret, and refresh_token parameters in the auth section.

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

 {
     "service": "pinterest_ads",
      "group_id": "group_id",
      "config": {
        "schema": "test_pinterest",
        "sync_mode": "SpecificAdvertisers",
        "advertisers": ["advertiser1", "advertiser2"],
        "click_attribution_window": "THIRTY",
        "engagement_attribution_window": "THIRTY",
        "view_attribution_window": "ONE",
        "conversion_report_time": "AD_EVENT",
        "timeframe_months": "THREE",
        "refresh_token_expires_at": 1717858800
},
     "auth": {
         "client_access": {
             "client_id": "my_client_id",
             "client_secret": "my_client_secret"
         },
         "refresh_token": "my_refresh_token"
     }
 }
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Pinterest client application.
`client_secret`	`Client Secret` of your Pinterest 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. Make sure the `Refresh token` supports the following scope: `"ads:read,boards:read,boards:read_secret,pins:read,pins:read_secret,user_accounts:read,catalogs:read"`.
`refresh_token_expires_at`	(Optional) The expiration date of the refresh token as a Unix timestamp in seconds.

By using the or through the Fivetran dashboard.

Pipedrive

Request

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

{
    "service": "pipedrive",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_pipedrive",
        "domain": "domain",
        "api_token": "api_token"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`domain`	Your Pipedrive domain.
`api_token`	(Optional) The Personal API token of your Pipedrive account.

Authorization

There are two ways to authorize this connector type:

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

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

{
    "service": "pipedrive",
        "group_id": "target_group_id",
        "config": {
            "schema": "test_pipedrive",
            "domain": "domain"
        },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Pipedrive client application.
`client_secret`	`Client Secret` of your Pipedrive 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.

By using the or the Fivetran dashboard.

Pipe17 Lite Private Preview

Request

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

{
    "service": "pipe17",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_pipe17",
        "api_key": "your_pipe17_api_key"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	The Pipe17 API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
After creation using the or the Fivetran dashboard.

Pivotal Tracker Lite Private Preview

Request

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

{
    "service": "pivotal_tracker",
    "group_id": "target_group_id",
    "config": {
        "schema": "pivotal_tracker",
        "api_token": "your_api_token"
    }

}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_token`	Pivotal Tracker API token.

Authorization

There are two ways to authorize this connector type:

By specifying the api_token field in the request.
By using the or the Fivetran dashboard.

Playvox Lite Private Preview

Request

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

{
   "service": "playvox",
   "group_id": "target_group_id",
   "config": {
      "schema": "playvox_schema_name",
      "api_key": "your_playvox_api_key",
      "sub_domain": "your_playvox_subdomain",
      "user_id": "your_playvox_user_id"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Playvox API key.
`sub_domain`	Your Playvox subdomain.
`user_id`	Your Playvox user ID.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: api_key, sub_domain, and user_id.
By using the or the Fivetran dashboard.

Postgres

Fivetran supports a few different incarnations of PostgreSQL. Each type of connector has its own service value:

- "service": "aurora_postgres"
- "service": "azure_postgres"
- "service": "postgres"
- "service": "google_cloud_postgresql"
- "service": "heroku_postgres"
- "service": "postgres_rds"

Check out our setup guide for your type of connector.

Request

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

{
    "service": "postgres",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_postgres",
        "host": "postgresinstance.mycompany.com",
        "port": 5432,
        "database": "postgres",
        "user": "test_user",
        "password": "test_password",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "update_method": "WAL",
        "replication_slot": "test_replication_slot"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The user name.
`password`	The user's password.
`database`	The database name.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`update_method`	The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values: `WAL` - this method replicates new, changed and deleted rows by tailing the write-ahead log (WAL) via a logical slot. This is more efficient than the XMIN method, but requires more setup and monitoring. `XMIN` - this method detects new or changed rows via the XMIN system column, but is not capable of detecting deleted rows. `WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
`replication_slot`	Replication slot name. Specify only for `"updated_method": "WAL"` or `"WAL_PGOUTPUT"`.
`publication_name`	Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
`connection_type`	Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user, password and database.
By using the or the Fivetran dashboard.

PostHog Lite

Request

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

{
   "service": "posthog",
   "group_id": "target_group_id",
   "config": {
      "schema": "posthog_schema_name",
      "api_key": "your_posthog_api_key",
      "sub_domain": "your_posthog_data_region"
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your PostHog API key.
`sub_domain`	Your PostHog data region (US or EU).	`app`, `eu`

Authorization

There are two ways to authorize this connector type:

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

Productboard Lite

Request

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

{
   "service": "productboard",
   "group_id": "target_group_id",
   "config": {
      "schema": "productboard_schema_name",
      "bearer_token": "your_productboard_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`bearer_token`	Your Productboard API key.

Authorization

There are two ways to authorize this connector type:

When creating the connector, by specifying a value for the following field in the request: bearer_token.
By using the or the Fivetran dashboard.

Qualaroo Lite

Request

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

{
   "service": "qualaroo",
   "group_id": "target_group_id",
   "config": {
      "schema": "qualaroo_schema_name",
      "api_key": "your_qualaroo_api_key",
      "api_secret": "your_qualaroo_api_secret",
      "survey_ids": ["qualaroo_survey_id_1","qualaroo_survey_id_2"]
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Qualaroo API key.
`api_secret`	Your Qualaroo API secret.
`survey_ids`	Array of Qualaroo survey IDs.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: api_key and api_secret.
By using the or the Fivetran dashboard.

Qualtrics

Request

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

{
    "service": "qualtrics",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_qualtrics",
        "data_center": "data_center",
        "api_token": "api_token",
        "api_requests_per_minute" : 2000
    }
}
content_copy

The following example will allow you to configure the Qualtrics API usage limit of an existing connector.

PATCH https://api.fivetran.com/v1/connectors/{connector_id}

{
   "config": {
      "api_requests_per_minute": 1500
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`data_center`	Data center ID of the Qualtrics account. Can be found in the URL before `qualtrics.com`. (For example, if your URL is `youraccount.ca1.qualtrics.com`, then the data center is `ca1`.)
`api_token`	API token of the Qualtrics account.
`api_requests_per_minute`	Allowed number of API requests to Qualtrics per minute.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: data_center and api_token.
By using the or the Fivetran dashboard.

QuickBooks

Request

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

{
    "service": "quickbooks",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_quickbooks"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

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

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

 {
     "service": "quickbooks",
         "group_id": "target_group_id",
         "config": {
             "schema": "test_quickbooks"
         },
     "auth": {
         "client_access": {
             "client_id": "my_client_id",
             "client_secret": "my_client_secret"
         },
         "refresh_token": "my_refresh_token",
         "realm_id": "my_realm_id"
     }
 }
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your QuickBooks client application.
`client_secret`	`Client Secret` of your QuickBooks 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.
`realm_id`	`Realm ID` of your QuickBooks application.

By using the or the Fivetran dashboard.

Recharge

Request

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

{
    "service": "recharge",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_recharge",
        "api_token": "recharge_token"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_token`	The Recharge API token.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_token field in the request.
By using the or the Fivetran dashboard.

Recurly

Request

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

{
    "service": "recurly",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_recurly",
        "sub_domain": "recurly_subdomain",
        "api_key": "recurly_api_key"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your company's Recurly subdomain.
`api_key`	The Recurly API key.

Authorization

There are two ways to authorize this connector type:

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

Reddit Ads

Request

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

{
   "service": "reddit_ads",
   "group_id": "target_group_id",
   "config": {
      "schema": "test_reddit_ads",
      "custom_reports": [
         {
            "report_name": "test_report_name",
            "level": "CAMPAIGN",
            "segmentation": "COMMUNITY",
            "conversions_report_included": true,
            "custom_events_included": true,
            "report_fields": ["clicks", "cpc", "ctr", "app_install_metrics"],
            "event_names": ["lead", "sign_up", "purchase"]
        }
      ],
      "timeframe_months": "SIX",
      "sync_multiple_accounts": true,
      "accounts": [
         {
            "name": "other_linked_account_name"
         }
      ]
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`custom_reports`	The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data.
`report_name`	The table name within the schema to which connector will sync the data of the specific report.
`level`	Level of custom report.	`ACCOUNT`, `CAMPAIGN`, `AD_GROUP` , `AD`, `POST`, `NONE`
`segmentation`	Level of custom report.	`COUNTRY`, `METRO`, `INTEREST` , `COMMUNITY`, `PLACEMENT`, `NONE`
`conversions_report_included`	The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: `false`	`true`, `false`
`custom_events_included`	The boolean value specifying whether the custom events will be included in event conversions report. Default value: `false`	`true`, `false`
`report_fields`	The list of fields included in custom report
`event_names`	The list of events the conversion data will be synchronised for
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`
`sync_multiple_accounts`	When this parameter is set to `true`, we sync the data of the additional linked accounts. When this parameter is set to `false`, we sync only the data from the main account that was used for authorization	`true`, `false`
`accounts`	Additional linked accounts list.
`name`	Reddit username of the additional linked account.

Authorization

There are two ways to authorize this connector type:

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

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

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

Auth parameters

Name	Description
`client_id`	`Client ID` of your Reddit Ads client application.
`client_secret`	`Client Secret` of your Reddit 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.

By using the or the Fivetran dashboard.

Redshift Private Preview

Request

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

{
   "service": "redshift_db",
   "config": {
      "schema_prefix": "test_redshift_db",
      "host": "host",
      "port": 443,
      "auth": "password",
      "user": "user",
      "database": "database",
      "password": "password",
      "connectionType": "Directly or PrivateLink",
      "update_method": "TELEPORT"
   }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	Redshift host name
`port`	Redshift port number
`auth`	Password-based authentication type.
`user`	Redshift user name
`database`	The database name
`password`	Redshift user's password
`connectionType`	Redshift uses direct and privatelink connections.
`update_method`	The incremental update method the connector will use.

Initial Configuration

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

Authorization

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

Reply.io Lite Private Preview

Request

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

{
   "service": "replyio",
   "group_id": "target_group_id",
   "config": {
      "schema": "replyio_schema_name",
      "api_key": "your_replyio_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Reply.io API key.

Authorization

There are two ways to authorize this connector type:

When creating the connector, by specifying a value for the following field in the request: api_key.
After creating the connector, by using the or the Fivetran dashboard.

RetailNext Lite

Request

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

{
  "service": "retailnext",
  "group_id": "target_group_id",
  "config": {
     "schema": "retailnext_schema_name",
     "access_key": "your_access_key",
     "subscription": "your_subscription",
     "secret_key": "your_secret_key"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`access_key`	Your RetailNext access key.
`subscription`	Your RetailNext subscription.
`secret_key`	Your RetailNext secret key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: access_key, subscription and secret_key.
By using the or the Fivetran dashboard.

Retently Lite

Request

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

{
  "service": "retently",
  "group_id": "target_group_id",
  "config": {
     "schema": "retently_schema_name",
     "api_token": "your_retently_api_token"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_token`	Your Retently API token.

Authorization

There are two ways to authorize this connector type:

When creating the connector, by specifying a value for the following field in the request: api_token.
After creating the connector, by using the or the Fivetran dashboard.

RingCentral

Request

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

{
    "service": "ringcentral",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_ringcentral"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying a value for access_token in the auth section.
POST https://api.fivetran.com/v1/connectors
```
{
    "service": "ringcentral",
    "group_id": "target_group_id",
    "config": {
            "schema": "test_ringcentral"
        },
    "auth": {
        "access_token": "my_access_token"
    }
}
content_copy
```
Auth parameters
Name Description
access_token The long-lived Access token carries the information necessary to access API resources.
TIP: For instructions to generate the access_token, see .
By using the or through the Fivetran dashboard.

Revel Systems Lite Private Preview

Request

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

{
   "service": "revel",
   "group_id": "target_group_id",
   "config": {
      "schema": "revel_systems_schema_name",
      "sub_domain": "your_revel_systems_sub_domain",
      "api_key:api_secret": "your_revel_systems_api_key:api_secret"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Revel Systems subdomain.
`api_key:api_secret`	Your Revel Systems API key and API secret.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: sub_domain and api_key:api_secret.
By using the or the Fivetran dashboard.

RevOps Lite Private Preview

Request

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

{
   "service": "revops",
   "group_id": "target_group_id",
   "config": {
      "schema": "revops_schema_name",
      "api_key": "revops_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your RevOps API key.

Authorization

There are two ways to authorize this connector type:

By specifying the value for the api_key field in the request.
By using the or the Fivetran dashboard.

Rollbar Lite

Request

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

{
   "service": "rollbar",
   "group_id": "target_group_id",
   "config": {
      "schema": "rollbar_schema_name",
      "access_token": "your_rollbar_access_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`access_token`	Your Rollbar access token.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the access_token field in the request.
By using the or the Fivetran dashboard.

Rootly Lite

Request

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

{
   "service": "rootly",
   "group_id": "target_group_id",
   "config": {
      "schema": "rootly_schema_name",
      "api_key": "your_rootly_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Rootly API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Sage HR Lite Private Preview

Request

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

{
   "service": "sage_hr",
   "group_id": "target_group_id",
   "config": {
      "schema": "sage_hr_schema_name",
      "sub_domain": "your_sage_hr_sub_domain",
      "api_key": "your_sage_hr_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Sage HR Software subDomain.
`api_key`	Your Sage HR Software Api Key.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: sub_domain and api_key .
By using the or the Fivetran dashboard.

Sage Intacct

Request

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

{
    "service": "sage_intacct",
    "group_id": "target_group_id",
    "config": {
         "schema": "test_intacct",
         "company_id": "your_intacct_company_id",
         "user_id": "your_intacct_user_id",
         "login_password": "xxxxxxxxxx",
         "sender_id": "your_intacct_sender_id",
         "sender_password": "your_intacct_sender_password"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`company_id`	Your company ID that is used to set up the Sage Intacct instance. It is a part of the Sage Intacct instance's login credentials.
`user_id`	Your Sage Intacct user ID. It is a part of the login credentials.
`login_password`	The login password. It is a part of the login credentials.
`sender_id`	Your Sage Intacct sender ID.
`sender_password`	Your Sage Intacct sender password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: company_id, user_id and login_password.
By using the or the Fivetran dashboard.

Sailthru

Request

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

{
    "service": "sailthru",
    "group_id": "target_group_id",
    "config": {
        "schema": "sailthru",
        "api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "api_secret": "your_api_secret"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	The Sailthru API key.
`api_secret`	The Sailthru API secret.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: api_key and api_secret.
By using the or the Fivetran dashboard.

Salesforce

Request

Use salesforce_sandbox service name for sandbox account or salesforce service name for production account.

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

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

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`base_url`	(Optional) The custom Salesforce domain. Make sure that the `base_url` starts with `https://`.
`sync_formula_fields`	(Optional) Sync formula fields (default value = `false`).	`true`, `false`

Authorization

There are two ways to authorize this connector type:

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

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

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

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.

By using the or the Fivetran dashboard.

Salesforce Commerce Cloud

Request

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

{
    "service": "salesforce_commerce_cloud",
    "group_id": "target_group_id",
    "config": {
      "schema": "test_sfcc",
      "client_id": "your_client_id",
      "client_secret": "your_api_secret",
      "short_code": "your_short_code",
      "site_id": "your_site_id",
      "customer_list_id": "your_customer_list_id",
      "organization_id": "organization_id"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	The Salesforce Commerce Cloud Client ID.
`client_secret`	The Salesforce Commerce Cloud Client secret.
`short_code`	The Salesforce eight-character string assigned to a realm for routing purposes.
`site_id`	The name of the site from which you want to sync data.
`customer_list_id`	The parameter to retrieve customer details.
`organization_id`	The organization ID from Salesforce Commerce Cloud account.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: client_id, client_secret, short_code, site_id, organization_id and customer_list_id.
By using the or the Fivetran dashboard.

Salesforce Marketing Cloud

Request

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

{
    "service": "salesforce_marketing_cloud",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_sfmc",
        "client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "client_secret": "your_api_secret",
        "instance": "",
	"is_new_package": "true",
        "sub_domain": "http://your.sub.domain/"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	The Salesforce Marketing Cloud client ID.
`client_secret`	The Salesforce Marketing Cloud client secret.
`instance`	The Salesforce Marketing Cloud instance ID	`s1`, `s4`, `s5`, `s6`, `s7`, `s8`, `s10`, `s50`
`is_new_package`	Indicates that your installed package uses OAuth 2.0. Default value: `false`	`true`, `false`
`sub_domain`	Your Salesforce Marketing Cloud subdomain.

Authorization

There are two ways to authorize this connector type:

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

Salesloft

Request

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

{
    "service": "salesloft",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_salesloft"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

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

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

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

Auth parameters

Name	Description
`client_id`	`Client ID` of your Salesloft client application.
`client_secret`	`Client Secret` of your Salesloft 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.

By using the or the Fivetran dashboard.

Salsify Lite Private Preview

Request

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

{
  "service": "salsify",
  "group_id": "target_group_id",
  "config": {
    "schema": "salsify_schema_name",
    "api_key": "your_salsify_api_key",
    "sub_domain": "your_salsify_organization_id"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Salsify API Key.
`sub_domain`	Your Salsify Organization ID.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: api_key and sub_domain.
By using the or the Fivetran dashboard.

Samsara Lite

Request

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

{
   "service": "samsara",
   "group_id": "target_group_id",
   "config": {
      "schema": "samsara_schema_name",
      "access_token": "your_samsara_api_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`access_token`	Your Samsara API token.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the access_token field in the request.
By using the or the Fivetran dashboard.

SAP Business ByDesign

Request

POST api.fivetran.com/v1/connectors

{
    "service": "sap_business_by_design",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_sap_business_bydesign",
        "username" : "your_sap_business_bydesign_username",
        "password" : "your_sap_business_bydesign_password",
        "instance_url": "your_sap_business_bydesign_instance_url"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	The SAP Business ByDesign username.
`password`	The SAP Business ByDesign password.
`instance_url`	The SAP Business ByDesign instance URL.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username, password, and instance_url.
By using the or the Fivetran dashboard.

SAP Concur

Request

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

{
    "service": "concur",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_sap_concur",
        "client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
        "client_secret": "your_application_secret",
        "username" : "your_sap_concur_username",
        "login_password" : "your_login_password",
        "region" : "your_region"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	The SAP Concur Client ID.
`client_secret`	The SAP Concur Client secret.
`username`	The SAP Concur username.
`login_password`	The SAP Concur password.
`region`	The region.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: client_id, client_secret, username, login_password, and region.
By using the or the Fivetran dashboard.

SAP HANA Private Preview

IMPORTANT: We have disabled new connector creation using our REST API.

Request

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

{
    "service": "sap_hana",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_sap_hana",
        "host": "sap_hana_host",
        "port": 1521,
        "database": "sap_hana_database",
        "user": "sap_hana_user",
        "password": "sap_hana_password",
        "test_table_name": "sap_hana_test_table_name",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	The SAP HANA host or IP address.
`port`	The SAP HANA port number.
`user`	Your SAP HANA user name.
`password`	Your SAP HANA password.
`database`	The database name.
`testTableName`	The table name to test the connection. By default, we use the `T503K` table.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`connection_type`	Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user, password, database, testTableName, tunnel_host, tunnel_port, and tunnel_user.
By using the or the Fivetran dashboard.

SAP SuccessFactors In Dev

Request

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

{
    "service": "sap_success_factors",
    "group_id": "target_group_id",
    "config": {
        "client_id": "sap_success_factors_client_id",
        "client_secret": "sap_success_factors_client_secret",
        "company_id": "sap_success_factors_company_id",
        "sub_domain": "http://your.sub.domain"
    }
}
content_copy

Config parameters

Name	Description
`client_id`	Your SAP SuccessFactors Client ID.
`client_secret`	Your SAP SuccessFactors Client Secret which you generated through SAML Assertion.
`company_id`	Your SAP SuccessFactors Company ID.
`sub_domain`	Your SAP SuccessFactors Subdomain.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: sub_domain, company_id, client_id, and client_secret.
By using the or the Fivetran dashboard.

SAP S/4 Private Preview

IMPORTANT: We have disabled new connector creation using our REST API.

Request

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

{
    "service": "sap_s4hana",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_sap_s4",
        "host": "sap_s4_host",
        "port": 1521,
        "database": "sap_s4_database",
        "user": "sap_s4_user",
        "password": "sap_s4_password",
        "test_table_name": "sap_s4_test_table_name",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	The SAP S/4 host or IP address.
`port`	The SAP S/4 port number.
`user`	Your SAP S/4 user name.
`password`	Your SAP S/4 password.
`database`	The database name.
`testTableName`	The table name to test the connection. By default, we use the `T503K` table.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user, password, database, testTableName, tunnel_host, tunnel_port and tunnel_user.
By using the or the Fivetran dashboard.

SCORM Lite

Request

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

{
   "service": "scorm",
   "group_id": "target_group_id",
   "config": {
      "schema": "scorm_schema_name",
      "username": "your_scorm_app_id",
      "password": "your_scorm_secret_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your SCORM App ID.
`password`	Your SCORM Secret Key.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username and password.
By using the or the Fivetran dashboard.

Segment

Request

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

{
    "service": "segment",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_segment_webhook",
        "sync_type": "Webhook"
    }
}
content_copy

{
    "service": "segment",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_segment_s3",
        "sync_type": "S3",
        "prefix": "prefix",
        "bucket": "bucket",
        "role_arn": "role_arn"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_type`	The Segment connector sync type.	`Webhook`, `S3`
`prefix`	Folder path to the Segment files within the bucket. Must be populated if `sync_type` is set to `S3`.
`bucket`	The name of the Segment bucket. Must be populated if `sync_type` is set to `S3`.
`role_arn`	The Role ARN required for authentication. Must be populated if `sync_type` is set to `S3`.

Authorization

There are three ways to authorize this connector type:

By specifying the values for the following fields in the request: prefix, bucket, and role_arn, if sync_type is set to S3.
By specifying the field sync_type as webhook, if you are connecting using only webhooks.
By using the or the Fivetran dashboard.

SendGrid

Request

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

{
    "service": "sendgrid",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_sendgrid",
        "api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	The SendGrid API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Sendinblue Lite

Request

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

{
   "service": "sendinblue",
   "group_id": "target_group_id",
   "config": {
      "schema": "sendinblue_schema_name",
      "api_key": "your_sendinblue_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Sendinblue API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

ServiceNow

Request

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

{
    "service": "servicenow",
    "group_id": "target_group_id",
    "config": {
        "schema": "stripe_schema",
        "instance": "instance_id",
        "client_id": "client_id",
        "client_secret": "client_secret",
        "username": "username",
        "password": "password"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`instance`	ServiceNow Instance ID.
`client_id`	ServiceNow Client ID.
`client_secret`	ServiceNow Client Secret.
`username`	Your ServiceNow User ID (username).
`password`	Your account password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: instance, client_id, client_secret, username and password.
By using the or the Fivetran dashboard.

SFTP

Request

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

{
    "service": "sftp",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_sftp",
        "table": "table_name",
        "connection_method": "direct",
        "is_keypair": "false",
        "password": "password",
        "user": "user_name",
        "host": "sftp.company.com",
        "port": "22",
        "prefix": "folder_path",
        "pattern": "file_pattern",
        "file_type": "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",
        "use_pgp_encryption_options": "false",
        "pgp_secret_key": "<secret-key-used>",
        "pgp_pass_phrase": "<pass-phrase-used>",
        "line_separator": ";"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`connection_method`	The connection method used to connect to SFTP Server.	`direct`, `sshTunnel`
`is_keypair`	Whether to use a key pair for authentication. When `true`, do not use `password`.	`true`, `false`
`password`	SFTP password.
`user`	SFTP user.
`host`	SFTP host address.
`port`	SFTP port.
`tunnel_user`	Tunnel user, specify only to connect via SSH tunnel.
`tunnel_host`	Tunnel host address, specify only to connect via SSH tunnel.
`tunnel_port`	Tunnel port, specify only to connect via SSH tunnel.
`prefix`	All files and folders under this folder path will be searched for files to sync.
`pattern`	All files in your search path matching this regular expression will be synced.
`file_type`	If your files are saved with improper extensions, you can force them to by synced as the selected file type.	`infer`, `csv`, `json`, `tsv`, `avro`
`json_delivery_mode`	Specifies how Fivetran should handle your JSON data. Default value: `packed`.	`packed`, `unpacked`
`compression`	The secrets that should be passed to the function at runtime.	`infer`, `uncompressed`, `tar`, `tar_bz2`, `tar_gz`
`on_error`	If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.	`fail`, `skip`
`append_file_pption`	If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.	`upsert_file`, `append_file`
`archive_pattern`	Files inside of compressed archives with filenames matching this regular expression will be synced.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`delimiter`	You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`skip_before`	We will skip over the number of lines specified before syncing data.
`skip_after`	We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
`use_pgp_encryption_options`	Set to `true` if files present in the SFTP server are encrypted using PGP. Default value: `false`.	`false`, `true`
`pgp_secret_key`	The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
`pgp_pass_phrase`	The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.

NOTE: The unique public key for your group may be viewed in the SFTP setup form.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user and password.
By using the or the Fivetran dashboard.

SharePoint

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

The connector supports two sync strategies:

Magic Folder Request

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

{
    "service": "share_point",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_share_point",
        "share_url": "target_folder_id"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema has to be unique within the group (destination). Required for connector creation.
`share_url`	Your SharePoint folder URL. You can find the folder URL by following the steps mentioned in the .

Merge Mode Request

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

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

{
   "service": "share_point",
   "group_id": "target_group_id",
   "config": {
      "schema": "test_share_point",
      "table": "test_table",
      "prefix": "folder_link_url",
      "pattern": "file_pattern",
      "file_type": "infer",
      "json_delivery_mode": "packed",
      "compression": "infer",
      "on_error": "fail",
      "append_file_option": "upsert_file",
      "archive_pattern": "regex_pattern",
      "null_sequence": "",
      "delimiter": "|",
      "escape_char": "escape_char",
      "skip_before": "0",
      "skip_after": "0",
      "is_single_table_mode": "true",
      "line_separator": ";"
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema` (required)	The connector schema name has to be unique within the group (destination).
`table` (required)	The table name within the schema to which the connector will sync the data.
`prefix` (required)	All files and folders under this folder path link will be searched for files to sync. This can be any shared folder link.
`pattern`	All files in your search path matching this regular expression will be synced.
`file_type`	If your files are saved with improper extensions, you can force them to be synced as the selected file type.	`infer`, `csv`, `json`, `tsv`, `avro`, `parquet`
`json_delivery_mode`	Specifies how Fivetran should handle your JSON data. Default value: `packed`.	`packed`, `unpacked`
`compression`	The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.	`infer`, `uncompressed`, `tar`, `tar_bz2`, `tar_gz`
`on_error`	If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.	`fail`, `skip`
`append_file_option`	If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.	`upsert_file`, `append_file`
`archive_pattern`	Files inside of compressed archives with filenames matching this regular expression will be synced.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`delimiter`	You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`skip_before`	We will skip over the number of lines specified before syncing data.
`skip_after`	We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
`is_single_table_mode` (required as `true`)	Allows the creation of connector using Merge Mode strategy.	`true`, `false`
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.

Authorization

There are two ways to authorize this connector type:

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

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

{
 "service": "share_point",
 "group_id": "target_group_id",
 "config": {
     "schema": "test_share_point",
     "share_url": "target_share_url"
 },
 "auth": {
     "client_access": {
         "client_id": "my_client_id",
         "client_secret": "my_client_secret"
     },
     "refresh_token":  "my_refresh_token"
 }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Microsoft client application.
`client_secret`	`Client Secret` of your Microsoft client application.
`refresh_token`	The long-lived Refresh token carries the information necessary to get a new access token for API resources.

By using the or the Fivetran dashboard.

ShipHero Lite

Request

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

{
   "service": "shiphero",
   "group_id": "target_group_id",
   "config": {
      "schema": "shiphero_schema_name",
      "username": "your_shiphero_username",
      "password": "your_shiphero_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your ShipHero username.
`password`	Your ShipHero password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username and password.
By using the or the Fivetran dashboard.

ShipStation Lite

Request

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

{
   "service": "shipstation",
   "group_id": "target_group_id",
   "config": {
      "schema": "shipstation_schema_name",
      "username": "your_shipstation_username",
      "password": "your_shipstation_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your ShipStation username.
`password`	Your ShipStation password.

Shopify

Request

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

{
    "service": "shopify",
    "group_id": "target_group_id",
    "config": {
        "schema": "shopify_schema",
        "shop": "shop_name"
    }
}
content_copy

Config parameter

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`shop`	The Shopify shop name. Can be found in the URL before .myshopify.com.

Authorization

There are two ways to authorize this connector type:

By specifying a value for access_token in the auth section.

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

 {
     "service": "shopify",
         "group_id": "target_group_id",
         "config": {
             "schema": "test_shopify",
             "shop": "my_shop"
         },
     "auth": {
         "access_token" : "my_access_token"
     }
 }
content_copy

Auth parameter

Name	Description
`access_token`	The Shopify access token.

By using the or the Fivetran dashboard.

Short.io Lite Private Preview

Request

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

{
   "service": "shortio",
   "group_id": "target_group_id",
   "config": {
      "schema": "shortio_schema_name",
      "api_key": "your_shortio_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Short.io API key.

Authorization

There are two ways to authorize this connector type:

By specifying the api_key field in the request.
By using the or the Fivetran dashboard.

SkuVault Lite

Request

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

{
   "service": "skuvault",
   "group_id": "target_group_id",
   "config": {
      "schema": "skuvault_schema_name",
      "email": "your_skuvault_email",
      "password": "your_skuvault_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`email`	Your SkuVault Email.
`password`	Your SkuVault Password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: email and password.
By using the or the Fivetran dashboard.

Simplesat Lite In Dev

Request

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

{
  "service": "simplesat",
  "group_id": "target_group_id",
  "config": {
     "schema": "simplesat_schema_name",
     "api_key": "your_simplesat_api_key"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Simplesat API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Skilljar Lite Private Preview

Request

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

{
  "service": "skilljar",
  "group_id": "target_group_id",
  "config": {
     "schema": "skilljar_schema_name",
     "api_key": "your_skilljar_api_key"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Skilljar API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Slab Lite Private Preview

Request

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

{
  "service": "slab",
  "group_id": "target_group_id",
  "config": {
     "schema": "slab_schema_name",
     "access_token": "your_slab_access_token"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`access_token`	Your Slab API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the access_token field in the request.
By using the or the Fivetran dashboard.

Snapchat Ads

Request

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

{
    "service": "snapchat_ads",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_snapchat_ads",
        "sync_mode": "SpecificOrganizations",
        "organizations": ["abc","cde","def"],
        "swipe_attribution_window": "DAY_7",
        "view_attribution_window": "HOUR_3",
        "timeframe_months": "THREE"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all organizations or specific organizations. Default value: `AllOrganizations`.	`AllOrganizations`, `SpecificOrganizations`
`organizations`	Specific organizations IDs to sync. Must be populated if `syncMode` is set to `SpecificOrganizations`.
`swipe_attribution_window`	The time period to attribute conversions based on swipes. Default value: `DAY_28`	`DAY_1`, `DAY_7`, `DAY_28`
`view_attribution_window`	The time period to attribute conversions based on views. Default value: `DAY_1`	`HOUR_1`, `HOUR_3`, `HOUR_6`, `DAY_1`, `DAY_7`, `DAY_28`
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

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

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

{
     "service": "snapchat_ads",
     "group_id": "target_group_id",
     "config": {
         "schema": "test_snapchat_ads",
         "sync_mode": "SpecificOrganizations",
         "organizations": ["abc","cde","def"],
         "swipe_attribution_window": "DAY_7",
         "view_attribution_window": "HOUR_3",
         "timeframe_months": "THREE"
     },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Snapchat Ads client application.
`client_secret`	`Client Secret` of your Snapchat 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.

By using the or through the Fivetran dashboard.

Snowflake Beta

Request

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

{
    "service": "snowflake_db",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_snowflake_db",
        "auth": "password",
        "host": "host",
        "port": 443,
        "database": "database",
        "user": "user",
        "password": "password",
        "connectionType": "Directly",
        "passphrase": "passphrase",
        "private_key": "privateKey",
        "is_private_key_encrypted": true,
        "role": "role",
        "update_method": "TELEPORT"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`auth`	Password-based or key-based authentication type.
`host`	The Snowflake service host address.
`port`	The Snowflake service host port.
`database`	The Snowflake database name.
`user`	The Snowflake username.
`password`	The Snowflake user's password.
`connection_type`	The connection method.	`Directly`, `PrivateLink`
`passphrase`	The passphrase used to encrypt the private key. Must be populated if `is_private_key_encrypted` is set to `true`.
`private_key`	The complete contents of your private key file including the start and end tags (`----BEGIN PRIVATE KEY----`Your key without line breakers`----END PRIVATE KEY----`).
`is_private_key_encrypted`	Whether the private key is encrypted.	`true`, `false`
`role`	The Snowflake user's role.
`update_method`	Default value: `Teleport`	`Teleport`, `Time Travel`

Initial Configuration

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

Authorization

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

Snowplow

Request

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

{
    "service": "snowplow",
    "group_id": "target_group_id",
    "config": {
        "schema": "schema_name",
        "enable_enrichments": "false",
        "config_repository_url": "configRepositoryURL"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`enable_enrichments`	To sync events with or without enrichments.	`true`, `false`
`config_repository_url`	The public repository URL containing JSON configuration files.

Initial Configuration

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

Authorization

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

Sonarqube Lite

Request

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

{
  "service": "sonarqube",
  "group_id": "target_group_id",
  "config": {
    "schema": "sonarqube_schema_name",
    "sub_domain": "your_sonarqube_sub_domain",
    "api_key": "your_sonarqube_api_key"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Sonarqube subdomain.
`api_key`	Your Sonarqube API key.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: sub_domain and api_key.
By using the or the Fivetran dashboard.

Split Lite

Request

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

{
   "service": "splitio",
   "group_id": "target_group_id",
   "config": {
      "schema": "split_schema_name",
      "admin_api_key": "your_split_admin_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`admin_api_key`	Your Split Admin API key.

Authorization

There are two ways to authorize this connector type:

By specifying the value of the admin_api_key field in the request.
By using the or the Fivetran dashboard.

Splunk Beta

Request

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

{
    "service": "splunk",
    "group_id": "target_group_id",
    "config": {
        "schema": "schema",
        "host": "host",
        "port": 8089,
        "user": "user",
        "password": "password"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`host`	The Splunk service host address.
`port`	The Splunk service host port.
`user`	The Splunk username.
`password`	The Splunk user's password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user and password.
By using the or the Fivetran dashboard.

SQL Server

Fivetran supports a few different incarnations of SQL Server. Each type of connector has its own service value:

- "service": "azure_sql_db"
- "service": "azure_sql_managed_db"
- "service": "sql_server"
- "service": "google_cloud_sqlserver"
- "service": "sql_server_rds"

Check out our setup guide for your type of connector.

Request

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

{
    "service": "sql_server",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "test_sql",
        "host": "sqlinstance.mycompany.com",
        "port": 1433,
        "database": "sqldb",
        "user": "test_user",
        "password": "test_password",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "update_method": "NATIVE_UPDATE"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The user name. For Azure Databases, the format must be `user@domain`.
`password`	The user's password.
`database`	The database name.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`update_method`	(Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.

Authorization

There are three ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, password, user and database.

For azure_sql_db and azure_sql_managed_db service types: by specifying the values of the tenant_id in the config section, access_token and refresh_token parameters in the auth section:

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

{
    "service": "azure_sql_db | azure_sql_managed_db",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "azure_sql",
        "auth_method": "ActiveDirectory",
        "tenant_id": "your_tenant_id"
    },
    "auth": {
        "access_token": "my_access_token",
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

Name	Description
`auth_method`	Authorization method.
`tenant_id`	Azure AD tenant ID.
`access_token`	The long-lived Access token carries the information necessary to access API resources.
`refresh_token`	The long-lived Refresh token carries the information necessary to get a new access token for API resources.

By using the or the Fivetran dashboard.

High-Volume Agent SQL Server Beta

Fivetran supports a few different incarnations of High-Volume Agent SQL Server. Each type of connector has its own service value:

- "service": "sql_server_hva"
- "service": "sql_server_sap_ecc_hva"

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

{
    "service": "sql_server_hva",
    "group_id": "target_group_id",
    "config": {
        "schema_prefix": "sql_server_hva_example",
        "host": "host.com",
        "port": 1433,
        "database": "oracledb",
        "pdb_name": "pdb_name",
        "user": "test_user",
        "password": "test_password",
        "tunnel_host": "XXX.XXX.XXX.XXX",
        "tunnel_port": 22,
        "tunnel_user": "fivetran",
        "connection_type": "SshTunnel",
        "always_encrypted": true,
        "agent_host": "host.com",
        "agent_port": 4343,
        "agent_user": "hvr",
        "agent_password": "agent_password",
        "agent_public_cert": "CERTIFICATE",
        "update_method": "NATIVE_UPDATE"
    }
}
content_copy

Config parameters

Name	Description
`schema_prefix`	The connector schema prefix has to be unique within the group (destination). Required for connector creation.
`host`	DB instance host or IP address.
`port`	The port number.
`user`	The user name. For Azure Databases, the format must be `user@domain`.
`password`	The user's password.
`database`	The database name.
`pdb_name`	(Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`agent_host`	The host address of the machine running the agent. Often the same as the DB host.
`agent_port`	The port that the agent has open for Fivetran's connection. Default value is 4343.
`agent_user`	The agent's username.
`agent_password`	The password for the agent user.
`agent_public_cert`	The public certificate generated by the agent.
`sap_schema`	SAP Schema Name. Required only for High-Volume Agent SAP ECC connector.
`update_method`	(Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: host, port, user, password, database, agent_host, agent_port, agent_public_cert, agent_user, and agent_password.
By using the or the Fivetran dashboard.

Spotify Ads Private Preview

Request

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

{
    "service": "spotify_ads",
    "group_id": "target_group_id",
    "config": {
        "schema": "spotify_ads",
        "sync_mode": "SPECIFIC_ACCOUNTS",
        "timeframe_months": "SIX",
        "accounts": [],
        "reports": [
            {
                "table": "table_1",
                "dimensions": [ "DAY" ],
                "fields": [ "CLICKS" ]
            },
            {
                "table": "table_2", 
                "dimensions": [ "DAY", "CAMPAIGN", "CURRENCY" ],
                "fields": [ "CLICKS", "CTR", "IMPRESSIONS" ]
            }
        ]
    }
}
content_copy

Config parameters

Name	Description	Supported Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all accounts or specific accounts.	`ALL_ACCOUNTS`, `SPECIFIC_ACCOUNTS`
`timeframe_months`	The number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`
`accounts`	The list of Ad Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
`reports`	The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
`table`	The table name within the schema to which connector will sync the data of the specific report.
`dimensions`	A list of the dimensions to sync.
`fields`	A list of the fields (metrics) to sync.

NOTE: The DAY dimension is required for . Make sure the DAY dimension is present for every table.

Authorization

There are two ways to authorize this connector type:

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

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

{
    "service": "spotify_ads",
    "group_id": "target_group_id",
    "config": {
        "schema": "spotify_ads",
        "sync_mode": "SPECIFIC_ACCOUNTS",
        "accounts": [],
        "reports": [
            {
                "table": "table_1",
                "dimensions": [ "DAY" ],
                "fields": [ "CLICKS" ]
            },
            {
                "table": "table_2", 
                "dimensions": [ "DAY", "CAMPAIGN", "CURRENCY" ],
                "fields": [ "CLICKS", "CTR", "IMPRESSIONS" ]
            }
        ]
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret",
            "user_agent": "my_company_name",
            "developer_token": "my_developer_token"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Ad Studio application.
`client_secret`	`Client Secret` of your Ad Studio 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.

By using the or the Fivetran dashboard.

Sprout Social Private Preview

Request

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

{
   "service": "sprout",
   "group_id": "target_group_id",
   "config": {
      "schema": "sprout_schema_name",
      "bearer_token": "your_sprout_bearer_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`bearer_token`	Your Sprout API access token.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the bearer_token field in the request.
By using the or the Fivetran dashboard.

Square

Request using API access token

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

{
    "service": "square",
    "group_id": "group_id",
    "config": {
        "schema": "square_schema",
        "client_id": "clientId",
        "api_access_token": "accessToken"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	The Application ID of your organization.
`api_access_token`	The Square API access token of your application.

Request using OAuth

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

{
    "service": "square",
    "group_id": "group_id",
    "config": {
        "schema": "square_schema",
        "client_id": "clientId",
        "client_secret": "clientSecret",
        "refresh_token": "refreshToken"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	The Application ID of your organization.
`client_secret`	The Application Secret of your organization.
`refresh_token`	The OAuth refresh token of your organization.

Retrieving the access token

Log in to with your personal credentials and click on the View Details option displayed under your Application ID.
Switch to Production Settings option in the bottom left corner.
Select Credentials menu on the left side of the screen.
Click on Show option for Personal Access Token tab.
Copy the access Token.

Authorization

There are three ways to authorize this connector type:

By specifying the values for the following fields in the request: client_idand api_access_token.
By specifying the values for the following fields in the request: client_id, client_secret, and refresh_token.
By using the or the Fivetran dashboard.

Squarespace Lite

Request

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

{
   "service": "squarespace",
   "group_id": "target_group_id",
   "config": {
      "schema": "squarespace_schema_name",
      "api_key": "your_squarespace_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Squarespace API key.

Authorization

There are two ways to authorize this connector type:

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

StackAdapt Lite Private Preview

Request

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

{
   "service": "stackadapt",
   "group_id": "target_group_id",
   "config": {
      "schema": "stackadapt_schema_name",
      "api_key": "your_stackadapt_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your StackAdapt API key.

Authorization

There are two ways to authorize this connector type:

By specifying a value for the api_key field in the request.
By using the or the Fivetran dashboard.

Stripe

Request

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

{
    "service": "stripe",
    "group_id": "target_group_id",
    "config": {
        "schema": "stripe_schema",
        "access_token": "restricted_key"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`access_token`	The Stripe API Restricted Key

Authorization

There are two ways to authorize this connector type:

By specifying a value for the access_token field in the request.
By using the or the Fivetran dashboard.

Stylight Lite Private Preview

Request

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

{
   "service": "stylight",
   "group_id": "target_group_id",
   "config": {
      "schema": "stylight_schema_name",
      "username": "your_stylight_api_username",
      "password": "your_stylight_api_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your Stylight Username.
`password`	Your Stylight Password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username and password.
By using the or the Fivetran dashboard.

Subscript Lite

Request

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

{
   "service": "subscript",
   "group_id": "target_group_id",
   "config": {
      "schema": "subscript_schema_name",
      "api_key": "your_subscript_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Subscript API key.

Authorization

There are two ways to authorize this connector type:

By specifying the api_key field in the request.
By using the or the Fivetran dashboard.

SugarCRM Lite In Dev

Request

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

{
   "service": "sugarcrm",
   "group_id": "target_group_id",
   "config": {
      "schema": "sugarcrm_schema_name",
      "sub_domain": "your.sub.domain.com",
      "client_id": "your_sugarcrm_username",
      "client_secret": "your_sugarcrm_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your SugarCRM subdomain.
`client_id`	Your SugarCRM username.
`client_secret`	Your SugarCRM password.

Authorization

There are two ways to authorize this connector type:

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

SurveyMonkey

Request

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

{
    "service": "survey_monkey",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_survey_monkey",
        "eu_region": true
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`eu_region`	The SurveyMonkey account region. Specify `true`, if your account is hosted in the EU region. Default value is `false`.	`true`, `false`

Authorization

There are two ways to authorize this connector type:

By specifying the values for client_access and access_token in the auth section.

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

  {
      "service": "survey_monkey",
      "group_id": "target_group_id",
      "config": {
          "schema": "test_survey_monkey",
          "eu_region" : false
      },
      "auth": {
          "client_access": {
              "client_id": "my_client_id",
              "client_secret": "my_client_secret"
          },
          "access_token": "my_access_token"
      }
  }
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your SurveyMonkey client application.
`client_secret`	`Client Secret` of your SurveyMonkey client application.
`access_token`	The long-lived `Access token` carries the information necessary to access API resources.

By using or through the Fivetran dashboard.

Survicate Lite

Request

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

{
   "service": "survicate",
   "group_id": "target_group_id",
   "config": {
      "schema": "your_survicate_schema_name",
      "api_key": "your_survicate_api_key"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Survicate API Key.

Authorization

There are two ways to authorize this connector type:

By specifying the api_key field in the request.
By using the or the Fivetran dashboard.

Tableau Lite Private Preview

Request

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

{
   "service": "tableau_source",
   "group_id": "target_group_id",
   "config": {
      "schema": "tableau_source_schema_name",
      "pat_name": "your_tableau_source_personal_access_token_name",
      "pat_secret": "your_tableau_source_personal_access_token_secret",
      "site_name": "your_tableau_source_site_name",
      "site_url": "your_tableau_source_subdomain"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`pat_name`	Your Tableau Source PAT Name.
`pat_secret`	Your Tableau Source PAT Secret.
`site_name`	Your Tableau Source site name.
`site_url`	Your Tableau Source subdomain.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: pat_name, pat_secret, site_name and site_url.
By using the or the Fivetran dashboard.

Taboola

Request

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

{
    "service": "taboola",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_taboola",
        "client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "client_secret": "your_api_secret",
        "sync_mode": "AllAccounts",
        "account_ids": "account_id1, account_id2"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	The Taboola client ID.
`client_secret`	The Taboola client secret.
`sync_mode`	Whether to sync all accounts or specific accounts.	`AllAccounts`, `SpecificAccounts`
`account_ids`	Specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: client_id, client_secret and access_token.
By using the or the Fivetran dashboard.

Talkdesk

Request

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

{
   "service": "talkdesk",
   "group_id": "target_group_id",
   "config": {
      "schema": "talkdesk_schema_name",
      "account_name" : "talkdesk_account_name",
      "region": "talkdesk_region",
      "client_id": "client_id",
      "client_secret": "client_secret"
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`account_name`	Your Talkdesk account name.
`region`	Your Talkdesk region.	`.com`, `.eu`, `ca.com`
`client_id`	Client ID of your OAuth client.
`client_secret`	Client secret of your OAuth client.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: client_id and client_secret.
By using the or the Fivetran dashboard.

Teamwork Lite

Request

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

{
   "service": "teamwork",
   "group_id": "target_group_id",
   "config": {
      "schema": "teamwork_schema_name",
      "site_address": "your_site_address",
      "username": "your_username",
      "password": "your_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`site_address`	Your Teamwork site address.
`username`	Your Teamwork username.
`password`	Your Teamwork password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: site_address, username, and password.
By using the or the Fivetran dashboard.

Tempo Lite

Request

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

{
   "service": "tempo",
   "group_id": "target_group_id",
   "config": {
      "schema": "tempo_schema_name",
      "sub_domain": "your_tempo_organization_name"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Tempo subdomain.

Authorization

There are two ways to authorize this connector type:

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

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

{
   "service": "tempo",
   "group_id": "target_group_id",
   "config": {
      "schema": "tempo_schema_name",
      "sub_domain": "your_tempo_organization_name"
   },
   "auth": {
       "client_access": {
           "client_id": "tempo_client_id",
           "client_secret": "tempo_client_secret"
       }
   }
}
content_copy

Auth parameters

Name	Description
`client_access.client_id`	Your Tempo Client ID.
`client_access.client_secret`	Your Tempo Client secret.

By using the or the Fivetran dashboard.

The Trade Desk

Request

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

{
    "service": "the_trade_desk",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_trade_desk",
        "login": "test_login",
        "password": "xxxxxxxxxx",
        "sync_mode": "SpecificAccounts",
        "partners": ["partner_id1", "partner_id2"]
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`login`	The Trade Desk email. It is a part of the login credentials.
`password`	The Trade Desk password. It is a part of the login credentials.
`sync_mode`	Whether to sync all accounts or specific accounts.	`AllAccounts`, `SpecificAccounts`
`partners`	Specific Partner IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: login and password.
By using the or the Fivetran dashboard.

TikTok Ads

Request

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

{
   "service": "tiktok_ads",
   "group_id": "target_group_id",
   "config": {
      "schema": "tiktok_ads",
      "sync_mode": "SpecificAccounts",
      "accounts": ["123","543"],
      "timeframe_months": "THREE",
      "custom_reports": [
         {
            "table_name": "table_1",
            "report_type": "auction_basic_campaign_report",
            "dimensions": ["campaign_id"],
            "metrics": ["conversion", "cost_per_conversion", "conversion_rate"],
            "aggregate": "daily"
         },
         {
            "table_name": "table_2",
            "report_type": "reservation_ads_adgroup_report",
            "dimensions": ["adgroup_id"],
            "metrics": ["likes", "comments", "shares", "profile_visits"],
            "aggregate": "lifetime"
         }
      ],
      "attributionWindowSize": "FOURTEEN"
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all advertiser accounts or specific accounts.	`AllAccounts`, `SpecificAccounts`
`accounts`	Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`
`custom_reports`	The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
`table_name`	The table name within the schema to which connector will sync the data of the specific report.
`report_type`	The name of the TikTok Ads report from which the connector will sync the data.	`auction_basic_campaign_report`,`auction_basic_adgroup_report`,`auction_basic_ad_report`,`auction_basic_advertiser_report`,`auction_audience_campaign_report`,`auction_audience_adgroup_report`,`auction_audience_ad_report`,`auction_audience_advertiser_report`,`reservation_ads_campaign_report`,`reservation_ads_adgroup_report`,`reservation_ads_ad_report`,`reservation_ads_advertiser_report`
`dimensions`	A list of the dimensions to group the data to be synced. ID dimensions are mandatory.
`metrics`	A list of the metrics to be synced.
`aggregate`	The aggregation duration.	`hourly` , `daily` , `lifetime`
`attributionWindowSize`	The attribution window to capture conversions.	`ONE`, `SEVEN`, `FOURTEEN`, `TWENTY_EIGHT`

Authorization

There are two ways to authorize this connector type:

By specifying the values for client_access and access_token in the auth section.

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

 {
  "service": "tiktok_ads",
      "group_id": "target_group_id",
      "config": {
          "schema": "tiktok_ads",
          "sync_mode": "SpecificAccounts",
          "accounts": ["123"],
          "timeframe_months": "THREE",
          "custom_reports": [
              {
                  "table_name": "table_1",
                  "report_type": "auction_basic_campaign_report",
                  "dimensions": ["campaign_id"],
                  "metrics": ["conversion", "cost_per_conversion", "conversion_rate"],
                  "aggregate": "daily"
              }
            ]
       },
    "auth": {
       "client_access": {
           "client_id": "my_client_id",
           "client_secret": "my_client_secret"
       },
       "access_token": "my_access_token"
   }
 }
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your TikTok Ads client application.
`client_secret`	`Client Secret` of your TikTok Ads client application.
`access_token`	The long-lived `Access token` carries the information necessary to access API resources.

By using the or through the Fivetran dashboard.

IMPORTANT: If you use your own OAuth application, grant Fivetran read access permissions to all the endpoints.

Trello Lite

Request

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

{
   "service": "trello",
   "group_id": "target_group_id",
   "config": {
      "schema": "trello_schema_name",
      "api_key": "your_trello_api_key",
      "api_token": "your_trello_api_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Trello API key.
`api_token`	Your Trello API token.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: api_key and api_token.
By using the or the Fivetran dashboard.

Twilio

Request

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

{
   "service": "twilio",
   "group_id": "group_id",
   "config": {
       "schema": "test_twilio",
	   "sid":"test_api_sid",
	   "secret":"test_api_secret",
	   "accounts":[
	      "test_account_sid"
	   ],
	   "sync_mode":"SpecificAccounts"
}
   }
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sid`	The Twilio API key SID
`secret`	The Twilio API secret
`accounts`	Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
`sync_mode`	Whether to sync all accounts or specific accounts.	`AllAccounts`, `SpecificAccounts`

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: sid, secret, sync_mode and accounts.
By using the or the Fivetran dashboard.

Twitter Organic

Request

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

{
    "service": "twitter",
    "group_id": "target_group_id",
    "config": {
        "schema": "twitter_schema",
        "sync_mode": "SpecificAccounts",
        "accounts": ["twitteraccount1","twitteraccount2"],
        "timeframe_months": "TWELVE"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.	`AllAccounts`, `SpecificAccounts`
`accounts`	Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
`timeframe_months`	Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_id, client_secret, oauth_token, and oauth_token_secret parameters in the auth section.

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

{
    "service": "twitter",
    "group_id": "target_group_id",
    "config": {
        "schema": "twitter_schema",
        "sync_mode": "SpecificAccounts",
        "accounts": ["twitteraccount1","twitteraccount2"],
        "timeframe_months": "TWELVE"
    },  
    "auth": {
        "client_access": {
            "client_id": "my_consumer_key",
            "client_secret": "my_consumer_secret"
        },
        "oauth_token": "twitter_access_token",
        "oauth_token_secret": "twitter_access_token_secret"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	The Twitter App consumer key.
`client_secret`	The Twitter App consumer secret.
`oauth_token`	The Twitter App access token.
`oauth_token_secret`	The Twitter App access token secret.

By using the or through the Fivetran dashboard.

Twitter Ads

Request

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

{
   "service": "twitter_ads",
   "group_id": "group_id",
   "config": {
       "schema": "test_twitter",
	   "oauth_token":"twitter_access_token",
	   "oauth_token_secret":"twitter_access_token_secret",
	   "consumer_key":"twitter_key",
	   "consumer_secret":"twitter_secret",
	   "accounts":[
	      "twitter_account1"
	   ],
	   "sync_mode":"SpecificAccounts",
	   "timeframe_months": "timeframe_months"
}
   }
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`oauth_token`	The Twitter App access token.
`oauth_token_secret`	The Twitter App access token secret.
`consumer_key`	The Twitter App consumer key.
`consumer_secret`	The Twitter App consumer secret.
`accounts`	Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
`sync_mode`	Whether to sync all accounts or specific accounts.	`AllAccounts`, `SpecificAccounts`
`timeframe_months`	Historical sync time frame in months.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: oauth_token, oauth_token_secret, consumer_key and consumer_secret.
By using the or the Fivetran dashboard.

Typeform

Request

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

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

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for client_access, refresh_token, and access_token (optional) in the auth section.

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

 {
  "service": "typeform",
      "group_id": "target_group_id",
      "config": {
          "schema": "typeform"           
       },
    "auth": {
           "client_access": {
             "client_id": "my_client_id",
             "client_secret": "my_client_secret"
           },   
        "refresh_token": "my_refresh_token",
        "access_token": "my_access_token"
   }
 }
content_copy

Auth parameters

Name	Description
`client_id`	The Typeform client ID.
`client_secret`	The Typeform client secret.
`refresh_token`	The Typeform API refresh token.
`access_token`	The Typeform API access token.

By using the or the Fivetran dashboard.

Upland Software Lite Private Preview

Request

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

{
   "service": "upland",
   "group_id": "target_group_id",
   "config": {
      "schema": "upland_schema_name",
      "sub_domain": "your_upland_sub_domain",
      "company_key": "your_upland_company_key",
      "username": "your_upland_username",
      "password": "your_upland_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Upland Software subdomain.
`company_key`	Your Upland Software company key.
`username`	Your Upland Software username.
`password`	Your Upland Software password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: sub_domain, company_key, username, and password.
By using the or the Fivetran dashboard.

UserVoice

Request

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

{
    "service": "uservoice",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_uservoice",
        "domain": "uservoice_domain",
        "key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "secret": "your_api_secret"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`domain`	Domain of your UserVoice site. If it ends with ".uservoice.com", you can specify just the subdomain ("mydomain.uservoice.com" → "mydomain")
`key`	The UserVoice API key.
`secret`	The UserVoice API secret.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: domain, key and secret.
By using the or the Fivetran dashboard.

Verizon Media

Request

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

{
    "service": "yahoo_gemini",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_yahoo_gemini",
        "sync_mode": "SpecificAccounts",
        "advertisers_id": ["123","234","345"],
        "timeframe_months": "THREE"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode`	Whether to sync all accounts or specific accounts. Default value: `SpecificAccounts`.	`SpecificAccounts`, `AllAccounts`
`advertisers_id`	Specific Advertiser IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

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

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

{
    "service": "yahoo_gemini",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_yahoo_gemini",
        "sync_mode": "SpecificAccounts",
        "advertisers_id": ["123","234","345"],
        "timeframe_months": "THREE"
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Yahoo Gemini client application.
`client_secret`	`Client Secret` of your Yahoo Gemini 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.

By using the or through the Fivetran dashboard.

Vonage Lite Private Preview

Request

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

{
  "service": "vonage",
  "group_id": "target_group_id",
  "config": {
    "schema": "vonage_schema_name",
    "api_key": "your_vonage_api_key",
    "api_secret": "your_vonage_api_secret"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`api_key`	Your Vonage API key.
`api_secret`	Your Vonage API secret.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: api_key and api_secret.
By using the or the Fivetran dashboard.

Yahoo DSP Private Preview

Request

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

{
   "service": "yahoo_dsp",
   "group_id": "group_id",
   "config": {
       "schema": "test_yahoo_dsp",
       "sync_mode_seat": "SpecificSeats",
       "seats": ["seat1", "seat2"],
       "sync_mode_advertiser": "SpecificAdvertisers",
       "advertisers_with_seat": ["advertiser1:seat1", "advertiser2:seat1", "advertiser3:seat2"],
       "timeframe_months": "THREE"
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sync_mode_seat`	Whether to sync all advertisers or specific advertisers.	`AllSeats`, `SpecificSeats`
`seats`	Specific Seats to sync. Must be populated if `sync_mode_seat` is set to `SpecificSeats`.
`sync_mode_advertiser`	Whether to sync all advertisers or specific advertisers.	`AllAdvertisers`, `SpecificAdvertisers`
`advertisers_with_seat`	Specific Advertisers to sync. Must be populated if `sync_mode_advertiser` is set to `SpecificAdvertisers`.
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.	`THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`, `ALL_TIME`

Authorization

There are two ways to authorize this connector type:

By specifying the values of the client_id and client_secret.

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

{
    "service": "yahoo_dsp",
    "group_id": "group_id",
    "config": {
        "schema": "test_yahoo_dsp",
        "client_id": "client_id",
        "client_secret": "client_secret",
        "sync_mode_seat": "SpecificSeats",
        "seats": ["seat1", "seat2"],
        "sync_mode_advertiser": "SpecificAdvertisers",
        "advertisers_with_seat": ["advertiser1:seat1", "advertiser2:seat1", "advertiser3:seat2"],
        "timeframe_months": "THREE"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your Yahoo DSP client application.
`client_secret`	`Client Secret` of your Yahoo DSP client application.

By using the or through the Fivetran dashboard.

Webhooks

Request

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

{
    "service": "webhooks",
    "group_id": "target_group_id",
    "config": {
        "schema": "schema_name",
        "table": "table_name",
        "sync_format": "Packed",
        "bucket_service": "S3",
        "s3_bucket": "your_bucket_name",
        "s3_role_arn": "arn::your_role_arn",
        "auth_method": "NONE"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`sync_format`	The webhooks sync format. Default value: `Unpacked`. Unpacked messages must be valid JSON.	`Unpacked`, `Packed`
`bucket_service`	Whether to store the events in Fivetran's container service or your S3 bucket. Default value: `Fivetran`.	`Fivetran`, `AZURE`, `GCS`, `S3`
`gcs_bucket`	The GCS bucket name. Required if `bucket_service` is set to `GCS`.
`blob_sas_url`	The blob SAS URL of your Azure container. Required if `bucket_service` is set to `AZURE`.
`s3_bucket`	The S3 bucket name. Required if `bucket_service` is set to `S3`.
`s3_role_arn`	The Role ARN required for authentication. Required if `bucket_service` is set to `S3`.
`endpoint`	You can send your events to https://webhooks.fivetran.com/webhooks/{endpoint}.
`auth_method`	The authentication mechanism you want to use to authenticate incoming events.	`NONE`, `TOKEN_BASED` , `HMAC`

Authorization

There are the following ways to authorize this connector type:

If you use your bucket service, by specifying the values for the following fields in the request:
- blob_sas_url, if bucket_service is set to AZURE
- gcs_bucket, if bucket_service is set to GCS
- s3_bucket and s3_role_arn, if bucket_service is set to S3
IMPORTANT: If bucket_service is set to GCS, you must share your GCS bucket with Fivetran's service account using the account's auto-generated email address in the following format:
g-[group_id]@fivetran-production.iam.gserviceaccount.com
where [group_id] is the connector's group ID.
If you use Fivetran's container service, by specifying Fivetran as a value of the bucket_service field.
By using the or the Fivetran dashboard.

When I Work Lite

Request

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

{
   "service": "when_i_work",
   "group_id": "target_group_id",
   "config": {
      "schema": "when_i_work_schema_name",
      "username": "when_i_work_username",
      "password": "when_i_work_password"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`username`	Your When I Work username.
`password`	Your When I Work password.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username and password.
By using the or the Fivetran dashboard.

WooCommerce Lite

Request

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

{
   "service": "woocommerce",
   "group_id": "target_group_id",
   "config": {
      "schema": "woocommerce_schema_name",
      "word_press_site_id_or_woocommerce_domain_name": "wordpress_site_id or http://your.sub.domain/",
      "consumer_key": "your_woocommerce_consumer_key",
      "consumer_secret": "your_woocommerce_consumer_secret"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`word_press_site_id_or_woocommerce_domain_name`	The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance.
`consumer_key`	Your WooCommerce Consumer key.
`consumer_secret`	Your WooCommerce Consumer secret.

Authorization

There are two ways to authorize this connector type:

By specifying the following fields in the request: word_press_site_id_or_woocommerce_domain_name, consumer_key and consumer_secret.
By using the or the Fivetran dashboard.

WordPress Lite Private Preview

Request

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

{
   "service": "wordpress",
   "group_id": "target_group_id",
   "config": {
      "schema": "wordpress_schema_name",
      "sub_domain": "your_wordpress_subdomain"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your WordPress subdomain.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_access field in the auth section.

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

{
   "service": "wordpress",
   "group_id": "target_group_id",
   "config": {
      "schema": "wordpress_schema_name",
      "sub_domain": "your_wordpress_sub_domain"       
   },
   "auth": {
       "client_access": {
           "client_id": "your_wordpress_client_id",
           "client_secret": "your_wordpress_client_secret"
       }
   }
}
content_copy

Auth parameters

Name	Description
`client_id`	Your WordPress client ID.
`client_secret`	Your WordPress client secret.

By using the or the Fivetran dashboard.

Workable Lite

Request

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

{
   "service": "workable",
   "group_id": "target_group_id",
   "config": {
      "schema": "workable_schema_name",
      "sub_domain": "your_workable_sub_domain",
      "access_token": "your_workable_access_token"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Workable subdomain.
`access_token`	Your Workable access token.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: sub_domain and access_token.
By using the or the Fivetran dashboard.

Workday Financial Management Private Preview

Request

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

{
    "service": "workday_financial_management",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_workday_financial_management",
        "user_name": "workday_username",
        "password": "workday_password",
        "domain_host_name": "your_workday_hostname"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`user_name`	Your Workday username.
`password`	Your Workday password.
`domain_host_name`	Your Workday hostname.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: user_name, password and domain_host_name.
By using the or the Fivetran dashboard.

Workday HCM

Request

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

{
    "service": "workday_hcm",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_workday_hcm",
        "user_name": "workday_username",
        "password": "workday_password",
        "domain_host_name": "your_workday_host_name"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`user_name`	Workday username.
`password`	Workday password.
`domain_host_name`	Workday host name.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: user_name, password and domain_host_name.
By using the or the Fivetran dashboard.

Workday RaaS

Request

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

{
    "service": "workday",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_workday",
        "table": "workday_report_table",
        "user_name": "workday_username",
        "password": "workday_password",
        "report_url": "workday_report_url",
        "report_format_type": "json",
        "support_nested_columns": true,
        "primary_keys": ["key_1", "key_2", ...]
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`table`	The table name within the schema to which connector will sync the data. Required for connector creation.
`user_name`	Workday username.
`password`	Workday password.
`report_url`	URL for a live custom report.
`report_format_type`	Workday report format type. Default format: `json`.	`json` and `csv`
`support_nested_columns`	Set to `true` to unpack the nested columns and sync them separately. Otherwise, set to `false`. By default, we sync the nested columns as JSON objects
`primary_keys`	Primary key(s) to be set in the destination table for the custom report.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: user_name, password and report_url.
By using the or the Fivetran dashboard.

WorkflowMax Lite Private Preview

Request

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

{
  "service": "workflowmax",
  "group_id": "target_group_id",
  "config": {
    "schema": "workflowmax_schema_name"
  }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_access field in the auth section.

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

{
"service": "workflowmax",
"group_id": "target_group_id",
"config": {
    "schema": "workflowmax_schema_name"
},
"auth":{
    "client_access":{
    "client_id": "your_workflowmax_client_id",
    "client_secret": "your_workflowmax_client_secret"
    }
}
}
content_copy

Auth parameters

Name	Description
`client_access.client_id`	Your WorkflowMax Client ID.
`client_access.client_secret`	Your WorkflowMax Client secret.

By using the or the Fivetran dashboard.

Wrike Lite

Request

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

{
   "service": "wrike",
   "group_id": "target_group_id",
   "config": {
      "schema": "wrike_schema_name",
      "sub_domain": "your_wrike_subdomain"
   },
   "auth":{
      "client_access":{
         "client_id": "your_wrike_client_id",
         "client_secret": "your_wrike_client_secret"
      }
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`sub_domain`	Your Wrike Subdomain.
`client_id`	Your Wrike Client ID.
`client_secret`	Your Wrike Client secret.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: client_id and client_secret.
By using the or the Fivetran dashboard.

Xero

Request

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

{
    "service": "xero",
    "group_id": "target_group_id",
    "config": {
        "schema": "xero_schema",
        "client_id": "xero_client_id",
        "client_secret": "xero_client_secret"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	Your Xero Client ID.
`client_secret`	Your Xero Client Secret.
`use_webhooks`	Set to true if you want to configure webhooks
`webhook_key`	Your webhook key. Required if `use_webhooks` is true.
`webhook_url`	(ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO.

Authorization

This connector type can only be authorized by using the or the Fivetran dashboard.

Xray Lite Private Preview

Request

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

{
   "service": "xray",
   "group_id": "xray_group_id",
   "config": {
      "schema": "xray_schema_name",
      "client_id": "client_id",
      "client_secret": "client_secret"
   }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	Your Xray Client ID.
`client_secret`	Your Xray Client Secret.

Authorization

There are two ways to authorize this connector type:

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

YouTube Analytics

Request

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

{
    "service": "youtube_analytics",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_youtube_analytics",
        "content_owner_id": "content_owner_id"
    }
}
content_copy

Config parameters

Name	Description	Possible Values
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`content_owner_id`	Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.

Authorization

There are two ways to authorize this connector type:

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

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

{
    "service": "youtube_analytics",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_youtube_analytics",
        "content_owner_id": "content_owner_id"
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy

Auth parameters

Name	Description
`client_id`	`Client ID` of your YouTube Analytics client application.
`client_secret`	`Client Secret` of your YouTube 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.

By using the or the Fivetran dashboard.

Zendesk Chat

Request

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

{
    "service": "zendesk_chat",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_zendesk_chat",
        "subdomain": "zendesk_domain",
        "client_id": "test_client_id",
        "client_secret": "test_client_secret"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`subdomain`	Your Zendesk domain.
`client_id`	Your Zendesk client ID.
`client_secret`	Your Zendesk client secret.

Authorization

There are two ways to authorize this connector type:

By specifying a value for access_token in the auth section.
POST https://api.fivetran.com/v1/connectors
```
{
    "service": "zendesk_chat",
    "group_id": "target_group_id",
    "config": {
            "schema": "zendesk_chat"
        },
    "auth": {
        "access_token": "my_access_token"
    }
}
content_copy
```
Auth parameters
Name Description
access_token The long-lived Access token carries the information necessary to access API resources.
By using the or through the Fivetran dashboard.

Zendesk Sell

Request

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

{
    "service": "zendesk_sell",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_zendesk_sell"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying a value for access_token in the auth section.
POST https://api.fivetran.com/v1/connectors
```
{
    "service": "zendesk_sell",
    "group_id": "target_group_id",
    "config": {
            "schema": "zendesk_sell"
        },
    "auth": {
        "access_token": "my_access_token"
    }
}
content_copy
```
Auth parameters
Name Description
access_token The long-lived Access token carries the information necessary to access API resources.
See for instructions to generate the access_token.
By using the or through the Fivetran dashboard.

Zendesk Sunshine

Request

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

{
    "service": "zendesk_sunshine",
    "group_id": "target_group_id",
    "config": {
        "schema": "zendesk_sunshine",
        "domain": "domain",
        "email": "email",
        "api_token": "api_token"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`domain`	Zendesk domain.
`email`	Zendesk email.
`api_token`	Zendesk API tokens are auto-generated passwords in the Support admin interface.

See for instructions to generate the api_token.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: domain, email and api_token.
By using the or the Fivetran dashboard.

Zendesk Support

Request

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

{
    "service": "zendesk",
    "group_id": "target_group_id",
    "config": {
        "schema": "zendesk",
        "domain": "domain",
        "email": "email",
        "api_token": "api_token"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`domain`	Zendesk domain.
`email`	Zendesk email.
`api_token`	Zendesk API tokens are auto-generated passwords in the Support admin interface.

See for instructions to generate the api_token.

Authorization

There are three ways to authorize this connector type:

By specifying the values for the following fields in the request: domain, email and api_token.
By specifying a value for access_token in the auth section.
POST https://api.fivetran.com/v1/connectors
```
{
    "service": "zendesk",
    "group_id": "target_group_id",
    "config": {
            "schema": "zendesk"
        },
    "auth": {
        "access_token": "my_access_token"
    }
}
content_copy
```
Auth parameters
Name Description
access_token The long-lived Access token carries the information necessary to access API resources.
By using the or the Fivetran dashboard.

The following example will allow you to configure the Zendesk API usage limit of an existing connector.

Request

PATCH https://api.fivetran.com/v1/connectors/{connector_id}

{
    "config": {
        "api_usage": 50.0
    }
}
content_copy

Path parameters

Name	Description
`connector_id`	The unique identifier for the connector.

Config parameters

Name	Description
`api_usage`	The maximum allowed API usage in percentage. For example, `50.0`.

Zoho CRM

Request

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

{
    "service": "zoho_crm",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_zoho",
        "data_center": "data_center"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`data_center`	Data center of the Zoho CRM account.

Authorization

There are two ways to authorize this connector type:

By specifying the values for client_access and refresh_token in the auth section.
POST api.fivetran.com/v1/connectors
```
{
    "service": "zoho",
        "group_id": "target_group_id",
    "config": {
      "schema": "test_zoho",
      "data_center": "data_center"
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}
content_copy
```
Auth parameters
| Name | Description | |---|---| | client_id | Client ID of your Zoho client application. | | client_secret | Client Secret of your Zoho client application. | | refresh_token | The long-lived Refresh token, along with the client_id and client_secret parameters, carries the information necessary to get a new access token for API resources. |
By using the or through the Fivetran dashboard.

Zoom Lite Private Preview

Request

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

{
   "service": "zoom",
   "group_id": "target_group_id",
   "config": {
      "schema": "zoom_schema_name"
   }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following parameters in the auth section: client_access, refresh_token, and access_token.

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

{
   "service": "zoom",
   "group_id": "target_group_id",
   "config": {
      "schema": "freshbooks_schema_name"
   },
   "auth": {
       "client_access": {
           "client_id": "zoom_client_id",
           "client_secret": "zoom_client_secret"
       },
       "refresh_token": "zoom_refresh_token",
       "access_token": "zoom_access_token"
   }
}

content_copy

Auth parameters

Name	Description
`client_id`	Your Zoom client ID.
`client_secret`	Your Zoom client Secret.
`refresh_token`	Your Zoom refresh token.
`access_token`	Your Zoom access token.

By using the or the Fivetran dashboard.

Zuora

Request

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

{
    "service": "zuora",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_zuora",
        "client_id": "zuora_client_id",
        "client_secret": "zuora_client_secret",
        "is_multi_entity_feature_enabled": true,
        "entity_id": "zuora_entity_id"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	Zuora Client ID.
`client_secret`	Zuora Client Secret.
`is_multi_entity_feature_enabled`	Set to `true` if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to `false`.
`entity_id`	If `is_multi_entity_feature_enabled` is `true`, then it's `EntityId`.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username, password and unique_id.
By using the or the Fivetran dashboard.

Zuora Sandbox

Request

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

{
    "service": "zuora_sandbox",
    "group_id": "target_group_id",
    "config": {
        "schema": "test_zuora",
        "client_id": "zuora_client_id",
        "client_secret": "zuora_client_secret",
        "is_multi_entity_feature_enabled": true,
        "entity_id": "zuora_entity_id",
        "environment": "zuora_sandbox_environment"
    }
}
content_copy

Config parameters

Name	Description
`schema`	The connector schema name has to be unique within the group (destination). Required for connector creation.
`client_id`	Zuora Client ID.
`client_secret`	Zuora Client Secret.
`is_multi_entity_feature_enabled`	Set to `true` if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to `false`.
`entity_id`	If `is_multi_entity_feature_enabled` is `true`, then it's `EntityId`.
`environment`	Zuora Sandbox Environment. This accepts either of the two values `Sandbox` or `Central Sandbox` based on your subscription. The default environment is `Sandbox`.

Authorization

There are two ways to authorize this connector type:

By specifying the values for the following fields in the request: username, password and unique_id.
By using the or the Fivetran dashboard.