fivetran 1.6.0, Mar 25 25

fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran

fivetran.getConnector

Explore with Pulumi AI

fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fivetran from "@pulumi/fivetran";

const connector = fivetran.getConnector({
    id: "anonymous_mystery",
});

import pulumi
import pulumi_fivetran as fivetran

connector = fivetran.get_connector(id="anonymous_mystery")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fivetran/fivetran"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fivetran.LookupConnector(ctx, &fivetran.LookupConnectorArgs{
			Id: "anonymous_mystery",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fivetran = Pulumi.Fivetran;

return await Deployment.RunAsync(() => 
{
    var connector = Fivetran.GetConnector.Invoke(new()
    {
        Id = "anonymous_mystery",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.FivetranFunctions;
import com.pulumi.fivetran.inputs.GetConnectorArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var connector = FivetranFunctions.getConnector(GetConnectorArgs.builder()
            .id("anonymous_mystery")
            .build());

    }
}

variables:
  connector:
    fn::invoke:
      function: fivetran:getConnector
      arguments:
        id: anonymous_mystery

Using getConnector

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConnector(args: GetConnectorArgs, opts?: InvokeOptions): Promise<GetConnectorResult>
function getConnectorOutput(args: GetConnectorOutputArgs, opts?: InvokeOptions): Output<GetConnectorResult>

def get_connector(config: Optional[GetConnectorConfig] = None,
                  destination_schema: Optional[GetConnectorDestinationSchema] = None,
                  id: Optional[str] = None,
                  status: Optional[GetConnectorStatus] = None,
                  opts: Optional[InvokeOptions] = None) -> GetConnectorResult
def get_connector_output(config: Optional[pulumi.Input[GetConnectorConfigArgs]] = None,
                  destination_schema: Optional[pulumi.Input[GetConnectorDestinationSchemaArgs]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  status: Optional[pulumi.Input[GetConnectorStatusArgs]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetConnectorResult]

func LookupConnector(ctx *Context, args *LookupConnectorArgs, opts ...InvokeOption) (*LookupConnectorResult, error)
func LookupConnectorOutput(ctx *Context, args *LookupConnectorOutputArgs, opts ...InvokeOption) LookupConnectorResultOutput

> Note: This function is named LookupConnector in the Go SDK.

public static class GetConnector 
{
    public static Task<GetConnectorResult> InvokeAsync(GetConnectorArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectorResult> Invoke(GetConnectorInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
public static Output<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)

fn::invoke:
  function: fivetran:index/getConnector:getConnector
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Config GetConnectorConfig
DestinationSchema GetConnectorDestinationSchema
Status GetConnectorStatus

Id string
Config GetConnectorConfig
DestinationSchema GetConnectorDestinationSchema
Status GetConnectorStatus

id String
config GetConnectorConfig
destinationSchema GetConnectorDestinationSchema
status GetConnectorStatus

id string
config GetConnectorConfig
destinationSchema GetConnectorDestinationSchema
status GetConnectorStatus

id str
config GetConnectorConfig
destination_schema GetConnectorDestinationSchema
status GetConnectorStatus

id String
config Property Map
destinationSchema Property Map
status Property Map

getConnector Result

The following output properties are available:

ConnectedBy string
CreatedAt string
DailySyncTime string
DataDelaySensitivity string
DataDelayThreshold double
FailedAt string
GroupId string
HybridDeploymentAgentId string
Id string
Name string
NetworkingMethod string
PauseAfterTrial bool
Paused bool
PrivateLinkId string
ProxyAgentId string
ScheduleType string
Service string
ServiceVersion string
SucceededAt string
SyncFrequency double
Config GetConnectorConfig
DestinationSchema GetConnectorDestinationSchema
Status GetConnectorStatus

ConnectedBy string
CreatedAt string
DailySyncTime string
DataDelaySensitivity string
DataDelayThreshold float64
FailedAt string
GroupId string
HybridDeploymentAgentId string
Id string
Name string
NetworkingMethod string
PauseAfterTrial bool
Paused bool
PrivateLinkId string
ProxyAgentId string
ScheduleType string
Service string
ServiceVersion string
SucceededAt string
SyncFrequency float64
Config GetConnectorConfig
DestinationSchema GetConnectorDestinationSchema
Status GetConnectorStatus

connectedBy String
createdAt String
dailySyncTime String
dataDelaySensitivity String
dataDelayThreshold Double
failedAt String
groupId String
hybridDeploymentAgentId String
id String
name String
networkingMethod String
pauseAfterTrial Boolean
paused Boolean
privateLinkId String
proxyAgentId String
scheduleType String
service String
serviceVersion String
succeededAt String
syncFrequency Double
config GetConnectorConfig
destinationSchema GetConnectorDestinationSchema
status GetConnectorStatus

connectedBy string
createdAt string
dailySyncTime string
dataDelaySensitivity string
dataDelayThreshold number
failedAt string
groupId string
hybridDeploymentAgentId string
id string
name string
networkingMethod string
pauseAfterTrial boolean
paused boolean
privateLinkId string
proxyAgentId string
scheduleType string
service string
serviceVersion string
succeededAt string
syncFrequency number
config GetConnectorConfig
destinationSchema GetConnectorDestinationSchema
status GetConnectorStatus

connected_by str
created_at str
daily_sync_time str
data_delay_sensitivity str
data_delay_threshold float
failed_at str
group_id str
hybrid_deployment_agent_id str
id str
name str
networking_method str
pause_after_trial bool
paused bool
private_link_id str
proxy_agent_id str
schedule_type str
service str
service_version str
succeeded_at str
sync_frequency float
config GetConnectorConfig
destination_schema GetConnectorDestinationSchema
status GetConnectorStatus

connectedBy String
createdAt String
dailySyncTime String
dataDelaySensitivity String
dataDelayThreshold Number
failedAt String
groupId String
hybridDeploymentAgentId String
id String
name String
networkingMethod String
pauseAfterTrial Boolean
paused Boolean
privateLinkId String
proxyAgentId String
scheduleType String
service String
serviceVersion String
succeededAt String
syncFrequency Number
config Property Map
destinationSchema Property Map
status Property Map

Supporting Types

GetConnectorConfig

AbsConnectionMethod string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection method
AbsConnectionString string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection string. - Service braze: Connection String
AbsContainerAddress string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container address
AbsContainerName string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container name. - Service braze: Container Name
AbsHostIp string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage host IP
AbsHostUser string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage username
AbsPrefix string: Field usage depends on service value: - Service braze: Prefix
AbsPublicKey string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage public key
AcademyId string: Field usage depends on service value: - Service workramp: Your WorkRamp academy ID.
AccessId string: Field usage depends on service value: - Service planful: Your Planful access ID.
AccessKey string: Field usage depends on service value: - Service gainsight_customer_success: The access key for API authentication. - Service gongio: Your Gongio Access key. - Service line_ads: Your LINE Ads access key. - Service planful: Your Planful access key. - Service retailnext: Your RetailNext access key.
AccessKeyId string: Field usage depends on service value: - Service appsflyer: Your AWS access key ID. - Service aws_cost_report: Access Key ID - Service checkout: Your Checkout.com access key ID. - Service cloudtalk: Your CloudTalk Access Key ID. - Service nice: Your NICE access key ID. - Service s3: Access Key ID - Service wasabi_cloud_storage: Access Key ID
AccessKeySecret string: Field usage depends on service value: - Service aws_cost_report: Access Key Secret - Service checkout: Your Checkout.com access key secret. - Service cloudtalk: Your CloudTalk Access Key Secret. - Service gongio: Your Gongio Access Key Secret. - Service nice: Your NICE access key secret. - Service s3: Access Key Secret - Service wasabi_cloud_storage: Access Key Secret
AccessToken string: Field usage depends on service value: - Service 7shifts: Your 7shifts access token. - Service attio: Your Attio bearer token - Service big_commerce: API access token of your store. - Service bitly: Your Bitly access token. - Service calabrio: Your Calabrio access token. - Service coupa: Your Coupa access token fetched using client_id and client_secret - Service deputy: Your Deputy API access token. - Service getfeedback: Your GetFeedback Access token. - Service gocardless: Your GoCardless API token. - Service ironclad: Your Ironclad access token. - Service khoros_marketing: Your Khoros Marketing access token. - Service kustomer: Your Kustomer API key. - Service lattice: Your Lattice API access token. - Service launchdarkly: Your LaunchDarkly access token. - Service leap_crm: Your Leap CRM access token. - Service nylas: Your Nylas access_token. - Service planhat: Your Planhat access token. - Service rollbar: Your Rollbar Access Token. - Service samsara: Your Samsara API token. - Service slab: Your Slab API key. - Service stripe: The Stripe API Restricted Key - Service stripe_test: The Stripe API Restricted Key - Service talkwalker: Your Talkwalker access token. - Service workable: Your Workable Access Token. - Service workramp: Your WorkRamp access token.
AccessType string: Field usage depends on service value: - Service share_point: Access Type
Account string: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Account ID. - Service ordway: Your Ordway account type.
AccountAccessToken string: Field usage depends on service value: - Service rollbar: Your Rollbar account access token.
AccountId string: Field usage depends on service value: - Service appcues: Your Appcues Account ID. - Service brightcove: Your Brightcove account ID. - Service cin7core: Your Cin7 Core account ID. - Service dear: Your Dear Account ID. - Service harvest: Your Harvest Account ID. - Service optimizely: Your Optimizely account ID. - Service rokt: Your Rokt account ID. - Service udemy_business: Your Udemy Business account ID.
AccountIds List<string>: Field usage depends on service value: - Service taboola: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
AccountKey string: Field usage depends on service value: - Service cosmos: The read-only primary or secondary account key for the database account. Required for the ACCOUNT_KEY data access method. - Service simplesat: Your Simplesat account key.
AccountName string: Field usage depends on service value: - Service eventsforce: Your Eventsforce account name. - Service freshdesk_contact_center: Your Freshdesk Contact Center account name. - Service happyfox: Your HappyFox account name. - Service maxio_saasoptics: Your Maxio SaaSOptics account name. - Service talkdesk: Your Talkdesk Account Name. - Service udemy_business: Your Udemy Business account name.
AccountPlan string: Field usage depends on service value: - Service tymeshift: Your Tymeshift account plan.
AccountRegion string: Field usage depends on service value: - Service iterable: If your Iterable account URL starts with https://app.eu.iterable.com then provide EU else US
AccountSid string: Field usage depends on service value: - Service fone_dynamics: Your Fone Dynamics account SID.
AccountSyncMode string: Field usage depends on service value: - Service itunes_connect: Account Sync Mode
AccountToken string: Field usage depends on service value: - Service konnect_insights: Your Konnect Insights Account Token.
AccountType string: Field usage depends on service value: - Service freightview: Your Freightview Account Type.
Accounts List<string>: Field usage depends on service value: - Service bingads: Specific accounts to sync. Must be populated if syncMode is set to SpecificAccounts. - Service facebook: List of accounts of which connector will sync the data. - Service facebook_ad_account: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service facebook_ads: List of accounts of which connector will sync the data. - Service google_ads: The list of Account IDs to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service google_analytics: The list of specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_4: The list of specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_analytics_mcf: Specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_search_ads_360: Specific accounts to sync. Must be populated if accountsSyncMode is set to SPECIFIC_ACCOUNTS. - Service instagram_business: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service itunes_connect: Accounts - Service linkedin_ads: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service spotify_ads: The list of Ad Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service tiktok_ads: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twilio: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
AccountsRedditAds List<GetConnectorConfigAccountsRedditAd>: Field usage depends on service value: - Service reddit_ads: Accounts
AccountsSyncMode string: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all accounts or specific.
ActionBreakdowns List<string>: Field usage depends on service value: - Service facebook: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
ActionReportTime string: Field usage depends on service value: - Service facebook: The report time of action stats. Possible action_report time values.
AdAnalytics string: Field usage depends on service value: - Service linkedin_ads: Whether to sync all analytic reports or specific. Default value: AllReports
AdUnitView string: Field usage depends on service value: - Service double_click_publishers: Ad unit view for the report.
AdminApiKey string: Field usage depends on service value: - Service splitio: Your Split admin api key.
AdobeAnalyticsConfigurations List<GetConnectorConfigAdobeAnalyticsConfiguration>: Field usage depends on service value: - Service adobe_analytics: 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.
Advertisables List<string>: Field usage depends on service value: - Service adroll: Specific advertisables to sync. Must be populated if sync_mode is set to SpecificAdvertisables.
Advertisers List<string>: Field usage depends on service value: - Service google_display_and_video_360: The list of advertisers to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service google_search_ads_360: Specific advertisers to sync. Must be populated if advertisersSyncMode is set to SPECIFIC_ADVERTISERS. - Service pinterest_ads: Specific Advertisers to sync. Must be populated if sync_mode is set to SpecificAdvertisers.
AdvertisersIds List<string>: Field usage depends on service value: - Service yahoo_gemini: Specific Advertiser IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
AdvertisersSyncMode string: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all or specific advertisers.
AdvertisersWithSeats List<string>: Field usage depends on service value: - Service yahoo_dsp: Specific Advertisers to sync. Must be populated if sync_mode_advertiser is set to SPECIFIC_ADVERTISERS. Pay attention to the format: AdvertiserId:SeatId
AgentConfigMethod string
AgentHost string: Field usage depends on service value: - Service db2i_hva: The agent host. - Service db2i_sap_hva: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service oracle_hva: The host of the agent. This is the same as database host, since the agent must be installed in the same machine as source database. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service sql_server_hva: The host address of the machine running the agent. Often the same as the DB host. - Service sql_server_sap_ecc_hva: The host address of the machine running the agent. Often the same as the DB host.
AgentId string: Field usage depends on service value: - Service phoenix_ads: Your Phoenix Ads Agent ID.
AgentOraHome string: Field usage depends on service value: - Service oracle_hva: The home directory of the Oracle database. - Service oracle_sap_hva: The home directory of the Oracle database.
AgentPassword string: Field usage depends on service value: - Service db2i_hva: The agent password. - Service db2i_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_b1: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_hva: The agent user's password. It should have a minimum length of 10 characters. - Service oracle_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_sap_hva_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service sql_server_hva: The password for the agent user. - Service sql_server_sap_ecc_hva: The password for the agent user.
AgentPort double: Field usage depends on service value: - Service db2i_hva: The agent port. - Service db2i_sap_hva: The port number of the agent. - Service hana_sap_hva_b1: The port number of the agent. - Service hana_sap_hva_ecc: The port number of the agent. - Service hana_sap_hva_ecc_netweaver: The port number of the agent. - Service hana_sap_hva_s4: The port number of the agent. - Service hana_sap_hva_s4_netweaver: The port number of the agent. - Service oracle_hva: The port number of the agent. - Service oracle_sap_hva: The port number of the agent. - Service oracle_sap_hva_netweaver: The port number of the agent. - Service sql_server_hva: The port that the agent has open for Fivetran's connection. Default value is 4343. - Service sql_server_sap_ecc_hva: The port that the agent has open for Fivetran's connection. Default value is 4343.
AgentPublicCert string: Field usage depends on service value: - Service db2i_hva: The public certificate for the agent. - Service db2i_sap_hva: The agent public certificate. - Service hana_sap_hva_b1: The agent public certificate. - Service hana_sap_hva_ecc: The agent public certificate. - Service hana_sap_hva_ecc_netweaver: The agent public certificate. - Service hana_sap_hva_s4: The agent public certificate. - Service hana_sap_hva_s4_netweaver: The agent public certificate. - Service oracle_hva: The agent public certificate. - Service oracle_sap_hva: The agent public certificate. - Service oracle_sap_hva_netweaver: The agent public certificate. - Service sql_server_hva: The public certificate generated by the agent. - Service sql_server_sap_ecc_hva: The public certificate generated by the agent.
AgentUser string: Field usage depends on service value: - Service db2i_hva: The agent user name. - Service db2i_sap_hva: The agent's user. - Service hana_sap_hva_b1: The agent's user. - Service hana_sap_hva_ecc: The agent's user. - Service hana_sap_hva_ecc_netweaver: The agent's user. - Service hana_sap_hva_s4: The agent's user. - Service hana_sap_hva_s4_netweaver: The agent's user. - Service oracle_hva: The agent's user. - Service oracle_sap_hva: The agent's user. - Service oracle_sap_hva_netweaver: The agent's user. - Service sql_server_hva: The agent's username. - Service sql_server_sap_ecc_hva: The agent's username.
Aggregation string: Field usage depends on service value: - Service facebook: Options to select aggregation duration. Possible aggregation values.
AgreementGrantToken string: Field usage depends on service value: - Service economic: Your E-conomic X-AgreementGrantToken goes here.
AlwaysEncrypted bool: Field usage depends on service value: - Service aurora: Require TLS through Tunnel - Service aurora_postgres: Require TLS through Tunnel - Service azure_cosmos_for_mongo: Require TLS - Service azure_postgres: Require TLS through Tunnel - Service azure_sql_db: Require TLS through Tunnel. - Service azure_sql_managed_db: Require TLS. - Service clarity: Require TLS through Tunnel. - Service cockroachdb: Require TLS - Service db2i_hva: Require TLS through Tunnel - Service db2i_sap_hva: Require TLS through Tunnel - Service documentdb: Require TLS encryption. - Service dynamics_365_fo: Require TLS through Tunnel. - Service ehr: Require TLS through Tunnel. - Service elastic_cloud: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service es_self_hosted: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service google_cloud_mysql: Require TLS through Tunnel - Service google_cloud_postgresql: Require TLS through Tunnel - Service google_cloud_sqlserver: Require TLS. - Service heroku_postgres: Require TLS through Tunnel - Service magento_mysql: Require TLS through Tunnel - Service magento_mysql_rds: Require TLS through Tunnel - Service maria: Require TLS through Tunnel - Service maria_azure: Require TLS through Tunnel - Service maria_rds: Require TLS through Tunnel - Service mongo: Require TLS - Service mongo_sharded: Require TLS through Tunnel - Service mysql: Require TLS through Tunnel - Service mysql_azure: Require TLS through Tunnel - Service mysql_rds: Require TLS through Tunnel - Service opendistro: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service opensearch: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service oracle: Require TLS through Tunnel - Service oracle_ebs: Require TLS through Tunnel - Service oracle_hva: Require TLS through Tunnel - Service oracle_rac: Require TLS through Tunnel - Service oracle_rds: Require TLS through Tunnel - Service oracle_sap_hva: Require TLS through Tunnel - Service oracle_sap_hva_netweaver: Require TLS. - Service postgres: Require TLS through Tunnel - Service postgres_rds: Require TLS through Tunnel - Service sql_server: Require TLS. - Service sql_server_hva: Require TLS. - Service sql_server_rds: Require TLS. - Service sql_server_sap_ecc_hva: Require TLS.
Api string: Field usage depends on service value: - Service freshsuccess: Set this parameter to api.
ApiAccessToken string: Field usage depends on service value: - Service flywheel_digital: Your Flywheel Digital API access token. - Service shopify: API access token of your custom app. - Service square: The Square API access token of your application.
ApiEnvironment string: Field usage depends on service value: - Service afterpay: Your Afterpay API environment.
ApiId string: Field usage depends on service value: - Service aircall: Your Aircall API ID.
ApiKey string: Field usage depends on service value: - Service 15five: Your 15five API key. - Service 360learning: Your 360Learning API Key. - Service 6sense: Your 6sense API Key. - Service acculynx: Your Acculynx API key. - Service activecampaign: Your ActiveCampaign API key. - Service affinity: Your Affinity API key. - Service airtable: API key of the Airtable account. - Service algolia: Your Algolia API key. - Service anvyl: Your Anvyl API key. - Service appcues: Your Appcues API key. - Service ashby: Your Ashby API key. - Service assembled: Your Assembled API key. - Service atlassian_jira_align: Your Jira Align API key. - Service atlassian_ops_genie: Your Opsgenie API key - Service attentive: Your Attentive API key. - Service aumni: Your Aumni API key. - Service avantlink: Your AvantLink API key. - Service ballotready: Your BallotReady API token. - Service bamboohr: Your API Key. - Service bazaarvoice: Your Bazaarvoice API key. - Service betterworks: Your Betterworks API key. - Service bigmarker: Your BigMarker API key. - Service bizzabo: Your Bizzabo API key. - Service brave_ads: Your Brave Ads API key - Service braze: Your Braze API Key. - Service brevo: Your Brevo API key. - Service bubble: Your Bubble API token. - Service buildium: Your Buildium private API key. - Service callrail: Your CallRail API key. - Service campaignmonitor: Your Campaign Monitor API key. - Service canny: Your Canny API key. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 API key. - Service chargebee_product_catalog_2: Your Chargebee API key. - Service chartmogul: Your ChartMogul API key. - Service chorusai: Your Chorus API key. - Service churnkey: Your Churnkey API Key. - Service churnzero: Your ChurnZero API key. - Service cimis: Your Cimis API key. - Service circleci: Your CircleCI API Key. - Service clickup: Your ClickUp API key. - Service clockify: Your Clockify API key. - Service clockodo: Your Clockodo API key. - Service close: Your Close API key. - Service cloudbeds: Your Cloudbeds API key. - Service clubspeed: Your Clubspeed API key. - Service coassemble: Your Coassemble API key. - Service codefresh: Your Codefresh API Key. - Service column: Your Column API key. - Service concord: Your Concord API key. - Service confluent_cloud: API Key - Service contrast_security: Your Contrast Security API Key. - Service copper: Your Copper API key. - Service coupa: Your Coupa API key. - Service datadog: Your Datadog API key. - Service dbt_cloud: Your dbt Cloud service token. - Service dcl_logistics: Your DCL Logistics API key. - Service delighted: API Key for your Delighted account - Service destini: Your Destini API Key. - Service donus: Your Donus API key. - Service doorloop: Your DoorLoop API key. - Service drata: Your Drata API Key. - Service dropbox_sign: Your Dropbox Sign API key. - Service duoplane: Your Duoplane API key. - Service easypost: Your EasyPost API Key. - Service electronic_tenant_solutions: Your Electronic Tenant Solutions API key. - Service eventsforce: Your Eventsforce API secret key. - Service everflow: Your Everflow API key. - Service everhour: Your Everhour API Token. - Service expensein: Your ExpenseIn API key. - Service factorial: Your Factorial API key. - Service firehydrant: Your FireHydrant API key. - Service float: Your Float API key. - Service forj_community: Your Forj Community API key. - Service fourkites: Your FourKites API key. - Service freightview: Your Freightview API key. - Service freshdesk: Your Freshdesk API Key. - Service freshdesk_contact_center: Your Freshdesk Contact Center API key. - Service freshsales: Your Freshsales API key. - Service freshservice: Your Freshservice API Key. - Service freshsuccess: Your Freshsuccess API key. - Service freshteam: Your Freshteam API key. - Service friendbuy: Your Friendbuy API key. - Service fullstory: Your Fullstory API key. - Service gainsight_product_experience: Your Gainsight Product Experience API key. - Service gem: Your Gem API key. - Service gorgias: Your Gorgias API key. - Service greenhouse: Your Greenhouse API key. - Service grepsr: Your Grepsr API Key. - Service grin: Your Grin API key. - Service happyfox: Your HappyFox API key. - Service height: Your Height API key. - Service helpshift: Your Helpshift API Key. - Service incidentio: Your incident.io API key. - Service infobip: Your Infobip API key. - Service insightly: Your Insightly API key. - Service integrate: Your Integrate API key. - Service invoiced: Your Invoiced API key. - Service iterable: Your Iterable API key. - Service ivanti: Your Ivanti API Key. - Service jotform: Your Jotform API key. - Service justcall: Your JustCall API key. - Service katana: Your Katana API key. - Service kevel: Your Kevel API key. - Service keypay: Your KeyPay API key. - Service kisi: Your Kisi API key. - Service klaviyo: Your Klaviyo API key. - Service learnupon: Your Learnupon API key. - Service lemlist: Your Lemlist API key. - Service lever: Your Lever API key. - Service liftoff: Your Liftoff API key. - Service linear: Your Linear API key. - Service linksquares: Your LinkSquares API key. - Service lob: Your Lob API key. - Service loop: Your Loop API key. - Service lucca: Your Lucca API key. - Service luma: Your Luma API key. - Service maileon: Your Maileon API key. - Service mailgun: Your Mailgun API key. - Service mailjet: Your Mailjet API key. - Service malomo: Your Malomo API key. - Service mambu: Your Mambu API key. - Service mandrill: Your Mandrill API key. - Service maxio_chargify: Enter Your API Key. - Service messagebird: Your MessageBird API key. - Service mountain: Your MNTN API key. - Service myosh: Your myosh API key. - Service okendo: Your Okendo API key. - Service ometria: Your Ometria API Key. - Service oncehub: Your OnceHub API key. - Service ordway: Your Ordway API key. - Service ortto: Your Ortto API key. - Service pagerduty: Your PagerDuty API key. - Service pandadoc: Your PandaDoc API key. - Service papershift: Your Papershift API Key - Service partnerize: Your Partnerize user API key. - Service persona: Your Persona API key. - Service picqer: Your Picqer API key. - Service pigment: Your Pigment API key. - Service pinpoint: Your Pinpoint API key. - Service pipe17: The Pipe17 API key. - Service placerai: Your Placer.ai API key. - Service playvox: Your Playvox API Key. - Service posthog: Your PostHog API key. - Service prive: Your Prive API key. - Service prosperstack: Your ProsperStack API key. - Service qualaroo: Your Qualaroo API Key. - Service quorum: Your Quorum API key. - Service rebound_returns: Your ReBound Returns API key. - Service recurly: The Recurly API key. - Service replyio: Your Reply API key. - Service revenuecat: Your RevenueCat API key. - Service reviewsio: Your REVIEWS.io API key. - Service revops: Your RevOps bearer token. - Service ricochet360: Your Ricochet360 API key. - Service ringover: Your Ringover API key. - Service rippling: Your Rippling API key. - Service rocketlane: Your Rocketlane API key. - Service rootly: Your Rootly API key. - Service ruddr: Your Ruddr API key. - Service safebase: Your SafeBase API key. - Service sage_hr: Your Sage HR API key. - Service sailthru: The Sailthru API key. - Service salsify: Your Salsify API Key. - Service security_journey: Your Security Journey API key. - Service sendgrid: The SendGrid API key. - Service sendinblue: Your Sendinblue API key. - Service shortcut: Your Shortcut API token. - Service shortio: Your Short.io API key. - Service simplesat: Your Simplesat API key. - Service sistrix: Your SISTRIX API key. - Service skilljar: Your Skilljar API key. - Service smartwaiver: Your Smartwaiver API key. - Service snyk: Your Snyk API key. - Service sonarqube: Your Sonarqube API key. - Service sparkpost: Your SparkPost API key. - Service squarespace: Your Squarespace API key. - Service stackadapt: Your StackAdapt API key. - Service statuspage: Your Statuspage API Key. - Service stripe: Restricted API key - Service stripe_test: Restricted API key - Service subscript: Your Subscript API key. - Service survicate: Your Survicate API Key. - Service teads: Your Teads API key. - Service teamtailor: Your Teamtailor API key. - Service testrail: Your TestRail API key. - Service ticket_tailor: Your Ticket Tailor API key. - Service transcend: Your Transcend API key. - Service trello: Your TRELLO api key. - Service triple_whale: Your Triple Whale API key. - Service uppromote: Your UpPromote API key. - Service veeqo: Your Veeqo API key. - Service venminder: Your Venminder API key. - Service visit_by_ges: Your Visit by GES API key. - Service vitally: Your Vitally API key. - Service vonage: Your Vonage API Key. - Service vts: Your VTS API key. - Service webconnex: Your Webconnex API key. - Service wicked_reports: Your Wicked Reports API key. - Service workleap_officevibe: Your Workleap Officevibe API key. - Service xsolla: Your Xsolla API key. - Service yougov_sport: Your Yougov Sport API key. - Service zingtree: Your Zingtree API key. - Service zip: Your Zip API key.
ApiKeyApiSecret string: Field usage depends on service value: - Service revel: Your Revel Systems API Key and API Secret.
ApiKeys List<string>: Field usage depends on service value: - Service mandrill: Comma-separated list of API keys. Required if use_api_keys is set to true.
ApiPassword string: Field usage depends on service value: - Service duoplane: Your Duoplane API password.
ApiQuota double: Field usage depends on service value: - Service marketo: Allowed number of API requests to Marketo instance per day, the default value is 10000.
ApiReadAccessToken string: Field usage depends on service value: - Service the_movie_database: Your The Movie Database API read access token.
ApiRequestsPerMinute double: Field usage depends on service value: - Service qualtrics: Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
ApiSecret string: Field usage depends on service value: - Service confluent_cloud: API Secret - Service forj_community: Your Forj Community API secret. - Service friendbuy: Your Friendbuy API secret. - Service justcall: Your JustCall API secret. - Service liftoff: Your Liftoff API secret. - Service mixpanel: Mixpanel API Secret. - Service qualaroo: Your Qualaroo API Secret. - Service sailthru: The Sailthru API secret. - Service shareasale: Your ShareASale API secret. - Service vonage: Your Vonage API Secret.
ApiSecretKey string: Field usage depends on service value: - Service alchemer: Your Alchemer API Secret key.
ApiServer string: Field usage depends on service value: - Service sigma_computing_source: Your Sigma Computing api server.
ApiToken string: Field usage depends on service value: - Service aha: Your Aha! API key. - Service aircall: Your Aircall API Token. - Service appsflyer: API Token for AppsFlyer's PULL API. - Service awin: Your Awin API Token. - Service backbone_plm: Your Backbone PLM API token. - Service brex: Your Brex API token - Service buildkite: Your Buildkite API token. - Service buzzsprout: Your Buzzsprout API token. - Service centra: Your Centra API token. - Service chameleon: Your Chameleon API token. - Service clari: Your Clari API token. - Service cloudflare_analytics: Your Cloudflare Analytics API token. - Service confluence: The Confluence API token. - Service dixa: Your Dixa API token. - Service drip: Your Drip API Token. - Service factbird: Your Factbird API token. - Service fone_dynamics: Your Fone Dynamics API token. - Service fountain: Your Fountain API token. - Service g2: Your G2 API token. - Service gladly: Your Gladly API Token. - Service hibob: Your Hibob API token. - Service kandji: Your Kandji API token. - Service livechat: Your Livechat Access token. - Service livechat_partner: Your Livechat Partner API Token. - Service maxio_saasoptics: Your Maxio SaaSOptics API token. - Service megaphone: Your Megaphone API token. - Service missive: Your Missive API token. - Service mixmax: Mixmax API token. - Service okta: Your Okta API token. - Service ordway: Your Ordway API token. - Service packiyo: Your Packiyo API token. - Service pipedrive: (Optional)Your Pipedrive personal API token - Service pivotal_tracker: Pivotal Tracker API token. - Service postmark: Your Postmark account API token. - Service productive: Your Productive API token. - Service qualtrics: API token of the Qualtrics account. - Service rakutenadvertising: Your Rakuten Advertising API token. - Service recharge: The Recharge API token. - Service referralhero: Your Referralhero API token. - Service resource_management_by_smartsheet: Your Resource Management by Smartsheet API token. - Service retently: Your Retently API token. - Service reviewsai: Your REVIEWS.ai API token. - Service rundeck: Your Rundeck API token. - Service safetyculture: Your SafetyCulture API token. - Service sensor_tower: Your Sensor Tower API token. - Service sentry: Your Sentry auth token. - Service simplecast: Your Simplecast API token. - Service snyk: Your Snyk API token. - Service textus: Your TextUs API token. - Service toggl_track: Your Toggl Track API token - Service trello: Your TRELLO api token. - Service trisolute: Your Trisolute API token. - Service vwo: Your VWO API token. - Service web_scraper: Your Web Scraper API token. - Service zendesk: Zendesk API tokens are auto-generated passwords in the Support admin interface. - Service zendesk_sunshine: Zendesk API tokens are auto-generated passwords in the Support admin interface.
ApiType string
ApiUrl string: Field usage depends on service value: - Service braze: Your Braze API URL.
ApiUrlRegion string: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP API URL region.
ApiUsage string: Field usage depends on service value: - Service zendesk: Maximum Zendesk Api Usage allowed
ApiUserIdentifier string: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user identifier.
ApiUserSecret string: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user secret.
ApiUtilizationPercentage string: Field usage depends on service value: - Service kustomer: Api Utilization Percentage
ApiVersion string: Field usage depends on service value: - Service pardot: API Version
AppId string: Field usage depends on service value: - Service churnkey: Your Churnkey APP ID. - Service open_exchange_rates: Your Open Exchange Rates App Id. - Service rokt: Your Rokt app ID.
AppIds List<string>: Field usage depends on service value: - Service pendo: Specific App IDs to sync. Must be populated if sync_mode is set to SpecificAppIds.
AppIdsAppsflyers List<GetConnectorConfigAppIdsAppsflyer>: Field usage depends on service value: - Service appsflyer: * App ID(s)
AppKey string: Field usage depends on service value: - Service loopio: Your Loopio App Key. - Service servicetitan: Your ServiceTitan app key. - Service yotpo: Your Yotpo App Key
AppReference string: Field usage depends on service value: - Service brightpearl: Your Brightpearl app reference.
AppSecret string: Field usage depends on service value: - Service rokt: Your Rokt app secret.
AppSecretToken string
AppSpecificPassword string: Field usage depends on service value: - Service itunes_connect: Your app-specific password
AppSyncMode string: Field usage depends on service value: - Service itunes_connect: Whether to sync all apps or specific apps.
AppendFileOption string: Field usage depends on service value: - Service aws_cost_report: If you know that the source completely overwrites the same file with new data, you can append the changes instead of upserting based on filename and line number. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
ApplicationId string: Field usage depends on service value: - Service algolia: Your Algolia application ID. - Service xactly: Your Xactly Application ID.
ApplicationKey string: Field usage depends on service value: - Service cin7core: Your Cin7 Core application key. - Service datadog: Your Datadog application key. - Service dear: Your Dear Application key. - Service partnerize: Your Partnerize user application key.
Apps List<string>: Field usage depends on service value: - Service itunes_connect: Specific apps to sync. Must be populated if app_sync_mode is set to SpecificApps.
ArchiveLogFormat string: Field usage depends on service value: - Service sql_server_hva: Format for archive log file names - Service sql_server_sap_ecc_hva: Format for archive log file names
ArchiveLogPath string: Field usage depends on service value: - Service sql_server_hva: Directory where archive logs are located - Service sql_server_sap_ecc_hva: Directory where archive logs are located
ArchivePattern string: Field usage depends on service value: - Service aws_cost_report: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service azure_blob_storage: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service box: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service dropbox: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service email: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service ftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service gcs: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service google_drive: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service kinesis: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service s3: Files inside compressed archives with filenames matching this regular expression will be synced. - Service sftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service share_point: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service wasabi_cloud_storage: Files inside compressed archives with filenames matching this regular expression will be synced.
AreSoapCredentialsProvided bool: Field usage depends on service value: - Service marketo: Marketo SOAP credentials provided.
AsbIp string: Field usage depends on service value: - Service azure_service_bus: The IP address (or) the URL of ASB namespace
AsmOption bool: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using ASM on a non-RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you are using ASM on a non-RAC instance.
AsmOracleHome string: Field usage depends on service value: - Service oracle_hva: ASM Oracle Home path. - Service oracle_sap_hva: The Oracle ASM home directory.
AsmPassword string: Field usage depends on service value: - Service oracle_hva: ASM password. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user's password. Mandatory if use_oracle_rac or asm_option is set to true.
AsmTns string: Field usage depends on service value: - Service oracle_hva: ASM TNS. - Service oracle_sap_hva: ASM TNS.
AsmUser string: Field usage depends on service value: - Service oracle_hva: ASM user. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user. Mandatory if use_oracle_rac or asm_option is set to true.
AttributionWindow string: Field usage depends on service value: - Service amazon_ads: Time period used to attribute conversions based on clicks.
AttributionWindowSize string: Field usage depends on service value: - Service tiktok_ads: Rollback sync duration to capture conversions. Set this to your configured attribution window in TikTok Ads. The default value is 7 days.
Audience string: Field usage depends on service value: - Service auth0: Your Auth0 API audience.
Auth string: Field usage depends on service value: - Service databricks_db: Token-based authentication type - Service redshift_db: Password-based authentication type - Service snowflake_db: Password-based or key-based authentication type
AuthCode string: Field usage depends on service value: - Service happyfox: Your HappyFox auth code.
AuthEnvironment string: Field usage depends on service value: - Service younium: Your Younium auth environment.
AuthMethod string: Field usage depends on service value: - Service aurora_postgres: Database authentication method - Service azure_postgres: Database authentication method - Service azure_sql_db: Authentication Method. - Service azure_sql_managed_db: Authentication Method. - Service google_cloud_postgresql: Database authentication method - Service heroku_postgres: Database authentication method - Service postgres: Database authentication method - Service postgres_rds: Database authentication method - Service sql_server_hva: Authentication Method - Service sql_server_sap_ecc_hva: Authentication Method - Service webhooks: The authentication mechanism you want to use
AuthMode string: Field usage depends on service value: - Service anaplan: The Anaplan authentication method. - Service concur: The Authentication Mode used by SAP Concur. It can be PasswordGrant or CompanyLevel auth mode - Service github: Authorization type.
AuthToken string: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback auth token.
AuthType string: Field usage depends on service value: - Service airtable: Type of authentication being used by connector - Service aws_cost_report: Access approach - Service azure_service_bus: The authentication mode to access the topic - Service dynamics_365: Authentication mechanism. Either one of OAUTH2, or SERVICE_PRINCIPAL. Default value OAUTH2 - Service gcs: Authorization type. Required for storage bucket authentication. - Service google_sheets: The OAuth value must be specified for this type of authorization. - Service jira: Authorization type. - Service mixpanel: Authentication Method - Service pardot: Authenticate using OAuth or HTTP Basic - Service qualtrics: Type of authentication being used by connector - Service s3: Access approach - Service wasabi_cloud_storage: The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: ACCESS_KEY.
AuthUrlRegion string: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP auth grant URL region.
AuthenticationMethod string: Field usage depends on service value: - Service adobe_analytics: Authentication Method - Service elastic_cloud: The authentication method used to connect to your cluster. - Service es_self_hosted: The authentication method used to connect to your cluster. - Service opendistro: The authentication method used to connect to your cluster. - Service opensearch: The authentication method used to connect to your cluster. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud authentication method. - Service salesforce: (Optional) Authentication type (default value = STANDARD) - Service salesforce_sandbox: (Optional) Authentication type (default value = STANDARD)
AuthorizationMethod string
AwsRegionCode string: Field usage depends on service value: - Service dynamodb: The AWS region code for the DynamoDB instance, e.g. us-east-1.
BackintConfigurationPath string
BackintExecutablePath string
BackwardSyncLimit string: Field usage depends on service value: - Service zendesk: Limit of the Historical Sync Time for selected tables
BaseCurrency string: Field usage depends on service value: - Service open_exchange_rates: Your Open Exchange Rates Base Currency.
BaseDomain string: Field usage depends on service value: - Service freshteam: Your company's Freshteam base domain name (usually company.freshteam.com).
BaseId string: Field usage depends on service value: - Service airtable: ID of base in Airtable
BaseUrl string: Field usage depends on service value: - Service aha: Your Aha! subdomain. - Service akeneo: Your Akeneo base URL. - Service billing_platform: Your BillingPlatform subdomain. - Service boostr: Your Boostr base URL. - Service brex: Your Brex Base URL - Service centra: Your Centra base URL. - Service cornerstone: Your Cornerstone base URL. - Service culture_amp: Your Culture Amp base URL. - Service datadog: Your Datadog base url. - Service factbird: Your Factbird base url. - Service fillout: Your Fillout Base URL. - Service financial_force: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service freshsales: Your Freshsales product. - Service gongio: Your Gong API Base URL. - Service ironclad: Your Ironclad base url. - Service jotform: Your Jotform base URL. - Service mailgun: Your Mailgun base URL. - Service nice: Your NICE base URL. - Service ortto: Your Ortto base URL. Possible values: api, api.au, api.eu. - Service prisma_cloud: Your Prisma Cloud admin console URL. - Service salesforce: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service salesforce_sandbox: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service stickyio: Your sticky.io base URL . - Service veevavault: Your Veeva Vault base URL. - Service vitally: Your Vitally base URL.
BearerToken string: Field usage depends on service value: - Service ada: Your Ada API Access Token. - Service crowddev: Your crowd.dev Auth Token. - Service customerio: Your Customer.io App API Key. - Service freshchat: Your Freshchat API Token. - Service hopin: Your Hopin API key. - Service orbit: Your Orbit API Token. - Service productboard: Your Productboard API key. - Service smarthr: Your SmartHR access token. - Service sprout: Your Sprout Social API Access Token. - Service zenefits: Your Zenefits bearer token.
BlobSasUrl string: Field usage depends on service value: - Service webhooks: The blob SAS URL of your Azure container. Required if bucket_service is set to AZURE.
Blockchain string: Field usage depends on service value: - Service rarible: Your Rarible Blockchain.
BrandId string: Field usage depends on service value: - Service oracle_moat_analytics: Your Oracle Moat Analytics Brand ID.
Breakdowns List<string>: Field usage depends on service value: - Service facebook: List of breakdowns which connector will sync. Possible breakdowns values.
Bucket string: Field usage depends on service value: - Service appsflyer: Customer S3 Bucket - Service aws_cloudtrail: The AWS bucket name which is configured for AWS CloudTrail. - Service aws_cost_report: The S3 bucket name with the AWS Cost and Usage Report - Service aws_inventory: The AWS bucket name that is configured for AWS Config. - Service aws_lambda: S3 Bucket - Service cloudfront: The bucket name for CloudFront. - Service gcs: The name of the GCS bucket. - Service google_play: The Google Cloud Storage source bucket. - Service heap: The S3 bucket name. - Service kinesis: The name of the Kinesis bucket. - Service s3: The S3 bucket name. Required for connector creation. - Service segment: The name of the Segment bucket. Must be populated if sync_type is set to S3. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket name. Required for connector creation.
BucketName string: Field usage depends on service value: - Service adjust: Your AWS S3 or GCS bucket. - Service google_analytics_360: The name of the bucket. - Service google_analytics_4_export: The name of the bucket.
BucketService string: Field usage depends on service value: - Service webhooks: Whether to store the events in Fivetran's container service or your S3 bucket. Default value: Fivetran.
BusinessAccounts List<string>: Field usage depends on service value: - Service reddit_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
BusinessId string: Field usage depends on service value: - Service birdeye: Your Birdeye Business ID.
BusinessUnit string: Field usage depends on service value: - Service deposco: Your Deposco business unit.
BusinessUnitId string: Field usage depends on service value: - Service pardot: Business Unit Id
Catalog string: Field usage depends on service value: - Service databricks_db: catalog to sync
Certificate string: Field usage depends on service value: - Service anaplan: The contents of your PEM certificate file. Must be populated if auth_mode is set to Certificate. - Service qualtrics: Your Client Certificate - Service salesforce: Provide content of the .pem certificate (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .pem certificate (only when authentication_method = ADVANCED).
ClickAttributionWindow string: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on clicks. Possible click_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'click' action.
Client string
ClientCert string: Field usage depends on service value: - Service apache_kafka: Kafka client certificate. - Service heroku_kafka: Heroku Kafka client certificate. Required for TLS security protocol.
ClientCertKey string: Field usage depends on service value: - Service apache_kafka: Kafka client certificate key. - Service heroku_kafka: Heroku Kafka client certificate key. Required for TLS security protocol.
ClientHost string: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Host.
ClientId string: Field usage depends on service value: - Service acumatica: Your Acumatica client ID. - Service adobe_analytics: Client ID from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client ID. - Service adp_workforce_now: Your ADP Client ID. - Service akamai: Your Akamai client ID. - Service akeneo: Your Akeneo client ID. - Service auth0: Your Auth0 client ID. - Service autodesk_bim_360: Your Autodesk BIM 360 client ID. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Id - Service billing_platform: Your BillingPlatform client ID. - Service bing_webmaster_tools: Your Bing Webmaster Tools client ID. - Service brightcove: Your Brightcove client ID. - Service brightpearl: Your Brightpearl client ID. - Service buildium: Your Buildium API client ID. - Service canvas_by_instructure: Your Canvas by Instructure client ID. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure client ID. - Service castor_edc: Your Castor EDC client Id. - Service clazar: Your Clazar client ID. - Service cloudbeds: Your Cloudbeds client ID. - Service commercetools: Your commercetools client ID. - Service concur: The SAP Concur Client ID. - Service constant_contact: Your Constant Contact client ID. - Service cornerstone: Your Cornerstone client ID. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo Client ID. - Service criteo_retail_media: Your Criteo Retail Media client ID. - Service culture_amp: Your Culture Amp client ID. - Service cvent: Your Cvent client ID. - Service d2l_brightspace: Your D2L Brightspace client ID. - Service dialpad: Your Dialpad client ID. - Service ebay: Your eBay app ID. - Service exact_online: Your Exact Online client ID. - Service fillout: Your Fillout client ID. - Service flexport: The Flexport API Key. - Service formstack: Your Formstack client ID. - Service genesys: Your Genesys client ID. - Service hana_sap_hva_ecc_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hana_sap_hva_s4_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hilti_ontrack: Your Hilti On!Track client ID. - Service ilevel: Your iLevel Client ID. - Service instructure: Your Instructure client ID. - Service integral_ad_science: Your integral_ad_science client id. - Service ironclad: Your Ironclad client ID. - Service jama_software: Your Jama Software client ID. - Service jibble: Your Jibble client ID. - Service khoros_communities: Your Khoros Communities client ID. - Service looker_source: Your Looker Client ID. - Service marketo: Marketo REST API Client Id. - Service medallia: Medallia Client ID - Service microsoft_entra_id: Your Microsoft Entra ID Client ID. - Service microsoft_power_bi: Your Microsoft Power BI client ID. - Service microsoft_teams: Your Microsoft Teams Client ID. - Service navan: Your Navan client ID. - Service nice: Your NICE client ID. - Service on24: Your ON24 client ID. - Service oracle_sap_hva_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service paychex: Your Paychex client ID. - Service paypal: Client ID of your PayPal client application. - Service paypal_sandbox: Client ID of your PayPal client application. - Service personio: Your Personio Client ID. - Service piwik_pro: Your Piwik PRO client ID. - Service podio: Your Podio client ID. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client ID. - Service prisma_cloud: Your Prisma Cloud access key ID. - Service procore: Your Procore client ID. - Service quora_ads: Your Quora Ads client ID. - Service reltio: Your Reltio client ID. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client ID. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client ID. - Service salesloft: Client ID of your Salesloft client application. - Service sana: Your Sana client ID. - Service sap_success_factors: Your SAP SuccessFactors Client ID. - Service servicenow: ServiceNow Client ID. - Service servicetitan: Your ServiceTitan client ID. - Service sharetribe: Your Sharetribe client ID. - Service shipnetwork: Your ShipNetwork client ID. - Service sigma_computing_source: Your Sigma Computing client ID. - Service skillstx: Your SkillsTX client ID. - Service skimlinks: Your Skimlinks client ID. - Service smartrecruiters: Your SmartRecruiters client ID. - Service splash: Your Splash client ID. - Service square: The Application ID of your organization. - Service standard_metrics: Your Standard Metrics Client ID. - Service sugarcrm: Your SugarCRM client ID. - Service swoogo: Your Swoogo client Id. - Service taboola: The Taboola client ID. - Service talkdesk: The Client ID of your OAuth Client - Service tive: Your Tive client ID. - Service toast: Your Toast client ID. - Service trelica: Your Trelica client ID. - Service tremendous: Your Tremendous client ID. - Service tymeshift: Your Tymeshift email. - Service udemy_business: Your Udemy Business client ID. - Service vimeo: Your Vimeo client ID. - Service visma: Your Visma client ID. - Service vonage_contact_center: Your Vonage Contact Center client ID. - Service walmart_marketplace: Your Walmart Marketplace client ID. - Service xero: your clientId - Service xray: Your Xray Client ID. - Service yougov_sport: Your Yougov Sport client ID. - Service zendesk_chat: Your Zendesk client ID. - Service zoho_books: Your Zoho Books Client ID. - Service zoho_campaigns: Your Zoho Campaigns Client ID. - Service zoho_desk: Your Zoho Desk Client Id. - Service zoho_inventory: Your Zoho Inventory client ID. - Service zuora: Zuora Client ID. - Service zuora_sandbox: Zuora Client ID.
ClientKey string: Field usage depends on service value: - Service appfigures: Your Appfigures Client Key. - Service thinkific: Your Thinkific client key. - Service yougov_sport: Your Yougov Sport client key.
ClientName string: Field usage depends on service value: - Service destini: Your Destini Client Name. - Service medallia: Medallia company name
ClientNamespace string: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Namespace.
ClientPrivateKey string: Field usage depends on service value: - Service aurora_postgres: Client Private Key in .pem format. - Service azure_postgres: Client Private Key in .pem format. - Service google_cloud_postgresql: Client Private Key in .pem format. - Service heroku_postgres: Client Private Key in .pem format. - Service postgres: Client Private Key in .pem format. - Service postgres_rds: Client Private Key in .pem format.
ClientPublicCertificate string: Field usage depends on service value: - Service aurora_postgres: Client Certificate in .pem format. - Service azure_postgres: Client Certificate in .pem format. - Service google_cloud_postgresql: Client Certificate in .pem format. - Service heroku_postgres: Client Certificate in .pem format. - Service postgres: Client Certificate in .pem format. - Service postgres_rds: Client Certificate in .pem format.
ClientSecret string: Field usage depends on service value: - Service acumatica: Your Acumatica client secret. - Service adobe_analytics: Client Secret from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client secret. - Service adp_workforce_now: Your ADP Client Secret. - Service akamai: Your Akamai client secret. - Service akeneo: Your Akeneo client secret. - Service auth0: Your Auth0 client secret. - Service autodesk_bim_360: Your Autodesk BIM 360 client secret. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Secret - Service billing_platform: Your BillingPlatform client secret. - Service bing_webmaster_tools: Your Bing Webmaster Tools client secret. - Service brightcove: Your Brightcove client secret. - Service brightpearl: Your Brightpearl client secret. - Service canvas_by_instructure: Your Canvas by Instructure client secret. - Service castor_edc: Your Castor EDC Client Secret. - Service clazar: Your Clazar client secret. - Service cloudbeds: Your Cloudbeds client secret. - Service commercetools: Your commercetools client secret. - Service concur: The SAP Concur Client secret. - Service constant_contact: Your Constant Contact client secret. - Service cornerstone: Your Cornerstone client secret. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo client secret key. - Service criteo_retail_media: Your Criteo Retail Media client secret. - Service culture_amp: Your Culture Amp client secret. - Service cvent: Your Cvent client secret. - Service d2l_brightspace: Your D2L Brightspace client secret. - Service dialpad: Your Dialpad client secret. - Service ebay: Your eBay cert ID. - Service exact_online: Your Exact Online client secret. - Service fillout: Your Fillout client secret - Service flexport: The Flexport API Secret. - Service formstack: Your Formstack client secret. - Service genesys: Your Genesys client secret. - Service hilti_ontrack: Your Hilti On!Track client secret. - Service ilevel: Your iLevel Client Secret. - Service instructure: Your Instructure client secret. - Service integral_ad_science: Your integral_ad_science client secret. - Service ironclad: Your Ironclad client secret. - Service jama_software: Your Jama Software client secret. - Service jibble: Your Jibble client secret. - Service looker_source: Your Looker Client Secret. - Service marketo: Marketo REST API Client Secret. - Service medallia: Medallia Client Secret key - Service microsoft_entra_id: Your Microsoft Entra ID Client Secret. - Service microsoft_power_bi: Your Microsoft Power BI client secret. - Service microsoft_teams: Your Microsoft Teams Client Secret. - Service navan: Your Navan client secret. - Service nice: Your NICE client secret. - Service paychex: Your Paychex client secret. - Service personio: Your Personio secret. - Service piwik_pro: Your Piwik PRO client secret. - Service podio: Your Podio client secret. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client Secret. - Service prisma_cloud: Your Prisma Cloud secret access Key. - Service procore: Your Procore client secret. - Service quora_ads: Your Quora Ads client secret. - Service reltio: Your Reltio client secret. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client secret. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client secret. - Service salesloft: Client Secret of your Salesloft client application. - Service sana: Your Sana client secret. - Service sap_success_factors: Your SAP SuccessFactors Client Secret that you generated through SAML Assertion. - Service servicenow: ServiceNow Client Secret. - Service servicetitan: Your ServiceTitan secret key. - Service sharetribe: Your Sharetribe client secret. - Service sigma_computing_source: Your Sigma Computing client secret. - Service skillstx: Your SkillsTX client secret. - Service skimlinks: Your Skimlinks client secret. - Service smartrecruiters: Your SmartRecruiters client secret. - Service splash: Your Splash client secret. - Service square: The Application Secret of your organization. - Service standard_metrics: Your Standard Metrics Client secret. - Service sugarcrm: Your SugarCRM client secret. - Service swoogo: Your Swoogo Client Secret. - Service taboola: The Taboola client secret. - Service talkdesk: The Client Secret of your OAuth Client - Service thinkific: Your Thinkific client secret. - Service tive: Your Tive client secret. - Service toast: Your Toast client secret. - Service trelica: Your Trelica client secret. - Service tremendous: Your Tremendous client secret. - Service tymeshift: Your Tymeshift password. - Service udemy_business: Your Udemy Business client secret. - Service vimeo: Your Vimeo client secret. - Service visma: Your Visma client secret. - Service vonage_contact_center: Your Vonage Contact Center client secret. - Service walmart_marketplace: Your Walmart Marketplace client secret. - Service xero: your clientSecret - Service xray: Your Xray Client Secret. - Service zendesk_chat: Your Zendesk client secret. - Service zoho_books: Your Zoho Books Client Secret. - Service zoho_campaigns: Your Zoho Campaigns Client Secret. - Service zoho_desk: Your Zoho Desk Client secret. - Service zoho_inventory: Your Zoho Inventory client secret. - Service zuora: Zuora Client Secret. - Service zuora_sandbox: Zuora Client Secret.
CloudStorageType string: Field usage depends on service value: - Service braze: Cloud storage type Braze Current is connected to.
CollectionAddress string: Field usage depends on service value: - Service rarible: Your Rarible Collection Address.
Columns List<string>: Field usage depends on service value: - Service double_click_publishers: Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.
CommunityDomain string: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community domain.
CommunityId string: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community ID.
Companies List<string>: Field usage depends on service value: - Service business_central: List of companies to sync
Company string: Field usage depends on service value: - Service ordway: Your Ordway company name.
CompanyId string: Field usage depends on service value: - Service 360learning: Your 360Learning Company ID. - Service sage_intacct: Company ID - Service sap_success_factors: Your SAP SuccessFactors Company ID.
CompanyIds string: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail company IDs.
CompanyKey string: Field usage depends on service value: - Service khoros_care: Your Khoros Care companyKey. - Service upland: Your Upland Software Company Key.
CompanyName string: Field usage depends on service value: - Service clockodo: Your Clockodo company name.
CompanyRequestToken string: Field usage depends on service value: - Service concur: The SAP Concur Company Request Token
CompanyUuid string: Field usage depends on service value: - Service concur: The SAP Concur Company UUID
Compression string: Field usage depends on service value: - Service aws_cost_report: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service azure_blob_storage: The secrets that should be passed to the function at runtime. - Service box: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service dropbox: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service email: The secrets that should be passed to the function at runtime. - Service ftp: The secrets that should be passed to the function at runtime. - Service gcs: The secrets that should be passed to the function at runtime. - Service google_drive: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service kinesis: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service s3: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service sftp: The secrets that should be passed to the function at runtime. - Service share_point: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service wasabi_cloud_storage: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
ConfigMethod string: Field usage depends on service value: - Service google_display_and_video_360: The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is CREATE_NEW.
ConfigRepositoryUrl string: Field usage depends on service value: - Service snowplow: Public repository URL containing JSON configuration files.
ConfigType string: Field usage depends on service value: - Service facebook: Option to select Prebuilt Reports or Custom Reports. Possible config_type values. - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports.
ConnectPassword string: Field usage depends on service value: - Service xactly: Your Xactly Connect password.
ConnectUsername string: Field usage depends on service value: - Service xactly: Your Xactly Connect username.
ConnectingUser string
ConnectingUserEmail string
ConnectionMethod string: Field usage depends on service value: - Service aws_msk: How Fivetran connects to your message brokers in the cluster - Service azure_blob_storage: Connection Method. Possible values: 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. - Service azure_function: Connection Method. Possible values: DIRECT: Fivetran will connect directly to your function, PRIVATE_LINK: Fivetran will connect to your storage container using PrivateLink. - Service azure_service_bus: The connection method - Service sftp: The connection method used to connect to SFTP Server.
ConnectionName string: Field usage depends on service value: - Service appsflyer: Your Data Locker Connection Name. Default value: `data-locker-hourly/
ConnectionString string: Field usage depends on service value: - Service azure_blob_storage: The blob storage container connection string. - Service azure_event_hub: Connection string of the Event Hub Namespace you want to sync. - Service azure_service_bus: The connection string used for authentication. Required if the authentication type is ConnectionString - Service microsoft_dynamics_365_fno: The blob storage container's connection string. - Service microsoft_dynamics_365_fo: The blob storage container connection string.
ConnectionType string: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service aws_cost_report: Connection method. Default value: Directly. - Service aws_lambda: Connection method. Default value: Directly. - Service azure_blob_storage: Connection method. Default value: Directly. - Service azure_cosmos_for_mongo: Possible values:Directly, PrivateLink. Directly is the default value - Service azure_postgres: 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. - Service azure_sql_db: 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. - Service azure_sql_managed_db: 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. - Service bigquery_db: Direct or PrivateLink connection - Service clarity: 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. - Service cockroachdb: Possible values:Directly, 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. - Service db2i_hva: Possible values:SshTunnel. SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service db2i_sap_hva: 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. - Service documentdb: Possible values:SshTunnel, PrivateLink . SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service dynamics_365_fo: 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. - Service ehr: 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. - Service elastic_cloud: Possible values:Directly, 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. - Service email: Connection method. Default value: Directly. - Service es_self_hosted: Possible values:Directly, 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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service heroku_postgres: 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. - Service kinesis: Connection method. Default value: Directly. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mongo: 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. - Service mongo_sharded: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service opendistro: Possible values:Directly, 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. - Service opensearch: Possible values:Directly, 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Directly or Private Link - Service s3: Connection method. Default value: Directly. - Service sap_hana: 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. - Service sap_s4hana: Connection Method - Service snowflake_db: Directly or Private Link - Service sql_server: 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. - Service sql_server_hva: 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. - Service sql_server_rds: 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. - Service sql_server_sap_ecc_hva: 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.
ConsoleUrl string: Field usage depends on service value: - Service prisma_cloud: Your Prisma Cloud console URL.
ConsumerGroup string: Field usage depends on service value: - Service apache_kafka: Kafka consumer group name. - Service aws_msk: The name of consumer group created for Fivetran. - Service azure_event_hub: Name of consumer group created for Fivetran. - Service confluent_cloud: Confluent Cloud consumer group name. - Service heroku_kafka: Heroku Kafka consumer group name.
ConsumerKey string: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Key - Service twitter: API Key of your app - Service twitter_ads: The Twitter App consumer key. - Service woocommerce: Your WooCommerce Consumer key.
ConsumerName string: Field usage depends on service value: - Service xactly: Your Xactly Connect consumer name.
ConsumerSecret string: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Secret - Service twitter: API Secret of your app - Service twitter_ads: The Twitter App consumer secret. - Service woocommerce: Your WooCommerce Consumer secret.
ContainerAddress string: Field usage depends on service value: - Service azure_blob_storage: IP address of the Azure Storage Container which is accessible from host machine.
ContainerName string: Field usage depends on service value: - Service azure_blob_storage: The name of the blob container. - Service microsoft_dynamics_365_fno: The name of the blob container. - Service microsoft_dynamics_365_fo: The name of the blob container.
ContentOwnerId string: Field usage depends on service value: - Service youtube_analytics: Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.
ContractVersion string: Field usage depends on service value: - Service acumatica: Your Acumatica contract version.
ConversationWebhookUrl string: Field usage depends on service value: - Service helpscout: Your conversation webhook URL
ConversionDimensions List<string>: Field usage depends on service value: - Service double_click_campaign_manager: Conversion Dimensions.
ConversionReportTime string: Field usage depends on service value: - Service pinterest_ads: The date that the user interacted with the ad OR completed a conversion event.
ConversionWindowSize double: Field usage depends on service value: - Service google_ads: A period of time in days during which a conversion is recorded.
ConvertDatsTypeToDate bool
CsvDefinition string: Field usage depends on service value: - Service adjust: CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition).
Currency string: Field usage depends on service value: - Service criteo: Currency - Service rokt: Your Rokt currency.
CustomBaseUrl string: Field usage depends on service value: - Service datadog: Your Datadog custom base url. - Service deposco: Your Deposco custom base URL.
CustomEventSyncMode string: Field usage depends on service value: - Service iterable: Custom Events Sync Mode.
CustomEvents List<string>: Field usage depends on service value: - Service iterable: List of custom events to sync. Should be specified when custom_event_sync_mode is SelectedEvents
CustomFieldIds List<string>: Field usage depends on service value: - Service double_click_publishers: The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.
CustomFloodlightVariables List<string>: Field usage depends on service value: - Service double_click_campaign_manager: Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.
CustomPayloads List<GetConnectorConfigCustomPayload>: Field usage depends on service value: - Service aws_lambda: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service azure_function: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service google_cloud_function: The list of key-value pairs that can be used to specify custom information to the function at runtime.
CustomReports List<GetConnectorConfigCustomReport>: Field usage depends on service value: - Service reddit_ads: The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data. - Service snapchat_ads: Custom reports for Snapchat Ads connector. - Service tiktok_ads: Title of Custom Report
CustomTables List<GetConnectorConfigCustomTable>: Field usage depends on service value: - Service facebook_ads: List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data.
CustomUrl string: Field usage depends on service value: - Service dbt_cloud: Your dbt Cloud access url. - Service factbird: Your Factbird custom base url. - Service jotform: Your Jotform custom base URL.
CustomerApiKey string: Field usage depends on service value: - Service ukg_pro: Your UKG Pro Customer API key.
CustomerId string: Field usage depends on service value: - Service google_ads: ID of the customer, can be retrieved from your AdWords dashboard.
CustomerListId string: Field usage depends on service value: - Service salesforce_commerce_cloud: The parameter to retrieve customer details.
DailyApiCallLimit double
DataAccessMethod string: Field usage depends on service value: - Service cosmos: The source data access method. Supported values:ACCOUNT_KEY- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.RESOURCE_TOKEN- Fine-grained permission model based on native Azure Cosmos DB users and permissions. Learn more in our Azure Cosmos DB Data Access Methods documentation.
DataCenter string: Field usage depends on service value: - Service brightpearl: Your Brightpearl data center. - Service qualtrics: 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.) - Service zoho_crm: Data Center, depending on the Domain name
DataCenterId string: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback data center ID.
DataSetName string: Field usage depends on service value: - Service bigquery_db: Data set name
Database string: Field usage depends on service value: - Service aurora: The database name. - Service aurora_postgres: The database name. - Service azure_cosmos_for_mongo: Authentication database for the source. Usually 'admin'. - Service azure_postgres: The database name. - Service azure_sql_db: The database name. - Service azure_sql_managed_db: The database name. - Service clarity: The database name. - Service cockroachdb: The database name. - Service db2i_hva: The database name. - Service db2i_sap_hva: The database name. - Service dynamics_365_fo: The database name. - Service ehr: The database name. - Service google_cloud_mysql: The database name. - Service google_cloud_postgresql: The database name. - Service google_cloud_sqlserver: The database name. - Service hana_sap_hva_b1: The Hana database name. - Service hana_sap_hva_ecc: The Hana database name. - Service hana_sap_hva_ecc_netweaver: The Hana database name. - Service hana_sap_hva_s4: The Hana database name. - Service hana_sap_hva_s4_netweaver: The Hana database name. - Service heroku_postgres: The database name. - Service magento_mysql: The database name. - Service magento_mysql_rds: The database name. - Service maria: The database name. - Service maria_azure: The database name. - Service maria_rds: The database name. - Service mysql: The database name. - Service mysql_azure: The database name. - Service mysql_rds: The database name. - Service oracle: The database name. - Service oracle_ebs: The database name. - Service oracle_hva: The database name. - Service oracle_rac: The database name. - Service oracle_rds: The database name. - Service oracle_sap_hva: The database name. - Service postgres: The database name. - Service postgres_rds: The database name. - Service redshift_db: The database name: Redshift - Service sap_hana: The database name. - Service sap_s4hana: The database name. - Service snowflake_db: The database name: Snowflake - Service sql_server: The database name. - Service sql_server_hva: The database name. - Service sql_server_rds: The database name. - Service sql_server_sap_ecc_hva: The database name.
DatabaseName string: Field usage depends on service value: - Service firebase: Database Name
DatasetId string: Field usage depends on service value: - Service google_analytics_360: The dataset ID. - Service google_analytics_4_export: The Dataset ID.
Datasource string: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite data source value: NetSuite.com.
DateGranularity string: Field usage depends on service value: - Service adobe_analytics: The aggregation duration you want. Default value: HOUR .
Db string: Field usage depends on service value: - Service myosh: Your Myosh Server variables/db .
Delimiter string: Field usage depends on service value: - Service aws_cost_report: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service azure_blob_storage: 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. - Service box: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service dropbox: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service kinesis: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service s3: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service sftp: 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. - Service share_point: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service wasabi_cloud_storage: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
DeveloperReference string: Field usage depends on service value: - Service brightpearl: Your Brightpearl dev reference.
DimensionAttributes List<string>: Field usage depends on service value: - Service double_click_publishers: Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions.
Dimensions List<string>: Field usage depends on service value: - Service adroll: The dimenstions that you want to sync. - Service double_click_campaign_manager: 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 - Service double_click_publishers: Report dimensions to include in the sync. The date dimension is mandatory for all the report types. - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_display_and_video_360: 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.
DirectCaptureMethod string: Field usage depends on service value: - Service oracle_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY - Service oracle_sap_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY
DistributedConnectorClusterSize double: Field usage depends on service value: - Service cosmos: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel. - Service dynamodb: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel.
Domain string: Field usage depends on service value: - Service auth0: Your Auth0 domain. - Service bubble: Your Bubble app name or domain name. - Service confluence: Your Confluence domain. - Service kustomer: Domain is the beginning of your kustomer URL going before .kustomerapp.com, e.g. for yourcompany.kustomerapp.com the domain name is yourcompany - Service okta: Your Okta domain. - Service pipedrive: Your Pipedrive domain. - Service shopware: Your Shopware domain. - Service sistrix: Your SISTRIX domain. - Service solarwinds_service_desk: Your SolarWinds Service Desk domain. - Service uservoice: Domain of your UserVoice site. If it ends with ".uservoice.com", you can specify just the subdomain ("mydomain.uservoice.com" - "mydomain") - Service zendesk: Zendesk domain. - Service zendesk_sunshine: Zendesk domain.
DomainHostName string: Field usage depends on service value: - Service workday: Workday host name. - Service workday_financial_management: Workday host name. - Service workday_hcm: Workday host name.
DomainName string: Field usage depends on service value: - Service calabrio: Your Calabrio domain name - Service dynamics_365: The custom domain name associated with Dynamics 365. - Service helpshift: Your Helpshift domain name.
DomainType string: Field usage depends on service value: - Service medallia: Domain type of your Medallia URL
DsvServiceAuth string
DsvSubscriptionKey string
EcommerceStores List<string>: Field usage depends on service value: - Service mailchimp: List of IDs of the Mailchimp E-Commerce Stores to Sync
Edition string
Elements List<string>
Email string: Field usage depends on service value: - Service appcues: Your Appcues Email. - Service boostr: Your Boostr email. - Service copper: Your Copper email address. - Service email: Send your emails to this address. - Service moloco: Your Moloco account email. - Service netsuite_suiteanalytics: The NetSuite user's email address. - Service pardot: The email of the Pardot user. - Service skuvault: Your SkuVault email. - Service smadex: Your Smadex account's email ID. - Service zendesk: Zendesk email. - Service zendesk_sunshine: Zendesk email.
EmailAddress string: Field usage depends on service value: - Service clockodo: Your Clockodo email address.
EmailId string: Field usage depends on service value: - Service ordway: Your Ordway user email ID. - Service planful: Your Planful email ID.
EmptyHeader bool: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service azure_blob_storage: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service box: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service dropbox: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service email: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service ftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service gcs: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service google_drive: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service kinesis: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service s3: 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. - Service sftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service share_point: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service wasabi_cloud_storage: 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.
EnableAllDimensionCombinations bool: Field usage depends on service value: - Service double_click_campaign_manager: Whether to enable all reach dimension combinations in the report. Default value: false
EnableArchiveLogOnly bool: Field usage depends on service value: - Service sql_server_hva: Use archive log only mode - Service sql_server_sap_ecc_hva: Use archive log only mode
EnableDataExtensionsSyncing bool
EnableDistributedConnectorMode bool: Field usage depends on service value: - Service cosmos: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors. - Service dynamodb: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors.
EnableEnrichments bool: Field usage depends on service value: - Service snowplow: Enable Enrichments
EnableExports bool: Field usage depends on service value: - Service braze: Enable User Profile Exports
EnableTde bool: Field usage depends on service value: - Service sql_server_hva: Using Transparent Data Encryption (TDE) - Service sql_server_sap_ecc_hva: Using Transparent Data Encryption (TDE)
EncodedPublicKey string: Field usage depends on service value: - Service apple_search_ads: Use the public key to grant Fivetran access to Apple Search Ads api.
EncryptionKey string: Field usage depends on service value: - Service marketo: Marketo SOAP API Encryption Key.
Endpoint string: Field usage depends on service value: - Service branch: Webhook Endpoint - Service iterable: Register the following URL for webhooks on your Iterable dashboard. - Service marketo: Marketo REST API endpoint. - Service snowplow: Connection-specific collector endpoint. The collector endpoint will have the webhooks.fivetran.com/snowplow/endpoint_ID format. You will need it to configure Snowplow to connect with Fivetran. - Service webhooks: You can send your events to https://webhooks.fivetran.com/webhooks/{endpoint}
EngagementAttributionWindow string: Field usage depends on service value: - Service pinterest_ads: The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action.
EnrichedExport string: Field usage depends on service value: - Service optimizely: Enriched Events S3 bucket
EntityId string: Field usage depends on service value: - Service checkout: Your Checkout.com entity ID. - Service zuora: If is_multi_entity_feature_enabled is true, then it's EntityId. - Service zuora_sandbox: If is_multi_entity_feature_enabled is true, then it's EntityId.
Environment string: Field usage depends on service value: - Service bazaarvoice: Your Bazaarvoice environment. - Service buildium: Your Buildium environment. - Service checkout: Your Checkout.com environment. - Service concord: Your Concord environment. - Service deposco: Your Deposco environment. - Service dialpad: Your Dialpad environment. - Service invoiced: Your Invoiced environment. - Service jibble: Your Jibble environment. - Service lucca: Your Lucca environment. - Service procore: Your Procore account environment. - Service reltio: Your Reltio environment. - Service servicetitan: Your ServiceTitan environment. - Service smarthr: Your SmartHR environment. - Service trelica: Your Trelica environment. - Service tremendous: Your Tremendous environment. - Service vts: Your VTS environment. - Service xactly: Your Xactly environment. - Service younium: Your Younium API environment. - Service zuora: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox. - Service zuora_sandbox: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
EnvironmentHost string: Field usage depends on service value: - Service xactly: Your Xactly environment host.
EnvironmentName string: Field usage depends on service value: - Service business_central: Name of the environment
EscapeChar string: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service azure_blob_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service box: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service dropbox: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service email: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service ftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service gcs: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service google_drive: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service kinesis: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service s3: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service sftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service share_point: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service wasabi_cloud_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
EscapeCharOptions string: Field usage depends on service value: - Service gcs: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true. - Service s3: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true.
EuRegion bool: Field usage depends on service value: - Service kustomer: Turn it on if your app is on EU region - Service survey_monkey: The SurveyMonkey account region. Specify true, if your account is hosted in the EU region. Default value is false.
Events List<string>: Field usage depends on service value: - Service iterable: List of events to sync. Should be specified when sync_mode is SelectedEvents
ExportStorageType string: Field usage depends on service value: - Service adjust: Your cloud storage. - Service braze: Export Storage. Required if enable_exports is true
ExternalId string: Field usage depends on service value: - Service appsflyer: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_cloudtrail: This is the same as your group_id, used for authentication along with the role_arn. - Service aws_cost_report: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_lambda: The external ID is a string that designates who can assume the role. - Service aws_msk: This is the same as your group_id. This is required when sasl_mechanism is set to IAM. - Service azure_function: External ID. - Service cloudfront: This is the same as your group_id, used for authentication along with the role_arn. - Service dynamodb: This is the same as your group_id, used for authentication along with the role_arn. - Service kinesis: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service s3: Used for authentication along with the role_arn. If not provided, it uses connector's group_id. Use the List All Groups endpoint to find the group_id. - Service segment: The external ID is a string that designates who can assume the role. For more information, see a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"Amazon's AWS Identity and Access Management User Guide/a.
FacilityCodes string: Field usage depends on service value: - Service unicommerce: Your uniware facility codes.
Fields List<string>: Field usage depends on service value: - Service facebook: List of fields which connector will sync. Possible field values.
FileType string: Field usage depends on service value: - Service aws_cost_report: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service azure_blob_storage: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service box: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service dropbox: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service email: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service ftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service gcs: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service google_drive: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service kinesis: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service s3: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service sftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service share_point: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service wasabi_cloud_storage: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
Filter string: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
FinanceAccountSyncMode string: Field usage depends on service value: - Service itunes_connect: Whether to sync all finance accounts or specific finance accounts.
FinanceAccounts List<string>: Field usage depends on service value: - Service itunes_connect: Specific finance accounts to sync. Must be populated if finance_account_sync_mode is set to SpecificFinanceAccounts.
Folder string: Field usage depends on service value: - Service dropbox: Your Dropbox Folder URL.
FolderId string: Field usage depends on service value: - Service box: Folder URL - Service google_drive: Folder URL
FolderPath string: Field usage depends on service value: - Service adobe_analytics_data_feed: Folder Path - Service one_drive: Your OneDrive folder URL - Service oracle_business_intelligence_publisher: The folder path to save data models and reports.
ForecastId string: Field usage depends on service value: - Service clari: Your Clari Forecast id .
FtpHost string: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP host.
FtpPassword string: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP password.
FtpPort double: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP port.
FtpUser string: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP user.
Function string: Field usage depends on service value: - Service aws_lambda: The name of your AWS Lambda Function.
FunctionApp string: Field usage depends on service value: - Service azure_function: Function app name in Azure portal.
FunctionKey string: Field usage depends on service value: - Service azure_function: Function key used for authorization.
FunctionName string: Field usage depends on service value: - Service azure_function: Name of the function to be triggered.
FunctionTrigger string: Field usage depends on service value: - Service google_cloud_function: The trigger URL of the cloud function.
GcsBucket string: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the cloud_storage_type - Service webhooks: The GCS bucket name. Required if bucket_service is set to GCS.
GcsExportBucket string: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the export_storage_type
GcsExportFolder string: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the export_storage_type
GcsFolder string: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the cloud_storage_type
GenerateFivetranPk bool: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
GroupId string: Field usage depends on service value: - Service line_ads: Your LINE Ads group ID(s).
GroupName string: Field usage depends on service value: - Service fivetran_log: (Optional) The group name of the target_group_id.
HanaBackupPassword string
HanaMode string: Field usage depends on service value: - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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.
HasManagePermissions bool: Field usage depends on service value: - Service azure_service_bus: The boolean value specifying whether the connection string has manage permissions
HistoricSyncTimeFrame string: Field usage depends on service value: - Service braze: Range of data in history you would like to include in the initial sync. - Service iterable: The time range for which historical data should be synced. Default value: All Time. - Service klaviyo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service marketo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service sailthru: Range of historical data you would like to include in the initial sync. Default value: ALL_TIME. - Service salesforce_marketing_cloud: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME.
HistoricalSyncLimit string: Field usage depends on service value: - Service concur: Historical Sync Limit for the Sync - Service eloqua: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service pardot: The time range for which historical data should be synced. Default value: All Time.
HistoricalSyncTimeFrame string: Field usage depends on service value: - Service rokt: Your Rokt historical sync time frame. - Service skimlinks: Your Skimlinks Historical sync time frame. - Service vimeo: Your Vimeo Historical sync time frame. - Service zendesk: Used to configure Historical sync timeframe for selected tables
HomeFolder string: Field usage depends on service value: - Service appsflyer: Your S3 home folder path of the Data Locker.
Host string: Field usage depends on service value: - Service aurora: DB instance host or IP address. - Service aurora_postgres: DB instance host or IP address. - Service azure_postgres: DB instance host or IP address. - Service azure_sql_db: DB instance host or IP address. - Service azure_sql_managed_db: DB instance host or IP address. - Service clarity: DB instance host or IP address. - Service cockroachdb: DB instance host or IP address. - Service commercetools: Your commercetools host. - Service databricks_db: The host URL for your Databricks account. - Service db2i_hva: A host address of the primary node. It should be a DB instance host/IP address with a port number. - Service db2i_sap_hva: DB instance host or IP address. - Service documentdb: Host IP address of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: DB instance host or IP address. - Service ehr: DB instance host or IP address. - Service elastic_cloud: DB instance host or IP address. - Service es_self_hosted: DB instance host or IP address. - Service ftp: FTP host address. - Service google_cloud_mysql: DB instance host or IP address. - Service google_cloud_postgresql: DB instance host or IP address. - Service google_cloud_sqlserver: DB instance host or IP address. - Service hana_sap_hva_b1: DB instance host or IP address. - Service hana_sap_hva_ecc: DB instance host or IP address. - Service hana_sap_hva_ecc_netweaver: DB instance host or IP address. - Service hana_sap_hva_s4: DB instance host or IP address. - Service hana_sap_hva_s4_netweaver: DB instance host or IP address. - Service heroku_postgres: DB instance host or IP address. - Service jira: The Jira service host address. - Service magento_mysql: DB instance host or IP address. - Service magento_mysql_rds: DB instance host or IP address. - Service maria: DB instance host or IP address. - Service maria_azure: DB instance host or IP address. - Service maria_rds: DB instance host or IP address. - Service marin: The Marin host address. - Service mysql: DB instance host or IP address. - Service mysql_azure: DB instance host or IP address. - Service mysql_rds: DB instance host or IP address. - Service netsuite_suiteanalytics: The NetSuite service host address. - Service opendistro: DB instance host or IP address. - Service opensearch: DB instance host or IP address. - Service oracle: DB instance host or IP address. - Service oracle_ebs: DB instance host or IP address. - Service oracle_hva: DB instance host or IP address. - Service oracle_rac: DB instance host or IP address. - Service oracle_rds: DB instance host or IP address. - Service oracle_sap_hva: DB instance host or IP address. - Service oracle_sap_hva_netweaver: DB instance host or IP address. - Service postgres: DB instance host or IP address. - Service postgres_rds: DB instance host or IP address. - Service redshift_db: Host name - Service sap_hana: The SAP HANA host or IP address. - Service sap_s4hana: The SAP S/4 host or IP address. - Service sftp: SFTP host address. - Service snowflake_db: Host name - Service splunk: The Splunk service host address. - Service sql_server: DB instance host or IP address. - Service sql_server_hva: DB instance host or IP address. - Service sql_server_rds: DB instance host or IP address. - Service sql_server_sap_ecc_hva: DB instance host or IP address.
HostIp string: Field usage depends on service value: - Service azure_blob_storage: IP address of host tunnel machine which is used to connect to the Storage container. - Service azure_service_bus: The IP address of the host machine which we use to connect to ASB via ssh
HostName string: Field usage depends on service value: - Service coassemble: Your Coassemble Hostname. - Service datadog: Your Datadog host name.
HostUrl string: Field usage depends on service value: - Service adobe_commerce: Your Adobe Commerce host url. - Service sparkpost: Your SparkPost host URL.
HostUser string: Field usage depends on service value: - Service azure_blob_storage: Username in the host machine. - Service azure_service_bus: The username on the host machine which we use to connect to ASB via ssh
Hostname string: Field usage depends on service value: - Service akamai: Your Akamai hostname. - Service ukg_pro: Your UKG Pro hostname.
Hosts List<string>: Field usage depends on service value: - Service azure_cosmos_for_mongo: A list of host addresses for Azure Cosmos DB for Mongo DB. - Service mongo: 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. - Service mongo_sharded: 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.
HttpPath string: Field usage depends on service value: - Service databricks_db: http path
Identifier string: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management client identifier. - Service statistics_netherlands_cbs: Your Statistics Netherlands CBS catalog identifier.
Identity string: Field usage depends on service value: - Service marketo: Marketo REST API identity url.
IncludeOcapiEndpoints bool: Field usage depends on service value: - Service salesforce_commerce_cloud: Whether to sync data through OCAPI endpoints.
Instance string: Field usage depends on service value: - Service acumatica: Your Acumatica instance name. - Service coupa: The instance name of your Coupa account in the URL. - Service flywheel_digital: Your Flywheel Digital instance. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud instance ID - Service servicenow: ServiceNow Instance ID.
InstanceNumber string: Field usage depends on service value: - Service hana_sap_hva_b1: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service oracle_sap_hva_netweaver: Two-digit number (00-97) of the SAP instance within its host.
InstanceUrl string: Field usage depends on service value: - Service sap_business_by_design: The SAP Business ByDesign instance URL.
IntegrationKey string: Field usage depends on service value: - Service pendo: The integration key of the Pendo account.
IpAddress string: Field usage depends on service value: - Service aveva_pi: IP address of the AF Server
IsAccountLevelConnector bool: Field usage depends on service value: - Service fivetran_log: (Optional) Retrieve account-level logs.
IsAuth2Enabled bool: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Default value: false
IsCustomApiCredentials bool: Field usage depends on service value: - Service twitter_ads: Custom API credentials
IsExternalActivitiesEndpointSelected bool: Field usage depends on service value: - Service pardot: Whether the EXTERNAL_ACTIVITY table must be synced or not.
IsFtps bool: Field usage depends on service value: - Service adobe_analytics_data_feed: Use Secure FTP (FTPS).
IsKeypair bool: Field usage depends on service value: - Service sftp: Whether to use a key pair for authentication. When true, do not use password.
IsMultiEntityFeatureEnabled bool: Field usage depends on service value: - Service zuora: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false. - Service zuora_sandbox: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false.
IsNewPackage bool: Field usage depends on service value: - Service salesforce_marketing_cloud: Indicates that that your installed package uses OAuth 2.0. Default value: false
IsPrivateKeyEncrypted bool: Field usage depends on service value: - Service snowflake_db: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
IsPrivateLinkRequired bool: Field usage depends on service value: - Service aws_lambda: We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our PrivateLink documentation. - Service s3: Set to true if you want to connect to S3 bucket over PrivateLink. Default value: false.
IsPublic bool: Field usage depends on service value: - Service aws_cost_report: Whether you are syncing from a public bucket. Default value: false. - Service kinesis: Is the bucket public? (you don't need an AWS account for syncing public buckets!) - Service s3: Whether you are syncing from a public bucket. Default value: false.
IsSailthruConnectEnabled bool: Field usage depends on service value: - Service sailthru: Enable this if you want to sync Sailthru Connect
IsSecure bool: Field usage depends on service value: - Service ftp: Whether the server supports FTPS.
IsSftpCredsAvailable bool: Field usage depends on service value: - Service salesforce_marketing_cloud: Provide SFTP credentials
IsSingleTableMode bool: Field usage depends on service value: - Service box: Allows the creation of connector using Merge Mode strategy. - Service dropbox: Allows the creation of connector using Merge Mode strategy. - Service google_drive: Allows the creation of connector using Merge Mode strategy. - Service sftp: Allows the creation of connector using the specified Sync strategy. - Service share_point: Allows the creation of connector using Merge Mode strategy.
IsTestAccount bool: Field usage depends on service value: - Service adyen: Whether or not your Adyen Account is a Test Account. Default value: false.
IsVendor bool: Field usage depends on service value: - Service amazon_selling_partner: Whether or not you have a Vendor Account. Default value: false.
Issuer string: Field usage depends on service value: - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud issuer name.
JsonDeliveryMode string: Field usage depends on service value: - Service aws_cost_report: Control how your JSON data is delivered into your destination - Service azure_blob_storage: Control how your JSON data is delivered into your destination - Service box: Control how your JSON data is delivered into your destination - Service dropbox: Control how your JSON data is delivered into your destination - Service email: Control how your JSON data is delivered into your destination - Service ftp: Control how your JSON data is delivered into your destination - Service gcs: Control how your JSON data is delivered into your destination - Service google_drive: Control how your JSON data is delivered into your destination - Service kinesis: Control how your JSON data is delivered into your destination - Service s3: Control how your JSON data is delivered into your destination - Service sftp: Control how your JSON data is delivered into your destination - Service share_point: Control how your JSON data is delivered into your destination - Service wasabi_cloud_storage: Specifies how Fivetran should handle your JSON data. Default value: Packed.
Key string: Field usage depends on service value: - Service uservoice: The UserVoice API key.
KeyPassword string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Key Password.
KeyStoreType string: Field usage depends on service value: - Service heroku_kafka: Key Store Type
Keystore string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Keystore File as Base64 encoded string.
KeystorePassword string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Keystore Password.
LastSyncedChangesUtc_ string
LatestVersion string
LegalEntityId string: Field usage depends on service value: - Service younium: Your Younium legal entity ID.
LimitForApiCallsToExternalActivitiesEndpoint double: Field usage depends on service value: - Service pardot: API limit for the external activities endpoint.
LineSeparator string: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
ListId string: Field usage depends on service value: - Service pigment: Your Pigment list ID.
ListOfCompanyIds string: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail list of company IDs.
ListStrategy string: Field usage depends on service value: - Service aws_cost_report: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service kinesis: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service s3: The listing strategy you want to use. Default value: complete_listing.
ListSyncMode string: Field usage depends on service value: - Service google_analytics_4_export: The Sync Mode
LogJournal string: Field usage depends on service value: - Service db2i_hva: The log journal name. - Service db2i_sap_hva: The log journal name.
LogJournalSchema string: Field usage depends on service value: - Service db2i_hva: The log journal schema. - Service db2i_sap_hva: The log journal schema.
LogOnGroup string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional. - Service hana_sap_hva_s4_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional.
Login string: Field usage depends on service value: - Service rebound_returns: Your ReBound Returns login. - Service the_trade_desk: The Trade Desk email. It is a part of the login credentials. - Service walmart_dsp: Walmart DSP email. It is a part of the login credentials.
LoginPassword string: Field usage depends on service value: - Service concur: The SAP Concur password. - Service sage_intacct: The login password. It is a part of the login credentials.
ManagerAccounts List<string>: Field usage depends on service value: - Service google_ads: The list of the Manager Account IDs whose clients will be synced. Must be populated if sync_mode is set to ManagerAccounts.
MaxApiRequestsPerDay double: Field usage depends on service value: - Service reltio: Maximum API requests per day
MerchantId string: Field usage depends on service value: - Service afterpay: Your Afterpay Merchant ID. - Service amazon_selling_partner: The Merchant ID or Vendor Code. - Service avantlink: Your AvantLink Merchant ID. - Service braintree: Your Braintree merchant ID. - Service braintree_sandbox: Your Braintree merchant ID. - Service shareasale: Your ShareASale merchant ID. - Service xsolla: Your Xsolla Merchant ID.
MessageType string: Field usage depends on service value: - Service apache_kafka: Kafka message type. - Service aws_msk: The Message type. - Service azure_event_hub: Message type. - Service azure_service_bus: The format of messages in the topic - Service confluent_cloud: Confluent Cloud message type. - Service heroku_kafka: Heroku Kafka message type.
MetricId string: Field usage depends on service value: - Service pigment: Your Pigment metric ID.
Metrics List<string>: Field usage depends on service value: - Service adroll: The metrics that you want to sync. - Service criteo: Metrics - Service double_click_campaign_manager: Report metrics to include into a sync. - Service google_analytics: The report metrics to include into a sync. - Service google_display_and_video_360: 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.
NamedRange string: Field usage depends on service value: - Service google_sheets: The name of the named data range on the sheet that contains the data to be synced.
Namespace string: Field usage depends on service value: - Service azure_service_bus: The ASB namespace which we have to sync. Required for AzureActiveDirectory authentication.
NetworkCode double: Field usage depends on service value: - Service double_click_publishers: Network code is a unique, numeric identifier for your Ad Manager network.
NonStandardEscapeChar bool: Field usage depends on service value: - Service gcs: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false. - Service s3: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false.
NullSequence string: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service azure_blob_storage: If your CSVs use a special value indicating null, you can specify it here. - Service box: If your CSVs use a special value indicating null, you can specify it here. - Service dropbox: If your CSVs use a special value indicating null, you can specify it here. - Service email: If your CSVs use a special value indicating null, you can specify it here. - Service ftp: If your CSVs use a special value indicating null, you can specify it here. - Service gcs: If your CSVs use a special value indicating null, you can specify it here. - Service google_drive: If your CSVs use a special value indicating null, you can specify it here. - Service kinesis: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service s3: If your CSVs use a special value indicating null, you can specify it here. - Service sftp: If your CSVs use a special value indicating null, you can specify it here. - Service share_point: If your CSVs use a special value indicating null, you can specify it here. - Service wasabi_cloud_storage: If your CSVs use a special value indicating null, you can specify it here.
OauthToken string
OauthTokenSecret string
OcapiClientId string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client ID.
OcapiClientSecret string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client secret.
OcapiCustomObjectTypes string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI custom object types.
OcapiHostname string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI hostname.
OdbcDriverManagerLibraryPath string: Field usage depends on service value: - Service hana_sap_hva_b1: ODBC manager library path - Service hana_sap_hva_ecc: ODBC manager library path - Service hana_sap_hva_s4: ODBC manager library path
OdbcSysIniPath string: Field usage depends on service value: - Service hana_sap_hva_b1: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_ecc: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_s4: odbc.ini and odbcsinst.ini location
OnError string: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
OnPremise bool: Field usage depends on service value: - Service jira: Whether the Jira instance is local or in cloud.
Organization string: Field usage depends on service value: - Service gladly: Your Gladly Organization Name. - Service statuspage: Your Statuspage Organization ID.
OrganizationDomain string: Field usage depends on service value: - Service adobe_workfront: Your Adobe Workfront organization domain.
OrganizationId string: Field usage depends on service value: - Service adobe_analytics: Organization ID from the Service Account (JWT) credentials of your Adobe Project. - Service integrate: Your Integrate organization ID. - Service megaphone: Your Megaphone organization ID. - Service productive: Your Productive Organization ID. - Service salesforce_commerce_cloud: The organization ID from Salesforce Commerce Cloud account. - Service sentry: Your Sentry organization ID. - Service zoho_books: Your Zoho Books Organization ID. - Service zoho_inventory: Your Zoho Inventory organization ID.
OrganizationName string: Field usage depends on service value: - Service brightpearl: Your Brightpearl organization name. - Service confluence: Your Confluence organization name.
Organizations List<string>: Field usage depends on service value: - Service apple_search_ads: Organizations - Service snapchat_ads: Specific organizations IDs to sync. Must be populated if syncMode is set to SpecificOrganizations.
PackedModeTables List<string>: Field usage depends on service value: - Service azure_cosmos_for_mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service dynamodb: List of tables to be synced in packed mode. - Service firebase: Specific tables to sync. Must be populated if packing_mode is set to SelectTablesForPackedMode. - Service mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service mongo_sharded: List of tables to be synced in packed mode; format:db.table(case-sensitive).
PackingMode string: Field usage depends on service value: - Service azure_cosmos_for_mongo: Indicates the desired sync pack mode. Accepted values are UsePackedModeOnly and UseUnpackedModeOnly. SelectTablesForPackedMode is deprecated. - Service firebase: Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service klaviyo: Packing mode for EVENT and PERSON tables. - Service mongo: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service mongo_sharded: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service optimizely: Packing mode for conversion and decision tables. - Service sailthru: Packing mode for LIST_STATE and USER tables.
Pages List<string>: Field usage depends on service value: - Service facebook_pages: Specific pages to sync. Must be populated if sync_mode is set to SpecificPages.
PartnerCode string: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission partner code.
PartnerUserId string: Field usage depends on service value: - Service expensify: Your Expensify partnerUserID.
PartnerUserSecret string: Field usage depends on service value: - Service expensify: Your Expensify partnerUserSecret.
Partners List<string>: Field usage depends on service value: - Service google_display_and_video_360: The list of partners to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service the_trade_desk: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service walmart_dsp: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
PassPhrase string: Field usage depends on service value: - Service qualtrics: Pass Phrase
Passphrase string: Field usage depends on service value: - Service snowflake_db: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
Password string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS password. - Service adobe_commerce: Your Adobe Commerce password. - Service akeneo: Your Akeneo password. - Service anaplan: Your Anaplan password. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Password. - Service aurora: The user's password. - Service aurora_postgres: The user's password. - Service azure_cosmos_for_mongo: Password used for source database authentication. - Service azure_postgres: The user's password. - Service azure_sql_db: The user's password. - Service azure_sql_managed_db: The user's password. - Service boostr: Your Boostr password. - Service ceridian_dayforce: Your Ceridian Dayforce Password. - Service cin7: Your Cin7 API Key. - Service clarity: The user's password. - Service cockroachdb: The user's password. - Service collibra: Your collibra password. - Service compliance_checkpoint: Your Compliance Checkpoint account password. - Service contrast_security: Your Contrast Security API Password. - Service db2i_hva: The user's password. - Service db2i_sap_hva: The user's password. - Service deposco: Your Deposco password. - Service documentdb: The user's password. - Service dynamics_365_fo: The user's password. - Service ehr: The user's password. - Service elastic_cloud: The user's password. - Service es_self_hosted: The user's password. - Service ftp: FTP password. - Service globalmeet: Your GlobalMeet Password. - Service google_cloud_mysql: The user's password. - Service google_cloud_postgresql: The user's password. - Service google_cloud_sqlserver: The user's password. - Service green_power_monitor: Your GreenPowerMonitor password. - Service guru: Your Guru password. - Service hana_sap_hva_b1: The user's password. - Service hana_sap_hva_ecc: The user's password. - Service hana_sap_hva_ecc_netweaver: The user's password. - Service hana_sap_hva_s4: The user's password. - Service hana_sap_hva_s4_netweaver: The user's password. - Service heroku_postgres: The user's password. - Service hilti_ontrack: Your Hilti On!Track password. - Service impact: Your Impact Account Token - Service integral_ad_science: Your integral_ad_science password. - Service itunes_connect: Your password - Service jamf: Your Jamf password. - Service jira: The Jira user's password. - Service khoros_care: Your Khoros Care password. - Service kissmetrics: Your Kissmetrics API Password. - Service klarna: Your Klarna Password. - Service lessonly: Your Lessonly password. - Service magento_mysql: The user's password. - Service magento_mysql_rds: The user's password. - Service maria: The user's password. - Service maria_azure: The user's password. - Service maria_rds: The user's password. - Service marin: The Marin user's password. - Service moloco: Your Moloco account password. - Service mongo: The user's password. - Service mongo_sharded: The user's password. - Service myosh: Your myosh password. - Service mysql: The user's password. - Service mysql_azure: The user's password. - Service mysql_rds: The user's password. - Service netsuite_suiteanalytics: The NetSuite user's password. - Service opendistro: The user's password. - Service opensearch: The user's password. - Service oracle: The user's password. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence user password. - Service oracle_ebs: The user's password. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud user password. - Service oracle_hva: The user's password. - Service oracle_rac: The user's password. - Service oracle_rds: The user's password. - Service oracle_sap_hva: The user's password. - Service oracle_sap_hva_netweaver: The user's password. - Service outbrain: The Outbrain user's password. - Service pardot: The Pardot user's password. - Service partnerize: Your Partnerize account's password. - Service podio: Your Podio account password. - Service postgres: The user's password. - Service postgres_rds: The user's password. - Service qmatic_data_connect: Your Qmatic Data Connect password. - Service redshift_db: The Redshift user's password. - Service revx: Your RevX Password. - Service rtb_house: Your RTB House password. - Service sap_business_by_design: The SAP Business ByDesign password. - Service sap_hana: Your SAP HANA password. - Service sap_s4hana: Your SAP S/4 password. - Service scorm: Your Scorm Secret Key. - Service servicenow: Your account password. - Service sftp: SFTP password. - Service shiphero: Your ShipHero password. - Service shipstation: Your ShipStation password. - Service shopware: Your Shopware password. - Service skuvault: Your SkuVault password. - Service smadex: Your Smadex Password. - Service snowflake_db: The Snowflake user's password. - Service splash: Your Splash password. - Service splunk: The Splunk user's password. - Service sql_server: The user's password. - Service sql_server_hva: The user's password. - Service sql_server_rds: The user's password. - Service sql_server_sap_ecc_hva: The user's password. - Service starrez: Your StarRez API password - Service stickyio: Your sticky.io password. - Service stylight: Your Stylight Password. - Service sugarcrm: Your SugarCRM password. - Service teamwork: Your Teamwork password. - Service the_trade_desk: The Trade Desk password. It is a part of the login credentials. - Service toggl_track: Your Toggl Track Password - Service ukg_pro: Your UKG Pro password. - Service unicommerce: Your uniware login password. - Service upland: Your Upland Software Password. - Service veevavault: Your Veeva Vault password. - Service walmart_dsp: Walmart DSP password. It is a part of the login credentials. - Service when_i_work: Your When I Work password. - Service wherefour: Your Wherefour password. - Service workday: Workday password. - Service workday_financial_management: Workday password. - Service workday_hcm: Workday password. - Service xandr: Your Xandr password. - Service younium: Your Younium password.
Pat string: Field usage depends on service value: - Service github: The Personal Access Token generated in Github.
PatName string: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Name.
PatSecret string: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Secret.
Path string: Field usage depends on service value: - Service jira: A URL subdirectory where the Jira instance is working.
Pats List<string>: Field usage depends on service value: - Service github: The Personal Access Tokens.
Pattern string: Field usage depends on service value: - Service aws_cost_report: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service azure_blob_storage: All files in your search path matching this regular expression will be synced. - Service box: All files in your search path matching this regular expression will be synced. - Service dropbox: All files in your search path matching this regular expression will be synced. - Service email: All files in your search path matching this regular expression will be synced. - Service ftp: All files in your search path matching this regular expression will be synced. - Service gcs: All files in your search path matching this regular expression will be synced. - Service google_drive: All files in your search path matching this regular expression will be synced. - Service kinesis: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service s3: All files in your search path matching this regular expression will be synced. - Service sftp: All files in your search path matching this regular expression will be synced. - Service share_point: All files in your search path matching this regular expression will be synced. - Service wasabi_cloud_storage: All files in your search path matching this regular expression will be synced.
PdbName string: Field usage depends on service value: - Service oracle: Optional: Required only for containerized database. - Service oracle_ebs: Optional: Required only for containerized database. - Service oracle_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases. - Service oracle_rac: Optional: Required only for containerized database. - Service oracle_rds: Optional: Required only for containerized database. - Service oracle_sap_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
PemCertificate string: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Must be populated if is_auth2_enabled is set to false.
PemPrivateKey string: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM secret key file. Must be populated if is_auth2_enabled is set to true.
PerInteractionDimensions List<string>: Field usage depends on service value: - Service double_click_campaign_manager: Per Interaction Dimensions.
PersonalAccessToken string: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail personal access token. - Service databricks_db: Access Token - Service harvest: Your Harvest Personal Access Token. - Service productive: Your Productive personal access token. - Service totango: Your Totango personal access token.
PersonalApiToken string: Field usage depends on service value: - Service circleci: Your CircleCI Personal API token. - Service monday: Your Monday.com Personal API Token.
PgpPassPhrase string: Field usage depends on service value: - Service azure_blob_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true.
PgpSecretKey string: Field usage depends on service value: - Service azure_blob_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true.
PhoneNumber string: Field usage depends on service value: - Service itunes_connect: Register the number on AppleId Account Page for 2FA
PlanType string: Field usage depends on service value: - Service justcall: Your JustCall Plan Type.
Port double: Field usage depends on service value: - Service aurora: The port number. - Service aurora_postgres: The port number. - Service aveva_pi: Port number at which the AF Server is running - Service azure_postgres: The port number. - Service azure_sql_db: The port number. - Service azure_sql_managed_db: The port number. - Service clarity: The port number. - Service cockroachdb: The port number. - Service databricks_db: The port of your SQL warehouse. - Service db2i_hva: The port number. - Service db2i_sap_hva: The port number. - Service documentdb: Port of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: The port number. - Service ehr: The port number. - Service elastic_cloud: The port number. - Service es_self_hosted: The port number. - Service ftp: FTP port. - Service google_cloud_mysql: The port number. - Service google_cloud_postgresql: The port number. - Service google_cloud_sqlserver: The port number. - Service hana_sap_hva_b1: The port number. - Service hana_sap_hva_ecc: The port number. - Service hana_sap_hva_ecc_netweaver: The port number. - Service hana_sap_hva_s4: The port number. - Service hana_sap_hva_s4_netweaver: The port number. - Service heroku_postgres: The port number. - Service jira: The Jira service host port. - Service magento_mysql: The port number. - Service magento_mysql_rds: The port number. - Service maria: The port number. - Service maria_azure: The port number. - Service maria_rds: The port number. - Service mysql: The port number. - Service mysql_azure: The port number. - Service mysql_rds: The port number. - Service netsuite_suiteanalytics: The NetSuite service host port. - Service opendistro: The port number. - Service opensearch: The port number. - Service oracle: The port number. - Service oracle_ebs: The port number. - Service oracle_hva: The port number. - Service oracle_rac: The port number. - Service oracle_rds: The port number. - Service oracle_sap_hva: The port number. - Service postgres: The port number. - Service postgres_rds: The port number. - Service redshift_db: Port number - Service sap_hana: The SAP HANA port number. - Service sap_s4hana: The SAP S/4 port number. - Service sftp: SFTP port. - Service snowflake_db: The Snowflake optional port number. - Service splunk: The Splunk service host port. - Service sql_server: The port number. - Service sql_server_hva: The port number. - Service sql_server_rds: The port number. - Service sql_server_sap_ecc_hva: The port number.
PostClickAttributionWindowSize string: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on clicks. Default value: DAY_30
PrebuiltReport string: Field usage depends on service value: - Service facebook: The name of report of which connector will sync the data. Possible prebuilt_report values. - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data.
Prefix string: Field usage depends on service value: - Service aws_cloudtrail: If prefix is present when configuring the bucket. - Service aws_cost_report: Folder path to the aws_cost_report files within the bucket. - Service aws_inventory: The prefix if you used one when configuring the bucket. - Service azure_blob_storage: All files and folders under this folder path will be searched for files to sync. - Service box: All files and folders under this folder path will be searched for files to sync. - Service cloudfront: The name of the CloudFront folder in the bucket. - Service dropbox: All files and folders under this folder path will be searched for files to sync. - Service ftp: All files and folders under this folder path will be searched for files to sync. - Service gcs: All files and folders under this folder path will be searched for files to sync. - Service google_drive: 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 - Service kinesis: Folder path to the Kinesis files within the bucket. - Service marin: Folder path to the Marin manifest file. - Service microsoft_dynamics_365_fo: Folder name in which the exported dynamics 365 data resides. - Service s3: All files and folders under this folder path will be searched for files to sync. - Service segment: Folder path to the Segment files within the bucket. Must be populated if sync_type is set to S3. - Service sftp: All files and folders under this folder path will be searched for files to sync. - Service share_point: All files and folders under this folder path link will be searched for files to sync. This can be any shared folder link. - Service wasabi_cloud_storage: All files and folders under this folder path will be searched for files to sync.
PrimaryKey string: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission primary key.
PrimaryKeys List<string>: Field usage depends on service value: - Service workday: Primary Keys
PrivateKey string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS REST API private key. - Service adobe_analytics: The complete contents of your private key file including the start and end tags (----BEGIN PRIVATE KEY---- to ----END PRIVATE KEY----). - Service adp_workforce_now: Private Key. - Service anaplan: The contents of your private key file. Must be populated if auth_mode is set to Certificate. - Service apple_search_ads: The contents of your secret key file. Must be populated if is_auth2_enabled is set to false. - Service braintree: The contents of your secret key file. - Service braintree_sandbox: The contents of your secret key file. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud private key. - Service qualtrics: Your private key - Service salesforce: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service snowflake_db: Private access key. The field should be specified if authentication type is KEY_PAIR.
PrivateToken string: Field usage depends on service value: - Service eventbrite: Your Eventbrite private token.
Product string: Field usage depends on service value: - Service webconnex: Your Webconnex product.
Profiles List<string>: Field usage depends on service value: - Service amazon_ads: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SpecificProfiles. - Service google_analytics: Specific User Profile IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_mcf: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
ProfilesAmazonDsp string: Field usage depends on service value: - Service amazon_dsp: Comma-separated list of your Amazon DSP profiles.
ProjectAccessToken string: Field usage depends on service value: - Service rollbar: Your Rollbar project access token.
ProjectCredentials List<GetConnectorConfigProjectCredential>: Field usage depends on service value: - Service amplitude: * Project(s)
ProjectId string: Field usage depends on service value: - Service bigquery_db: BigQuery project ID - Service google_analytics_360: The project ID. - Service google_analytics_4_export: The Project ID. - Service mixpanel: Project ID
ProjectIds string: Field usage depends on service value: - Service sentry: Your Sentry project IDs.
ProjectKey string: Field usage depends on service value: - Service commercetools: Your commercetools project key.
Projects List<string>: Field usage depends on service value: - Service asana: Specific Project IDs to sync. Must be populated if syncMode is set to SpecificProjects. - Service jira: Specific projects to sync. Must be populated if syncMode is set to CUSTOM.
Properties List<string>: Field usage depends on service value: - Service google_analytics_4: The array of strings in the properties/{id} format where id is a Google Analytics 4 property identifier. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
PropertyId string: Field usage depends on service value: - Service cloudbeds: Your Cloudbeds property IDs.
PublicKey string: Field usage depends on service value: - Service aurora: Public Key - Service aurora_postgres: Public Key - Service azure_blob_storage: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_cosmos_for_mongo: Public Key - Service azure_postgres: Public Key - Service azure_service_bus: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_sql_db: Public Key. - Service azure_sql_managed_db: Public Key. - Service braintree: The contents of your PEM certificate file. - Service braintree_sandbox: The contents of your PEM certificate file. - Service clarity: Public Key. - Service cockroachdb: Public Key - Service db2i_hva: Public Key - Service db2i_sap_hva: Public Key - Service documentdb: Public Key - Service dynamics_365_fo: Public Key. - Service ehr: Public Key. - Service elastic_cloud: Public Key - Service es_self_hosted: Public Key - Service google_cloud_mysql: Public Key - Service google_cloud_postgresql: Public Key - Service google_cloud_sqlserver: Public Key. - Service hana_sap_hva_b1: Public Key - Service hana_sap_hva_ecc: Public Key - Service hana_sap_hva_ecc_netweaver: Public Key - Service hana_sap_hva_s4: Public Key - Service hana_sap_hva_s4_netweaver: Public Key - Service heroku_postgres: Public Key - Service magento_mysql: Public Key - Service magento_mysql_rds: Public Key - Service maria: Public Key - Service maria_azure: Public Key - Service maria_rds: Public Key - Service mongo: Public Key - Service mongo_sharded: Public Key - Service mysql: Public Key - Service mysql_azure: Public Key - Service mysql_rds: Public Key - Service opendistro: Public Key - Service opensearch: Public Key - Service oracle: Public Key - Service oracle_ebs: Public Key - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud public key. - Service oracle_hva: Public Key - Service oracle_rac: Public Key - Service oracle_rds: Public Key - Service oracle_sap_hva: Public Key - Service partnerstack_vendor: Your PartnerStack Vendor Public key. - Service postgres: Public Key - Service postgres_rds: Public Key - Service sap_hana: Public Key - Service sap_s4hana: Public Key - Service sftp: Public Key - Service sql_server: Public Key. - Service sql_server_hva: Public Key. - Service sql_server_rds: Public Key. - Service sql_server_sap_ecc_hva: Public Key.
PublicationName string: Field usage depends on service value: - Service aurora_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service azure_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service google_cloud_postgresql: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service heroku_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres_rds: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT".
PublisherId string: Field usage depends on service value: - Service skimlinks: Your Skimlinks publisher ID.
PullArchivedCampaigns bool: Field usage depends on service value: - Service outbrain: Include or ignore results from archived campaigns
PythonVersion string
QueryId string: Field usage depends on service value: - Service google_display_and_video_360: The ID of the query whose configuration you want to reuse. This is a required parameter when config_method is set to REUSE_EXISTING.
QueryParamValue string: Field usage depends on service value: - Service alchemer: Your Alchemer API key. - Service birdeye: Your Birdeye query-param-value.
QuotaProjectId string: Field usage depends on service value: - Service bigquery_db: Specify a different project ID to account for quota and billing of Fivetran query workload
QuoteChar string: Field usage depends on service value: - Service azure_blob_storage: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service gcs: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service google_drive: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service s3: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service sftp: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service share_point: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
QuoteCharacterEnabled bool: Field usage depends on service value: - Service azure_blob_storage: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service gcs: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service google_drive: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service s3: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service sftp: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service share_point: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
RateLimitPlan string: Field usage depends on service value: - Service vimeo: Your Vimeo rate limit plan.
RefreshToken string: Field usage depends on service value: - Service ironsource: Your Ironsource Client Secret.
RefreshTokenExpiresAt string: Field usage depends on service value: - Service pinterest_ads: The expiration date of the refresh token. Unix timestamp in seconds
Region string: Field usage depends on service value: - Service algolia: Your Algolia analytics region. - Service amazon_ads: The region used by the Amazon Ads profile. - Service amazon_selling_partner: The region used by the Amazon Selling Partner profile. - Service anaplan: Your Anaplan account region - Service atlassian_ops_genie: Your company's Osgenie region (usually company.opsgenie.com) - Service awin: Your Awin Region. - Service aws_lambda: The AWS region code for the DynamoDB instance. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Region - Service concur: The region. - Service cvent: Your Cvent region. - Service everflow: Your Everflow region. - Service exact_online: Your Exact Online region. - Service getfeedback: Your GetFeedback region. - Service happyfox: Your HappyFox region. - Service keypay: Your KeyPay region. - Service medallia_agile_research: Your Medallia Agile region. - Service messagebird: Your MessageBird Account region. - Service mixpanel: Data Region - Service navan: Your Navan region. - Service on24: Your ON24 region. - Service pendo: The Pendo account region. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Region. - Service ringover: Your Ringover region. - Service samsara: The region of your Samsara account. For instance, if your region is EUROPE, provide eu.samsara in the Region field. If your region is not in Europe, provide samsara. - Service snyk: Your Snyk region. - Service talkdesk: Your Talkdesk region (".com",".eu","ca.com") - Service totango: Your Totango region. - Service transcend: Your Transcend region. - Service vonage_contact_center: Your Vonage Contact Center region. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: US_EAST_1. - Service workday_strategic_sourcing: Your Workday Strategic Sourcing Region. - Service zoho_books: Your Zoho Books application host region. - Service zoho_campaigns: Your Zoho Campaigns application host region. - Service zoho_desk: Your Zoho Desk domain. - Service zoho_inventory: Your Zoho Inventory application host region.
RegionApiUrl string: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution API URL region.
RegionAuthUrl string: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution auth URL region.
RegionTokenUrl string: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution token URL region.
RegionUrl string: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management region URL.
ReplicaId double: Field usage depends on service value: - Service aurora: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service google_cloud_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
ReplicationSlot string: Field usage depends on service value: - Service aurora_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service azure_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service google_cloud_postgresql: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service heroku_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres_rds: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT".
ReportConfigs List<GetConnectorConfigReportConfig>: Field usage depends on service value: - Service yahoo_dsp: Specify the reports you want to sync. This is optional.
ReportConfigurationIds List<string>: Field usage depends on service value: - Service double_click_campaign_manager: You can select only one Floodlight Configuration ID per account.
ReportFormatType string: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
ReportGranularity string: Field usage depends on service value: - Service pinterest_ads: Granularity at which reports will be
ReportKeys string: Field usage depends on service value: - Service rakutenadvertising: Your Rakuten Advertising report keys.
ReportLists List<GetConnectorConfigReportList>: Field usage depends on service value: - Service spotify_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
ReportServiceApiKey string: Field usage depends on service value: - Service adyen: Your Report Service API key.
ReportSuites List<string>
ReportTimezone string: Field usage depends on service value: - Service criteo: Report Timezone
ReportType string: Field usage depends on service value: - Service adroll: The report type you want. Default value: ALL_ADS. - Service double_click_campaign_manager: Type of reporting data to sync. Default value: STANDARD. - Service google_display_and_video_360: The type of the report to create. This is a required parameter when config_method is set to CREATE_NEW. - Service youtube_analytics: The name of report of which connector will sync the data.
ReportUrl string: Field usage depends on service value: - Service workday: URL for a live custom report.
Reports List<GetConnectorConfigReport>: Field usage depends on service value: - Service google_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics_4: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_search_ads_360: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service google_search_console: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service workday: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
ReportsLinkedinAds List<string>: Field usage depends on service value: - Service linkedin_ads: Specific analytics reports to sync. Must be populated if adAnalytics is set to 'SpecificReports'.
Repositories List<string>: Field usage depends on service value: - Service github: Specific Repository IDs to sync. Must be populated if syncMode is set to SpecificRepositories.
ResourceToken string: Field usage depends on service value: - Service cosmos: A token that provides access to a specific Azure Cosmos DB resource. Required for the RESOURCE_TOKEN data access method.
ResourceUrl string: Field usage depends on service value: - Service dynamics_365: URL at which Dynamics 365 is accessed
RestApiLimit double: Field usage depends on service value: - Service pardot: The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
RfcLibraryPath string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service hana_sap_hva_s4_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service oracle_sap_hva_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files.
Role string: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Role ID for connection. - Service snowflake_db: Snowflake Connector role name
RoleArn string: Field usage depends on service value: - Service appsflyer: S3 Role ARN - Service aws_cloudtrail: The Role ARN required for authentication. - Service aws_cost: The Role ARN required for authentication. - Service aws_cost_report: The Role ARN required for authentication. - Service aws_inventory: The Role ARN required for authentication. - Service aws_lambda: The Role ARN required for authentication. - Service aws_msk: If sasl_mechanism is set to IAM, enter your Role ARN - Service cloudfront: The Role ARN required for authentication. - Service dynamodb: Role ARN - Service heap: The Role ARN required for authentication. - Service kinesis: The Role ARN required for authentication. - Service s3: The Role ARN required for authentication. Required for connector creation when syncing using private bucket. - Service segment: The Role ARN required for authentication. Must be populated if sync_type is set to S3.
RollbackWindow double: Field usage depends on service value: - Service appsflyer: Rollback window
RollbackWindowSize double: Field usage depends on service value: - Service bingads: A period of time in days during which a conversion is recorded.
S3Bucket string: Field usage depends on service value: - Service webhooks: The S3 bucket name. Required if bucket_service is set to S3.
S3ExportBucket string: Field usage depends on service value: - Service braze: Your S3 user export bucket. Required if AWS_S3 is the export_storage_type
S3ExportExternalId string: Field usage depends on service value: - Service braze: This is the same as your group_id, used if export_storage_type is AWS_S3
S3ExportFolder string: Field usage depends on service value: - Service braze: Your S3 user export folder name. Required if AWS_S3 is the export_storage_type
S3ExportRoleArn string: Field usage depends on service value: - Service braze: The Role ARN required for authentication required if AWS_S3 is the export_storage_type
S3RoleArn string: Field usage depends on service value: - Service adjust: Used if the export_storage_type is AWS_S3, the Role ARN required for authentication. - Service webhooks: The Role ARN required for authentication. Required if bucket_service is set to S3.
S3bucket string: Field usage depends on service value: - Service adobe_analytics_data_feed: The S3 bucket name. - Service braze: Your S3 bucket required if AWS_S3 is the cloud_storage_type - Service sailthru: Name of the bucket configured to receive sailthru connect data.
S3externalId string: Field usage depends on service value: - Service braze: 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 - Service sailthru: The external ID is a string that designates who can assume the role.
S3folder string: Field usage depends on service value: - Service braze: Your S3 folder name required if AWS_S3 is the cloud_storage_type
S3path string: Field usage depends on service value: - Service sailthru: Copy and use this to configure Sailthru Connect in your sailthru account.
S3roleArn string: Field usage depends on service value: - Service adobe_analytics_data_feed: The Role ARN required for authentication. - Service braze: The Role ARN required for authentication required if AWS_S3 is the cloud_storage_type - Service sailthru: Role ARN of the IAM role created for Fivetran.
SalesAccountSyncMode string: Field usage depends on service value: - Service itunes_connect: Whether to sync all sales accounts or specific sales accounts.
SalesAccounts List<string>: Field usage depends on service value: - Service itunes_connect: Specific sales account to sync. Must be populated if sales_account_sync_mode is set to SpecificSalesAccounts.
SalesforceSecurityToken string: Field usage depends on service value: - Service pardot: The Pardot user's Salesforce SSO Account Security Token.
SandboxAccount string: Field usage depends on service value: - Service gocardless: Your GoCardless account type.
SapSchema string: Field usage depends on service value: - Service db2i_hva: The SAP schema. - Service db2i_sap_hva: SAP schema name. - Service sql_server_hva: SAP Schema Name. Required only for High-Volume Agent SAP ECC connector. - Service sql_server_sap_ecc_hva: SAP Schema Name.
SapSourceSchema string: Field usage depends on service value: - Service hana_sap_hva_b1: The schema name where the HANA tables reside. - Service hana_sap_hva_ecc: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_ecc_netweaver: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4_netweaver: The Hana schema name where the SAP tables reside.
SapUser string: Field usage depends on service value: - Service oracle_sap_hva: The Oracle schema name where the SAP tables reside.
SaslMechanism string: Field usage depends on service value: - Service apache_kafka: SASL Mechanism - Service aws_msk: If security_protocol is set to SASL, enter the SASL Mechanism
SaslPlainKey string: Field usage depends on service value: - Service apache_kafka: API Key
SaslPlainSecret string: Field usage depends on service value: - Service apache_kafka: API Secret
SaslScram256Key string: Field usage depends on service value: - Service apache_kafka: API Key
SaslScram256Secret string: Field usage depends on service value: - Service apache_kafka: API Secret
SaslScram512Key string: Field usage depends on service value: - Service apache_kafka: API Key - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
SaslScram512Secret string: Field usage depends on service value: - Service apache_kafka: API Secret - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
SchemaRegistryCredentialsSource string: Field usage depends on service value: - Service apache_kafka: Schema Registry Credentials source - Service aws_msk: Schema Registry Credentials source - Service confluent_cloud: Schema Registry Credentials source
SchemaRegistryKey string: Field usage depends on service value: - Service apache_kafka: Schema Registry Key - Service aws_msk: Schema Registry Key - Service azure_service_bus: The key used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Key
SchemaRegistrySecret string: Field usage depends on service value: - Service apache_kafka: Schema Registry Secret - Service aws_msk: Schema Registry Secret - Service azure_service_bus: The secret used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Secret
SchemaRegistryUrls List<string>: Field usage depends on service value: - Service apache_kafka: Your schema registry URLs - Service aws_msk: Your schema registry URLs - Service azure_service_bus: The comma-separated list of schema registry servers in the server:port format - Service confluent_cloud: Your schema registry URLs
Scope string: Field usage depends on service value: - Service ebay: Your eBay scopes.
Scopes string: Field usage depends on service value: - Service cornerstone: Your Cornerstone scopes.
Seats List<string>: Field usage depends on service value: - Service yahoo_dsp: Specific Seats to sync. Must be populated if sync_mode_seat is set to SPECIFIC_SEATS.
Secret string: Field usage depends on service value: - Service appcues: Your Appcues Secret. - Service buildium: Your Buildium API secret. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure secret. - Service loopio: Your Loopio Secret. - Service mode: Your Mode Secret. - Service playvox_workforce_management: Your Playvox Workforce Management client secret. - Service twilio: The Twilio API secret - Service uservoice: The UserVoice API secret. - Service venminder: Your Venminder secret. - Service vts: Your VTS secret.
SecretKey string: Field usage depends on service value: - Service afterpay: Your Afterpay Secret Key. - Service appsflyer: Your AWS secret key. - Service bigquery_db: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service checkr: Your Checkr secret key. - Service ezofficeinventory: Your EZOfficeInventory API secret key. - Service gcs: Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket. - Service ironsource: Your Ironsource Client ID. - Service line_ads: Your LINE Ads secret key. - Service mailjet: Your Mailjet secret key. - Service partnerstack_vendor: Your PartnerStack Vendor Secret key. - Service paypal: Client Secret of your PayPal client application. - Service paypal_sandbox: Client Secret of your PayPal client application. - Service phoenix_ads: Your Phoenix Ads Secret key. - Service retailnext: Your RetailNext secret key. - Service statsig: Your Statsig secret key. - Service yotpo: Your Yotpo Secret key
Secrets string: Field usage depends on service value: - Service aws_lambda: The secrets that should be passed to the function at runtime. - Service azure_function: The secrets that should be passed to the function at runtime. - Service google_cloud_function: The secrets that should be passed to the function at runtime.
SecretsLists List<GetConnectorConfigSecretsList>: Field usage depends on service value: - Service aws_lambda: List of Secrets that should be passed to the function at runtime. - Service azure_function: The list of secrets that should be passed to the function at runtime. - Service google_cloud_function: The list of secrets that should be passed to the function at runtime.
SecurityProtocol string: Field usage depends on service value: - Service apache_kafka: Security protocol for Kafka interaction. - Service aws_msk: The security protocol for Kafka interaction. - Service confluent_cloud: Security protocol for Confluent Cloud interaction. - Service heroku_kafka: Security protocol for Heroku Kafka interaction.
Segments List<string>: Field usage depends on service value: - Service google_analytics: 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.
SelectedEventTypes List<string>: Field usage depends on service value: - Service salesforce_marketing_cloud: Select the event types to be synced.
SelectedExports List<string>: Field usage depends on service value: - Service anaplan: 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.
SenderId string: Field usage depends on service value: - Service sage_intacct: Your Sender ID
SenderPassword string: Field usage depends on service value: - Service sage_intacct: Your Sender Password
Server string: Field usage depends on service value: - Service castor_edc: Your Castor EDC Server.
ServerAddress string: Field usage depends on service value: - Service tableau_source: Your Tableau Source server address.
ServerRegion string: Field usage depends on service value: - Service clockify: Your Clockify server region.
ServerUrl string: Field usage depends on service value: - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence Instance URL. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud Instance URL.
ServerVariable string: Field usage depends on service value: - Service myosh: Your myosh server variable.
Servers List<string>: Field usage depends on service value: - Service apache_kafka: Comma-separated list of Kafka servers in the format server:port. - Service aws_msk: Comma-separated list of Kafka servers in the server:port format. - Service confluent_cloud: Comma-separated list of Confluent Cloud servers in the format server:port. - Service heroku_kafka: Comma-separated list of Heroku Kafka servers in the format server:port.
ServiceAccount string: Field usage depends on service value: - Service google_drive: Share the folder with the email address
ServiceAccountEmail string: Field usage depends on service value: - Service google_cloud_function: Provide Invoker role to this service account.
ServiceAccountKey string: Field usage depends on service value: - Service firebase: The contents of your service account key file. Required for authentication.
ServiceAccountSecret string: Field usage depends on service value: - Service mixpanel: Service Account Secret
ServiceAccountUsername string: Field usage depends on service value: - Service mixpanel: Service Account Username
ServiceAuthentication string: Field usage depends on service value: - Service dsv: A base64 encoded variant of your username:password string. Required for authentication.
ServiceName string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service walmart_marketplace: Your Walmart Marketplace service name.
ServiceVersion string
SftpHost string: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP host. - Service salesforce_marketing_cloud: Host
SftpIsKeyPair bool: Field usage depends on service value: - Service adobe_analytics_data_feed: Log in with key pair or password - Service salesforce_marketing_cloud: Set this field if you use a key pair for logging into your SFTP server. Don't set it if you use a username and password
SftpPassword string: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP password required if sftp_is_key_pair is false - Service salesforce_marketing_cloud: Password
SftpPort double: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP port. - Service salesforce_marketing_cloud: Port
SftpPublicKey string: Field usage depends on service value: - Service adobe_analytics_data_feed: Public Key - Service salesforce_marketing_cloud: Public Key
SftpUser string: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP user. - Service salesforce_marketing_cloud: User
ShareUrl string: Field usage depends on service value: - Service share_point: Your SharePoint folder URL. You can find the folder URL by following the steps mentioned here.
SheetId string: Field usage depends on service value: - Service google_sheets: 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.
Shop string: Field usage depends on service value: - Service shopify: The Shopify shop name. Can be found in the URL before .myshopify.com.
ShopDomain string: Field usage depends on service value: - Service triple_whale: Your Triple Whale shop domain.
ShortCode string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce eight-character string assigned to a realm for routing purposes.
ShouldSyncEventsWithDeletedProfiles bool: Field usage depends on service value: - Service klaviyo: Sync events linked to deleted profiles
ShowRecordsWithNoMetrics bool: Field usage depends on service value: - Service apple_search_ads: Turn the toggle on if you want the reports to also return records without metrics.
Sid string: Field usage depends on service value: - Service twilio: The Twilio API key SID
SignerPublicKey string: Field usage depends on service value: - Service azure_blob_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service ftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service gcs: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service s3: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service sftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service wasabi_cloud_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed.
SiteAddress string: Field usage depends on service value: - Service teamwork: Your Teamwork site address.
SiteId string: Field usage depends on service value: - Service microsoft_lists: The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the id field in the Graph API response for sites. - Service salesforce_commerce_cloud: The name of the site from which you want to sync data.
SiteName string: Field usage depends on service value: - Service microsoft_lists: The Name of the SharePoint site. The Site Name is the name field in the Graph API response for sites. - Service tableau_source: Your Tableau Source site name.
SiteUrls List<string>: Field usage depends on service value: - Service google_search_console: Specific Site URLs to sync. Must be populated if sync_mode is set to SpecificSites.
SkipAfter double: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service box: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service dropbox: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service email: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service ftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service gcs: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service google_drive: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination. - Service sftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service share_point: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service wasabi_cloud_storage: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
SkipBefore double: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified before syncing data. - Service box: We will skip over the number of lines specified before syncing data. - Service dropbox: We will skip over the number of lines specified before syncing data. - Service email: We will skip over the number of lines specified before syncing data. - Service ftp: We will skip over the number of lines specified before syncing data. - Service gcs: We will skip over the number of lines specified before syncing data. - Service google_drive: We will skip over the number of lines specified before syncing data. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified before syncing data. - Service sftp: We will skip over the number of lines specified before syncing data. - Service share_point: We will skip over the number of lines specified before syncing data. - Service wasabi_cloud_storage: We will skip over the number of lines specified before syncing data.
SkipEmptyReports bool: Field usage depends on service value: - Service google_ads: Toggles the "Skip empty reports" feature. Enabled by default
SncCertificate string
SncCertificateSource string
SncFivetranName string
SncLibraryPath string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Path to the external security product's library. - Service hana_sap_hva_s4_netweaver: Path to the external security product's library.
SncMode string
SncMyName string
SncName string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Client SNC name. - Service hana_sap_hva_s4_netweaver: Client SNC name.
SncPartnerName string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Communication partner's SNC name. - Service hana_sap_hva_s4_netweaver: Communication partner's SNC name.
SncSourceName string
SoapUri string: Field usage depends on service value: - Service marketo: Marketo SOAP API Endpoint.
SocialDataSyncTimeframe string: Field usage depends on service value: - Service linkedin_company_pages: The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: SIX .
Source string: Field usage depends on service value: - Service adobe_analytics_data_feed: The data source.
StoreHash string: Field usage depends on service value: - Service big_commerce: The BigCommerce store hash.
StoreId string: Field usage depends on service value: - Service reviewsio: Your REVIEWS.io store ID
SubDomain string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS subdomain. - Service activecampaign: Your ActiveCampaign sub-domain. - Service acumatica: Your Acumatica subdomain. - Service ada: Your Ada sub-domain. - Service alchemer: Your Alchemer sub-domain. - Service atlassian_jira_align: Your Jira Align base URL. - Service azure_boards: Your Azure Boards Organization Name. - Service azure_devops: Your Azure Organization Name - Service betterworks: Your Betterworks subdomain. - Service bubble: Your Bubble subdomain. - Service buildium: Your Buildium subdomain. - Service canvas_by_instructure: Your Canvas by Instructure domain. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 subdomain. - Service chargebee_product_catalog_2: Your Chargebee subdomain. - Service checkr: Your Checkr subdomain. - Service clubspeed: Your Clubspeed subdomain. - Service collibra: Your collibra subdomain. - Service compliance_checkpoint: Your Compliance Checkpoint subdomain. - Service concord: Your Concord Sub Domain. - Service contrast_security: Your Contrast Security subdomain. - Service customerio: Your Customer.io region-specific Subdomain. - Service dbt_cloud: Your dbt Cloud API server region. - Service deputy: Your Deputy subdomain. - Service docebo: Your Docebo subdomain. - Service drata: Your Drata sub_domain. - Service eventsforce: Your Eventsforce subdomain. - Service ezofficeinventory: Your EZOfficeInventory Subdomain. - Service fountain: Your Fountain subdomain. - Service freshchat: Your Freshchat Sub Domain - Service gainsight_customer_success: The subdomain of your Gainsight account. - Service gainsight_product_experience: Your Gainsight Product Experience subdomain. - Service genesys: Your Genesys subdomain. - Service green_power_monitor: Your GreenPowerMonitor subdomain. - Service infobip: Your Infobip sub_domain. - Service insightly: Your company's Insightly subdomain name. - Service instructure: The Sub domain in which your Instructure account is hosted. - Service jamf: Your Jamf subdomain. - Service kandji: Your Kandji Subdomain. - Service khoros_care: Your Khoros Care subDomain. - Service looker_source: Your looker SubDomain name. - Service lucca: Your Lucca subdomain. - Service mailgun: Your Mailgun subdomain. - Service matomo: Your Matomo subdomain. - Service maxio_chargify: Enter Your Subdomain. - Service myosh: Your myosh subdomain. - Service namely: Your Namely subdomain. - Service nylas: Your Nylas subdomain. - Service okta: Your Okta subdomain. - Service picqer: Your Picqer subdomain. - Service pinpoint: Your Pinpoint sub domain name. - Service piwik_pro: Your Piwik PRO subdomain. - Service playvox: Your Playvox Subdomain. - Service posthog: Your PostHog data region (app or eu). - Service recurly: Your company's Recurly subdomain. - Service reltio: Your Reltio subdomain. - Service revel: Your Revel Systems subDomain. - Service rundeck: Your Rundeck subdomain. - Service sage_hr: Your Sage HR subdomain. - Service salesforce_marketing_cloud: Your Salesforce Marketing Cloud subdomain. - Service salsify: Your Salsify Organization ID. - Service sap_success_factors: Your SAP SuccessFactors Subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service starrez: Your StarRez subdomain - Service sugarcrm: Your SugarCRM subdomain. - Service tableau_source: Your Tableau Source subdomain. - Service tempo: Your Tempo subdomain. - Service testrail: Your TestRail subdomain. - Service thinkific: Your Thinkific subdomain. - Service totango: Your Totango Subdomain. - Service tymeshift: Your Tymeshift subdomain. - Service upland: Your Upland Software subDomain. - Service wordpress: Your WordPress subdomain. - Service workable: Your Workable Subdomain. - Service wrike: Your Wrike Subdomain.
Subdomain string: Field usage depends on service value: - Service bamboohr: The subdomain used to access your account. If you access BambooHR at 'https://mycompany.bamboohr.com', then the subdomain is 'mycompany'. - Service datadog: Your Datadog subdomain. - Service ebay: Your eBay environment. - Service freshdesk: Your company's freshdesk subdomain (usually company.freshdesk.com). - Service freshsales: Your Freshsales domain. - Service freshservice: Your company's freshservice subdomain (usually company.freshservice.com). - Service freshsuccess: Your Freshsuccess subdomain. - Service gorgias: Your Gorgias subdomain. - Service jama_software: Your Jama Software subdomain. - Service klarna: Your Klarna subdomain. - Service learnupon: Your Learnupon subdomain. - Service maxio_saasoptics: Your Maxio SaaSOptics subdomain. - Service medallia: Medallia subdomain - Service packiyo: Your Packiyo subdomain. - Service qmatic_data_connect: Your Qmatic Data Connect subdomain. - Service sana: Your Sana subdomain. - Service skillstx: Your SkillsTX subdomain. - Service smarthr: Your SmartHR subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service toast: Your Toast domain. - Service vts: Your VTS Subdomain. - Service zendesk_chat: Your Zendesk domain.
SubscriberName string: Field usage depends on service value: - Service azure_service_bus: 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
Subscription string: Field usage depends on service value: - Service retailnext: Your RetailNext subscription.
SubscriptionKey string: Field usage depends on service value: - Service dsv: Your DSV subscription key.
SupportConnectedAccountsSync bool: Field usage depends on service value: - Service stripe: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts. - Service stripe_test: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.
SupportNestedColumns bool: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
SurveyIds string: Field usage depends on service value: - Service qualaroo: Array of Qualaroo Survey IDs.
SwipeAttributionWindow string: Field usage depends on service value: - Service snapchat_ads: The time period to attribute conversions based on swipes. Default value: DAY_28
SyncDataLocker bool: Field usage depends on service value: - Service appsflyer: Sync AppsFlyer Data Locker. Default value is true, set it to false to sync AppsFlyer data using only webhooks.
SyncFormat string: Field usage depends on service value: - Service webhooks: The webhooks sync format. Default value: Unpacked. Unpacked messages must be valid JSON.
SyncFormulaFields bool: Field usage depends on service value: - Service financial_force: Enable this option to sync formula fields directly (default value = false) - Service salesforce: Enable this option to sync formula fields directly (default value = false) - Service salesforce_sandbox: Enable this option to sync formula fields directly (default value = false)
SyncMetadata bool: Field usage depends on service value: - Service facebook_ads: Parameter defining whether to enable or disable metadata synchronisation. Default value: TRUE.
SyncMethod string: Field usage depends on service value: - Service aws_lambda: Sync Method
SyncMode string: Field usage depends on service value: - Service adroll: Whether to sync all advertisables or specific advertisables. Default value: AllAdvertisables. - Service amazon_ads: Option to select connector should sync all profiles or specific profiles. - Service anaplan: Whether to sync all exports or specific exports. - Service apple_search_ads: Sync Mode - Service asana: Whether to sync all projects or specific projects. - Service bingads: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service double_click_campaign_manager: Whether to sync all user profiles or specific ones. Default value: AllAccounts. - Service dynamodb: Which packed mode setting to use. Default value: UsePackedModeOnly. - Service facebook: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_ad_account: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service facebook_ads: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_pages: Whether to sync all accounts or specific accounts. Default value: AllPages. - Service github: Whether to sync all repositories or specific repositories. - Service google_ads: Whether to sync all accounts or specific accounts. - Service google_analytics: Whether to sync all accounts or specific accounts. - Service google_analytics_4: Whether to sync all accounts or specific accounts. - Service google_analytics_mcf: Whether to sync all accounts or specific accounts. Default value: ALL_ACCOUNTS - Service google_search_console: Whether to sync all sites or specific sites. - Service instagram_business: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service iterable: Events Sync Mode. - Service jira: Whether to sync all projects or specific projects. - Service linkedin_ads: Whether to sync all accounts or specific accounts. Default value: AllAccounts - Service pendo: Whether to sync all App IDs or specific App IDs. Default value: AllAppIds. - Service pinterest_ads: Whether to sync all advertisers or specific advertisers. - Service reddit_ads: Whether to sync all accounts or specific accounts. - Service salesforce_marketing_cloud: Select the sync mode. - Service snapchat_ads: Whether to sync all organizations or specific organizations. Default value: AllOrganizations. - Service spotify_ads: Whether to sync all ad accounts or specific ad accounts. - Service taboola: Whether to sync all accounts or specific accounts. - Service the_trade_desk: Whether to sync all accounts or specific accounts. - Service tiktok_ads: Whether to sync all advertiser accounts or specific accounts. - Service twilio: Whether to sync all accounts or specific accounts. - Service twitter: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service twitter_ads: Whether to sync all accounts or specific accounts. - Service walmart_dsp: Whether to sync all accounts or specific accounts. - Service yahoo_gemini: Whether to sync all accounts or specific accounts. Default value: SpecificAccounts. - Service zuora: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both. - Service zuora_sandbox: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both.
SyncModeAdvertiser string: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all advertisers or specific advertisers. Default value: ALL_ADVERTISERS.
SyncModeSeat string: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all seats or specific seats. Default value: ALL_SEATS.
SyncMultipleAccounts bool: Field usage depends on service value: - Service reddit_ads: 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
SyncPackMode string: Field usage depends on service value: - Service cosmos: 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 Azure Cosmos DB Sync Pack Mode Options documentation. - Service documentdb: Indicates whether synced data will be packed into a single entry(column), or unpacked with one layer of nested fields.
SyncPullApi bool: Field usage depends on service value: - Service appsflyer: These options are for Appsflyer's Pull API, and are only necessary for syncing events from Pull API.
SyncType string: Field usage depends on service value: - Service apache_kafka: Kafka sync type. Unpacked messages must be valid JSON. - Service aws_msk: The sync type. Unpacked messages must be valid JSON. - Service azure_event_hub: Sync type. Unpacked messages must be valid JSON. - Service azure_service_bus: 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 - Service confluent_cloud: Kafka sync type. Unpacked messages must be valid JSON. - Service heroku_kafka: Heroku Kafka sync type. Unpacked messages must be valid JSON. - Service segment: The Segment connector sync type.
Sysnr string
SystemId string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
TableId string: Field usage depends on service value: - Service pigment: Your Pigment table ID.
TableName string: Field usage depends on service value: - Service airtable: Name of table in Airtable
TablesWithoutAccessUpdatedAt string: Field usage depends on service value: - Service hubspot: Timestamp to indicate when tables without access was updated
TargetEntityId string: Field usage depends on service value: - Service culture_amp: Your Culture Amp Target entity ID.
TargetHost string: Field usage depends on service value: - Service d2l_brightspace: Your D2L Brightspace target host.
TdeCertificate string: Field usage depends on service value: - Service sql_server_hva: Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Certificate used to protect a database encryption key
TdeCertificateName string: Field usage depends on service value: - Service sql_server_hva: Name of the Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Name of the Certificate used to protect a database encryption key
TdePassword string: Field usage depends on service value: - Service sql_server_hva: Password of the TDE private key - Service sql_server_sap_ecc_hva: Password of the TDE private key
TdePrivateKey string: Field usage depends on service value: - Service sql_server_hva: Private key associated with the TDE certificate - Service sql_server_sap_ecc_hva: Private key associated with the TDE certificate
TeamId string: Field usage depends on service value: - Service asana: Team ID
TechnicalAccountId string: Field usage depends on service value: - Service adobe_analytics: Technical Account ID from the Service Account (JWT) credentials of your Adobe Project.
TemplateLabels List<string>: Field usage depends on service value: - Service mandrill: Provide the labels to filter the templates
Tenant string: Field usage depends on service value: - Service microsoft_entra_id: Your Microsoft Entra ID Tenant. - Service microsoft_power_bi: Your Microsoft Power BI tenant. - Service microsoft_teams: Your Microsoft Teams Tenant. - Service unicommerce: Your uniware tenant. - Service workday: Workday tenant name - Service workday_financial_management: Workday tenant name - Service workday_hcm: Workday tenant name
TenantAppUrl string: Field usage depends on service value: - Service planful: Your Planful tenant app URL.
TenantCode string: Field usage depends on service value: - Service deposco: Your Deposco tenant code.
TenantConfigs List<GetConnectorConfigTenantConfig>: Field usage depends on service value: - Service reltio: * tenant(s)
TenantId string: Field usage depends on service value: - Service azure_sql_db: Azure AD tenant ID. - Service azure_sql_managed_db: Azure AD tenant ID. - Service business_central: Tenant ID of your Business Central application - Service crowddev: Your crowd.dev Tenant ID. - Service reltio: Your Reltio tenant ID. - Service servicetitan: Your ServiceTitan tenant ID. - Service visma: Your Visma tenant ID.
TenantName string: Field usage depends on service value: - Service mambu: Your Mambu tenant name.
TenantUrl string: Field usage depends on service value: - Service ivanti: Your Ivanti Tenant URL. - Service playvox_workforce_management: Your Playvox Workforce Management tenant URL. - Service reltio: Your Reltio tenant URL.
TestTableName string: Field usage depends on service value: - Service sap_hana: testTableName - Service sap_s4hana: testTableName
TimeZone string: Field usage depends on service value: - Service pardot: The time zone configured in your Pardot instance. An empty value defaults to UTC+00:00.
TimeframeMonths string: Field usage depends on service value: - Service adobe_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector has been created. Default value: TWELVE . - Service adroll: 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. - Service apple_search_ads: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service bingads: 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. - Service criteo: 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. NOTE: The greater number of months means the initial sync will take more time. - Service double_click_campaign_manager: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service double_click_publishers: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service facebook: 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. - Service facebook_ads: 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. - Service google_ads: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: TWELVE. - Service google_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_4: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_mcf: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service google_display_and_video_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service google_search_ads_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service google_search_console: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service instagram_business: 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. - Service itunes_connect: Historical sync time frame in months. - Service linkedin_ads: 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. - Service outbrain: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service pinterest_ads: 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. - Service reddit_ads: 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. - Service snapchat_ads: 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. - Service spotify_ads: 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: SIX. - Service taboola: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service the_trade_desk: 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. - Service tiktok_ads: 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. - Service twitter: 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. - Service twitter_ads: Historical sync timeframe in months. - Service walmart_dsp: 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. - Service yahoo_dsp: Number of monthsworth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value:THREE. - Service yahoo_gemini: 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`.
Timezone string: Field usage depends on service value: - Service rokt: Your Rokt timezone.
TimezoneMode string: Field usage depends on service value: - Service apple_search_ads: Determines whether to use UTC or the users timezone from the apple account
Tns string: Field usage depends on service value: - Service oracle_hva: Single-tenant database: The database's SID. Multi-tenant database: The database's TNS. - Service oracle_sap_hva: Single-tenant database: The database SID. Multi-tenant database: The database TNS.
ToastId string: Field usage depends on service value: - Service toast: Your Toast Restaurant External ID.
Token string: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities token. - Service matomo: Your Matomo auth token. - Service mode: Your Mode Token. - Service oracle_moat_analytics: Your Oracle Moat Analytics Token. - Service shareasale: Your ShareASale token. - Service solarwinds_service_desk: Your SolarWinds Service Desk token.
TokenAuthenticatedContainer string: Field usage depends on service value: - Service cosmos: The container name. Required for the RESOURCE_TOKEN data access method.
TokenAuthenticatedDatabase string: Field usage depends on service value: - Service cosmos: The database name. Required for the RESOURCE_TOKEN data access method.
TokenId string: Field usage depends on service value: - Service chargedesk: Your ChargeDesk token ID. - Service mux: Your Mux token ID
TokenKey string: Field usage depends on service value: - Service netsuite_suiteanalytics: Token ID - Service on24: Your ON24 token key. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Token Key.
TokenSecret string: Field usage depends on service value: - Service netsuite_suiteanalytics: Token Secret - Service on24: Your ON24 token secret.
TokenSecretKey string: Field usage depends on service value: - Service mux: Your Mux token secret key
TokenUrlRegion string: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP token URL region.
Topics List<string>: Field usage depends on service value: - Service azure_service_bus: The comma-separated list of topics which should be synced. Required if you do not have manage permissions
TrustStoreType string: Field usage depends on service value: - Service heroku_kafka: Trust Store Type
TrustedCert string: Field usage depends on service value: - Service apache_kafka: Kafka trusted certificate. - Service heroku_kafka: Heroku Kafka trusted certificate. Required for TLS security protocol.
Truststore string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Truststore File as Base64 encoded string.
TunnelHost string: Field usage depends on service value: - Service aurora: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service aurora_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_cosmos_for_mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_managed_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service clarity: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service cockroachdb: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service db2i_hva: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service db2i_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service documentdb: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service dynamics_365_fo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service ehr: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service elastic_cloud: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service es_self_hosted: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service google_cloud_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_postgresql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_sqlserver: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_b1: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service heroku_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo_sharded: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service opendistro: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service opensearch: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service oracle: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_ebs: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rac: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_s4hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sftp: Tunnel host address, specify only to connect via SSH tunnel. - Service sql_server: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_sap_ecc_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
TunnelPort double: Field usage depends on service value: - Service aurora: SSH port, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH port, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH port, specify only to connect via an SSH tunnel. - Service clarity: SSH port, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH port, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service documentdb: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH port, specify only to connect via an SSH tunnel. - Service ehr: SSH port, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH port, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH port, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH port, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service maria: SSH port, specify only to connect via an SSH tunnel. - Service maria_azure: SSH port, specify only to connect via an SSH tunnel. - Service maria_rds: SSH port, specify only to connect via an SSH tunnel. - Service mongo: SSH port, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH port, specify only to connect via an SSH tunnel. - Service mysql: SSH port, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH port, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service opendistro: SSH port, specify only to connect using an SSH tunnel. - Service opensearch: SSH port, specify only to connect using an SSH tunnel. - Service oracle: SSH port, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH port, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service postgres: SSH port, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH port, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH port, specify only to connect via an SSH tunnel. - Service sftp: Tunnel port, specify only to connect via SSH tunnel. - Service sql_server: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH port, specify only to connect via an SSH tunnel.
TunnelUser string: Field usage depends on service value: - Service aurora: SSH user, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH user, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH user, specify only to connect via an SSH tunnel. - Service clarity: SSH user, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH user, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service documentdb: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH user, specify only to connect via an SSH tunnel. - Service ehr: SSH user, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH user, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH user, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH user, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service maria: SSH user, specify only to connect via an SSH tunnel. - Service maria_azure: SSH user, specify only to connect via an SSH tunnel. - Service maria_rds: SSH user, specify only to connect via an SSH tunnel. - Service mongo: SSH user, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH user, specify only to connect via an SSH tunnel. - Service mysql: SSH user, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH user, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service opendistro: SSH user, specify only to connect using an SSH tunnel. - Service opensearch: SSH user, specify only to connect using an SSH tunnel. - Service oracle: SSH user, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH user, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service postgres: SSH user, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH user, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH user, specify only to connect via an SSH tunnel. - Service sftp: Tunnel user, specify only to connect via SSH tunnel. - Service sql_server: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH user, specify only to connect via an SSH tunnel.
TypeName string: Field usage depends on service value: - Service akamai: Your Akamai type name. - Service bubble: Your Bubble type name.
UniqueId string
UpdateConfigOnEachSync bool: Field usage depends on service value: - Service google_display_and_video_360: 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.
UpdateMethod string: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service azure_postgres: 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. - Service azure_sql_db: (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. - Service azure_sql_managed_db: (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. - Service clarity: (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. - Service dynamics_365_fo: Update Method - Service ehr: (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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: (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. - Service heroku_postgres: 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. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Default value: Teleport - Service snowflake_db: Default value: Teleport - Service sql_server: (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. - Service sql_server_hva: (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. - Service sql_server_rds: (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. - Service sql_server_sap_ecc_hva: (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.
Uri string: Field usage depends on service value: - Service cosmos: Cosmos resource instance address.
UrlFormat string: Field usage depends on service value: - Service fountain: Your Fountain URL format.
UseApiKeys bool: Field usage depends on service value: - Service mandrill: Whether to use multiple API keys for interaction.
UseCustomerBucket bool: Field usage depends on service value: - Service appsflyer: Use Custom Bucket. Set it to 'true' if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket.
UseOracleRac bool: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using a RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you're using a RAC instance.
UsePgpEncryptionOptions bool: Field usage depends on service value: - Service azure_blob_storage: Set to true if files present in the Azure Blob Storage container are encrypted using PGP. Default value: false. - Service ftp: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service gcs: Set to true if files are encrypted using PGP in the GCS bucket. Default value: false. - Service s3: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service sftp: Set to true if files present in SFTP server are encrypted using PGP. Default value: false. - Service wasabi_cloud_storage: Set to true if files are encrypted using PGP in the Wasabi Cloud Storage bucket. Default value: false.
UseServiceAccount bool: Field usage depends on service value: - Service bigquery_db: BigQuery use service account; default is false
UseTemplateLabels bool: Field usage depends on service value: - Service mandrill: Use template labels to filter templates for sync
UseWebhooks bool: Field usage depends on service value: - Service github: Set to true to capture deletes. - Service xero: Updates to few fields like sent_to_contact in Invoice table might be missed if you don't enable this.
UseWorkspace bool: Field usage depends on service value: - Service bigquery_db: Create and drop tables in a query results dataset. Default is false - Service snowflake_db: Choose a database and schema to create temporary tables for syncs.
User string: Field usage depends on service value: - Service aurora: The user name. - Service aurora_postgres: The user name. - Service azure_cosmos_for_mongo: Username for source database access. - Service azure_postgres: The user name. - Service azure_sql_db: The user name. For Azure Databases, the format must be user@domain. - Service azure_sql_managed_db: The user name. For Azure Databases, the format must be user@domain. - Service clarity: The user name. For Azure Databases, the format must be user@domain. - Service cockroachdb: The user name. - Service db2i_hva: The user name. - Service db2i_sap_hva: The username. - Service documentdb: The user name. - Service dynamics_365_fo: The user name. The format must be user@domain. - Service ehr: The user name. For Azure Databases, the format must be user@domain. - Service elastic_cloud: The user name. - Service es_self_hosted: The user name. - Service ftp: FTP user. - Service google_cloud_mysql: The user name. - Service google_cloud_postgresql: The user name. - Service google_cloud_sqlserver: The user name. For Azure Databases, the format must be user@domain. - Service hana_sap_hva_b1: The username. - Service hana_sap_hva_ecc: The username. - Service hana_sap_hva_ecc_netweaver: The username. - Service hana_sap_hva_s4: The username. - Service hana_sap_hva_s4_netweaver: The username. - Service heroku_postgres: The user name. - Service jira: The Jira username. - Service magento_mysql: The user name. - Service magento_mysql_rds: The user name. - Service maria: The user name. - Service maria_azure: The user name. - Service maria_rds: The user name. - Service marin: The Marin username. - Service mongo: The user name. - Service mongo_sharded: The user name. - Service mysql: The user name. - Service mysql_azure: The user name. - Service mysql_rds: The user name. - Service opendistro: The user name. - Service opensearch: The user name. - Service oracle: The user name. - Service oracle_ebs: The user name. - Service oracle_hva: The user name. - Service oracle_rac: The user name. - Service oracle_rds: The user name. - Service oracle_sap_hva: The username. - Service oracle_sap_hva_netweaver: The username. - Service outbrain: The username or email of the Outbrain user. - Service postgres: The user name. - Service postgres_rds: The user name. - Service redshift_db: The Redshift username. - Service sap_hana: Your SAP HANA user name. - Service sap_s4hana: Your SAP S/4 user name. - Service sftp: SFTP user. - Service snowflake_db: The Snowflake username. - Service splunk: The Splunk username. - Service sql_server: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_hva: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_rds: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_sap_ecc_hva: The user name. For Azure Databases, the format must be user@domain.
UserId string: Field usage depends on service value: - Service coassemble: Your Coassemble user ID. - Service gmail: Your Gmail user ID. - Service hibob: Your HiBob Service User Token. - Service marketo: Marketo SOAP API User Id. - Service okendo: Your Okendo user ID. - Service playvox: Your Playvox User ID. - Service sage_intacct: User ID - Service vimeo: Your Vimeo user ID.
UserKey string
UserName string: Field usage depends on service value: - Service workday: Workday username.
UserProfiles List<string>: Field usage depends on service value: - Service double_click_campaign_manager: IDs of specific User Profiles to sync. Must be populated if sync_mode is set to SpecificAccounts.
UserToken string: Field usage depends on service value: - Service hibob: Your HiBob Service User ID. - Service konnect_insights: Your Konnect Insights User Token. - Service sonarqube: Your Sonarqube user token.
Username string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS username. - Service adobe_commerce: Your Adobe Commerce username. - Service akeneo: Your Akeneo username. - Service anaplan: Your Anaplan user ID. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Username. - Service aveva_pi: Username for the user to authenticate as with the AF Server - Service ceridian_dayforce: Your Ceridian Dayforce Username. - Service churnzero: Your ChurnZero username. - Service cin7: Your Cin7 API Username. - Service collibra: Your collibra username. - Service compliance_checkpoint: Your Compliance Checkpoint account username. - Service concur: The SAP Concur username. - Service confluence: Your Confluence username. - Service contrast_security: Your Contrast Security API Username. - Service dcl_logistics: Your DCL Logistics username. - Service deposco: Your Deposco username. - Service github: Login of your GitHub profile. - Service gladly: Your Gladly Username. - Service globalmeet: Your GlobalMeet Username. - Service gorgias: Your Gorgias username. - Service green_power_monitor: Your GreenPowerMonitor username. - Service guru: Your Guru username. - Service hilti_ontrack: Your Hilti On!Track username. - Service impact: Your Impact Account SID - Service integral_ad_science: Your integral_ad_science username. - Service itunes_connect: Your Apple ID - Service jamf: Your Jamf username. - Service khoros_care: Your Khoros Care username. - Service kissmetrics: Your Kissmetrics API Username. - Service klarna: Your Klarna Username. - Service learnupon: Your Learnupon username. - Service lessonly: Your Lessonly username. - Service mailgun: Your Mailgun API username. - Service myosh: Your myosh username. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence username. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud username. - Service partnerize: Your Partnerize account's username. - Service pingdom: Your Pingdom Username. - Service podio: Your Podio account username. - Service qmatic_data_connect: Your Qmatic Data Connect username. - Service quorum: Your Quorum username . - Service revx: Your RevX Username. - Service rtb_house: Your RTB House username. - Service sap_business_by_design: The SAP Business ByDesign username. - Service scorm: Your Scorm App ID. - Service servicenow: Your ServiceNow User ID (username). - Service shiphero: Your ShipHero username. - Service shipstation: Your ShipStation username. - Service shopware: Your Shopware username. - Service splash: Your Splash username. - Service starrez: Your StarRez API username - Service stickyio: Your sticky.io username . - Service stylight: Your Stylight Username. - Service sugarcrm: Your SugarCRM username. - Service teamwork: Your Teamwork username. - Service testrail: Your TestRail username. - Service ukg_pro: Your UKG Pro username. - Service unicommerce: Your uniware login username. - Service upland: Your Upland Software Username. - Service veevavault: Your Veeva Vault username. - Service when_i_work: Your When I Work username. - Service wherefour: Your Wherefour username. - Service workday_financial_management: Workday username. - Service workday_hcm: Username of your Workday Integration System User account - Service xandr: Your Xandr username. - Service younium: Your Younium username.
Version string: Field usage depends on service value: - Service criteo_retail_media: Your Criteo Retail Media version.
ViewAttributionWindow string: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on views. Possible view_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'view' action. - Service snapchat_ads: The time period to attribute conversions based on views. Default value: DAY_1
ViewId string: Field usage depends on service value: - Service pigment: Your Pigment view ID.
ViewThroughAttributionWindowSize string: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on views. Default value: DAY_7
WebServiceApiKey string: Field usage depends on service value: - Service adyen: Your Adyen Web Service API key.
WebhookEndpoint string: Field usage depends on service value: - Service appsflyer: Webhook Url
WebhookKey string: Field usage depends on service value: - Service xero: Webhook Key
WebhookUrl string: Field usage depends on service value: - Service branch: Webhook URL - Service pipedrive: The registered URL for webhooks in your Pipedrive dashboard. - Service segment: Webhook URL. - Service xero: (ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO.
WordPressSiteIdOrWoocommerceDomainName string: Field usage depends on service value: - Service woocommerce: The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance.
WorkplaceId string: Field usage depends on service value: - Service moloco: Your Moloco workplace ID.
Workspace string: Field usage depends on service value: - Service mode: Your Mode Workspace.
WorkspaceName string: Field usage depends on service value: - Service bigquery_db: Workspace Dataset Name - Service snowflake_db: The name of the database where the temporary tables will be created.
WorkspaceSameAsSource bool: Field usage depends on service value: - Service bigquery_db: Use the source dataset as the workspace dataset
WorkspaceSchema string: Field usage depends on service value: - Service snowflake_db: The name of the schema that belongs to the workspace database where the temporary tables will be created.
WsCertificate string: Field usage depends on service value: - Service adp_workforce_now: Web Services Certificate.
XApiKey string: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X API key.
XKey string: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research key.
XMasterKey string: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research master key.
XUserEmail string: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Email.
XUserToken string: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Token.

AbsConnectionMethod string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection method
AbsConnectionString string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection string. - Service braze: Connection String
AbsContainerAddress string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container address
AbsContainerName string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container name. - Service braze: Container Name
AbsHostIp string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage host IP
AbsHostUser string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage username
AbsPrefix string: Field usage depends on service value: - Service braze: Prefix
AbsPublicKey string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage public key
AcademyId string: Field usage depends on service value: - Service workramp: Your WorkRamp academy ID.
AccessId string: Field usage depends on service value: - Service planful: Your Planful access ID.
AccessKey string: Field usage depends on service value: - Service gainsight_customer_success: The access key for API authentication. - Service gongio: Your Gongio Access key. - Service line_ads: Your LINE Ads access key. - Service planful: Your Planful access key. - Service retailnext: Your RetailNext access key.
AccessKeyId string: Field usage depends on service value: - Service appsflyer: Your AWS access key ID. - Service aws_cost_report: Access Key ID - Service checkout: Your Checkout.com access key ID. - Service cloudtalk: Your CloudTalk Access Key ID. - Service nice: Your NICE access key ID. - Service s3: Access Key ID - Service wasabi_cloud_storage: Access Key ID
AccessKeySecret string: Field usage depends on service value: - Service aws_cost_report: Access Key Secret - Service checkout: Your Checkout.com access key secret. - Service cloudtalk: Your CloudTalk Access Key Secret. - Service gongio: Your Gongio Access Key Secret. - Service nice: Your NICE access key secret. - Service s3: Access Key Secret - Service wasabi_cloud_storage: Access Key Secret
AccessToken string: Field usage depends on service value: - Service 7shifts: Your 7shifts access token. - Service attio: Your Attio bearer token - Service big_commerce: API access token of your store. - Service bitly: Your Bitly access token. - Service calabrio: Your Calabrio access token. - Service coupa: Your Coupa access token fetched using client_id and client_secret - Service deputy: Your Deputy API access token. - Service getfeedback: Your GetFeedback Access token. - Service gocardless: Your GoCardless API token. - Service ironclad: Your Ironclad access token. - Service khoros_marketing: Your Khoros Marketing access token. - Service kustomer: Your Kustomer API key. - Service lattice: Your Lattice API access token. - Service launchdarkly: Your LaunchDarkly access token. - Service leap_crm: Your Leap CRM access token. - Service nylas: Your Nylas access_token. - Service planhat: Your Planhat access token. - Service rollbar: Your Rollbar Access Token. - Service samsara: Your Samsara API token. - Service slab: Your Slab API key. - Service stripe: The Stripe API Restricted Key - Service stripe_test: The Stripe API Restricted Key - Service talkwalker: Your Talkwalker access token. - Service workable: Your Workable Access Token. - Service workramp: Your WorkRamp access token.
AccessType string: Field usage depends on service value: - Service share_point: Access Type
Account string: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Account ID. - Service ordway: Your Ordway account type.
AccountAccessToken string: Field usage depends on service value: - Service rollbar: Your Rollbar account access token.
AccountId string: Field usage depends on service value: - Service appcues: Your Appcues Account ID. - Service brightcove: Your Brightcove account ID. - Service cin7core: Your Cin7 Core account ID. - Service dear: Your Dear Account ID. - Service harvest: Your Harvest Account ID. - Service optimizely: Your Optimizely account ID. - Service rokt: Your Rokt account ID. - Service udemy_business: Your Udemy Business account ID.
AccountIds []string: Field usage depends on service value: - Service taboola: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
AccountKey string: Field usage depends on service value: - Service cosmos: The read-only primary or secondary account key for the database account. Required for the ACCOUNT_KEY data access method. - Service simplesat: Your Simplesat account key.
AccountName string: Field usage depends on service value: - Service eventsforce: Your Eventsforce account name. - Service freshdesk_contact_center: Your Freshdesk Contact Center account name. - Service happyfox: Your HappyFox account name. - Service maxio_saasoptics: Your Maxio SaaSOptics account name. - Service talkdesk: Your Talkdesk Account Name. - Service udemy_business: Your Udemy Business account name.
AccountPlan string: Field usage depends on service value: - Service tymeshift: Your Tymeshift account plan.
AccountRegion string: Field usage depends on service value: - Service iterable: If your Iterable account URL starts with https://app.eu.iterable.com then provide EU else US
AccountSid string: Field usage depends on service value: - Service fone_dynamics: Your Fone Dynamics account SID.
AccountSyncMode string: Field usage depends on service value: - Service itunes_connect: Account Sync Mode
AccountToken string: Field usage depends on service value: - Service konnect_insights: Your Konnect Insights Account Token.
AccountType string: Field usage depends on service value: - Service freightview: Your Freightview Account Type.
Accounts []string: Field usage depends on service value: - Service bingads: Specific accounts to sync. Must be populated if syncMode is set to SpecificAccounts. - Service facebook: List of accounts of which connector will sync the data. - Service facebook_ad_account: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service facebook_ads: List of accounts of which connector will sync the data. - Service google_ads: The list of Account IDs to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service google_analytics: The list of specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_4: The list of specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_analytics_mcf: Specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_search_ads_360: Specific accounts to sync. Must be populated if accountsSyncMode is set to SPECIFIC_ACCOUNTS. - Service instagram_business: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service itunes_connect: Accounts - Service linkedin_ads: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service spotify_ads: The list of Ad Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service tiktok_ads: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twilio: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
AccountsRedditAds []GetConnectorConfigAccountsRedditAd: Field usage depends on service value: - Service reddit_ads: Accounts
AccountsSyncMode string: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all accounts or specific.
ActionBreakdowns []string: Field usage depends on service value: - Service facebook: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
ActionReportTime string: Field usage depends on service value: - Service facebook: The report time of action stats. Possible action_report time values.
AdAnalytics string: Field usage depends on service value: - Service linkedin_ads: Whether to sync all analytic reports or specific. Default value: AllReports
AdUnitView string: Field usage depends on service value: - Service double_click_publishers: Ad unit view for the report.
AdminApiKey string: Field usage depends on service value: - Service splitio: Your Split admin api key.
AdobeAnalyticsConfigurations []GetConnectorConfigAdobeAnalyticsConfiguration: Field usage depends on service value: - Service adobe_analytics: 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.
Advertisables []string: Field usage depends on service value: - Service adroll: Specific advertisables to sync. Must be populated if sync_mode is set to SpecificAdvertisables.
Advertisers []string: Field usage depends on service value: - Service google_display_and_video_360: The list of advertisers to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service google_search_ads_360: Specific advertisers to sync. Must be populated if advertisersSyncMode is set to SPECIFIC_ADVERTISERS. - Service pinterest_ads: Specific Advertisers to sync. Must be populated if sync_mode is set to SpecificAdvertisers.
AdvertisersIds []string: Field usage depends on service value: - Service yahoo_gemini: Specific Advertiser IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
AdvertisersSyncMode string: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all or specific advertisers.
AdvertisersWithSeats []string: Field usage depends on service value: - Service yahoo_dsp: Specific Advertisers to sync. Must be populated if sync_mode_advertiser is set to SPECIFIC_ADVERTISERS. Pay attention to the format: AdvertiserId:SeatId
AgentConfigMethod string
AgentHost string: Field usage depends on service value: - Service db2i_hva: The agent host. - Service db2i_sap_hva: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service oracle_hva: The host of the agent. This is the same as database host, since the agent must be installed in the same machine as source database. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service sql_server_hva: The host address of the machine running the agent. Often the same as the DB host. - Service sql_server_sap_ecc_hva: The host address of the machine running the agent. Often the same as the DB host.
AgentId string: Field usage depends on service value: - Service phoenix_ads: Your Phoenix Ads Agent ID.
AgentOraHome string: Field usage depends on service value: - Service oracle_hva: The home directory of the Oracle database. - Service oracle_sap_hva: The home directory of the Oracle database.
AgentPassword string: Field usage depends on service value: - Service db2i_hva: The agent password. - Service db2i_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_b1: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_hva: The agent user's password. It should have a minimum length of 10 characters. - Service oracle_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_sap_hva_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service sql_server_hva: The password for the agent user. - Service sql_server_sap_ecc_hva: The password for the agent user.
AgentPort float64: Field usage depends on service value: - Service db2i_hva: The agent port. - Service db2i_sap_hva: The port number of the agent. - Service hana_sap_hva_b1: The port number of the agent. - Service hana_sap_hva_ecc: The port number of the agent. - Service hana_sap_hva_ecc_netweaver: The port number of the agent. - Service hana_sap_hva_s4: The port number of the agent. - Service hana_sap_hva_s4_netweaver: The port number of the agent. - Service oracle_hva: The port number of the agent. - Service oracle_sap_hva: The port number of the agent. - Service oracle_sap_hva_netweaver: The port number of the agent. - Service sql_server_hva: The port that the agent has open for Fivetran's connection. Default value is 4343. - Service sql_server_sap_ecc_hva: The port that the agent has open for Fivetran's connection. Default value is 4343.
AgentPublicCert string: Field usage depends on service value: - Service db2i_hva: The public certificate for the agent. - Service db2i_sap_hva: The agent public certificate. - Service hana_sap_hva_b1: The agent public certificate. - Service hana_sap_hva_ecc: The agent public certificate. - Service hana_sap_hva_ecc_netweaver: The agent public certificate. - Service hana_sap_hva_s4: The agent public certificate. - Service hana_sap_hva_s4_netweaver: The agent public certificate. - Service oracle_hva: The agent public certificate. - Service oracle_sap_hva: The agent public certificate. - Service oracle_sap_hva_netweaver: The agent public certificate. - Service sql_server_hva: The public certificate generated by the agent. - Service sql_server_sap_ecc_hva: The public certificate generated by the agent.
AgentUser string: Field usage depends on service value: - Service db2i_hva: The agent user name. - Service db2i_sap_hva: The agent's user. - Service hana_sap_hva_b1: The agent's user. - Service hana_sap_hva_ecc: The agent's user. - Service hana_sap_hva_ecc_netweaver: The agent's user. - Service hana_sap_hva_s4: The agent's user. - Service hana_sap_hva_s4_netweaver: The agent's user. - Service oracle_hva: The agent's user. - Service oracle_sap_hva: The agent's user. - Service oracle_sap_hva_netweaver: The agent's user. - Service sql_server_hva: The agent's username. - Service sql_server_sap_ecc_hva: The agent's username.
Aggregation string: Field usage depends on service value: - Service facebook: Options to select aggregation duration. Possible aggregation values.
AgreementGrantToken string: Field usage depends on service value: - Service economic: Your E-conomic X-AgreementGrantToken goes here.
AlwaysEncrypted bool: Field usage depends on service value: - Service aurora: Require TLS through Tunnel - Service aurora_postgres: Require TLS through Tunnel - Service azure_cosmos_for_mongo: Require TLS - Service azure_postgres: Require TLS through Tunnel - Service azure_sql_db: Require TLS through Tunnel. - Service azure_sql_managed_db: Require TLS. - Service clarity: Require TLS through Tunnel. - Service cockroachdb: Require TLS - Service db2i_hva: Require TLS through Tunnel - Service db2i_sap_hva: Require TLS through Tunnel - Service documentdb: Require TLS encryption. - Service dynamics_365_fo: Require TLS through Tunnel. - Service ehr: Require TLS through Tunnel. - Service elastic_cloud: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service es_self_hosted: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service google_cloud_mysql: Require TLS through Tunnel - Service google_cloud_postgresql: Require TLS through Tunnel - Service google_cloud_sqlserver: Require TLS. - Service heroku_postgres: Require TLS through Tunnel - Service magento_mysql: Require TLS through Tunnel - Service magento_mysql_rds: Require TLS through Tunnel - Service maria: Require TLS through Tunnel - Service maria_azure: Require TLS through Tunnel - Service maria_rds: Require TLS through Tunnel - Service mongo: Require TLS - Service mongo_sharded: Require TLS through Tunnel - Service mysql: Require TLS through Tunnel - Service mysql_azure: Require TLS through Tunnel - Service mysql_rds: Require TLS through Tunnel - Service opendistro: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service opensearch: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service oracle: Require TLS through Tunnel - Service oracle_ebs: Require TLS through Tunnel - Service oracle_hva: Require TLS through Tunnel - Service oracle_rac: Require TLS through Tunnel - Service oracle_rds: Require TLS through Tunnel - Service oracle_sap_hva: Require TLS through Tunnel - Service oracle_sap_hva_netweaver: Require TLS. - Service postgres: Require TLS through Tunnel - Service postgres_rds: Require TLS through Tunnel - Service sql_server: Require TLS. - Service sql_server_hva: Require TLS. - Service sql_server_rds: Require TLS. - Service sql_server_sap_ecc_hva: Require TLS.
Api string: Field usage depends on service value: - Service freshsuccess: Set this parameter to api.
ApiAccessToken string: Field usage depends on service value: - Service flywheel_digital: Your Flywheel Digital API access token. - Service shopify: API access token of your custom app. - Service square: The Square API access token of your application.
ApiEnvironment string: Field usage depends on service value: - Service afterpay: Your Afterpay API environment.
ApiId string: Field usage depends on service value: - Service aircall: Your Aircall API ID.
ApiKey string: Field usage depends on service value: - Service 15five: Your 15five API key. - Service 360learning: Your 360Learning API Key. - Service 6sense: Your 6sense API Key. - Service acculynx: Your Acculynx API key. - Service activecampaign: Your ActiveCampaign API key. - Service affinity: Your Affinity API key. - Service airtable: API key of the Airtable account. - Service algolia: Your Algolia API key. - Service anvyl: Your Anvyl API key. - Service appcues: Your Appcues API key. - Service ashby: Your Ashby API key. - Service assembled: Your Assembled API key. - Service atlassian_jira_align: Your Jira Align API key. - Service atlassian_ops_genie: Your Opsgenie API key - Service attentive: Your Attentive API key. - Service aumni: Your Aumni API key. - Service avantlink: Your AvantLink API key. - Service ballotready: Your BallotReady API token. - Service bamboohr: Your API Key. - Service bazaarvoice: Your Bazaarvoice API key. - Service betterworks: Your Betterworks API key. - Service bigmarker: Your BigMarker API key. - Service bizzabo: Your Bizzabo API key. - Service brave_ads: Your Brave Ads API key - Service braze: Your Braze API Key. - Service brevo: Your Brevo API key. - Service bubble: Your Bubble API token. - Service buildium: Your Buildium private API key. - Service callrail: Your CallRail API key. - Service campaignmonitor: Your Campaign Monitor API key. - Service canny: Your Canny API key. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 API key. - Service chargebee_product_catalog_2: Your Chargebee API key. - Service chartmogul: Your ChartMogul API key. - Service chorusai: Your Chorus API key. - Service churnkey: Your Churnkey API Key. - Service churnzero: Your ChurnZero API key. - Service cimis: Your Cimis API key. - Service circleci: Your CircleCI API Key. - Service clickup: Your ClickUp API key. - Service clockify: Your Clockify API key. - Service clockodo: Your Clockodo API key. - Service close: Your Close API key. - Service cloudbeds: Your Cloudbeds API key. - Service clubspeed: Your Clubspeed API key. - Service coassemble: Your Coassemble API key. - Service codefresh: Your Codefresh API Key. - Service column: Your Column API key. - Service concord: Your Concord API key. - Service confluent_cloud: API Key - Service contrast_security: Your Contrast Security API Key. - Service copper: Your Copper API key. - Service coupa: Your Coupa API key. - Service datadog: Your Datadog API key. - Service dbt_cloud: Your dbt Cloud service token. - Service dcl_logistics: Your DCL Logistics API key. - Service delighted: API Key for your Delighted account - Service destini: Your Destini API Key. - Service donus: Your Donus API key. - Service doorloop: Your DoorLoop API key. - Service drata: Your Drata API Key. - Service dropbox_sign: Your Dropbox Sign API key. - Service duoplane: Your Duoplane API key. - Service easypost: Your EasyPost API Key. - Service electronic_tenant_solutions: Your Electronic Tenant Solutions API key. - Service eventsforce: Your Eventsforce API secret key. - Service everflow: Your Everflow API key. - Service everhour: Your Everhour API Token. - Service expensein: Your ExpenseIn API key. - Service factorial: Your Factorial API key. - Service firehydrant: Your FireHydrant API key. - Service float: Your Float API key. - Service forj_community: Your Forj Community API key. - Service fourkites: Your FourKites API key. - Service freightview: Your Freightview API key. - Service freshdesk: Your Freshdesk API Key. - Service freshdesk_contact_center: Your Freshdesk Contact Center API key. - Service freshsales: Your Freshsales API key. - Service freshservice: Your Freshservice API Key. - Service freshsuccess: Your Freshsuccess API key. - Service freshteam: Your Freshteam API key. - Service friendbuy: Your Friendbuy API key. - Service fullstory: Your Fullstory API key. - Service gainsight_product_experience: Your Gainsight Product Experience API key. - Service gem: Your Gem API key. - Service gorgias: Your Gorgias API key. - Service greenhouse: Your Greenhouse API key. - Service grepsr: Your Grepsr API Key. - Service grin: Your Grin API key. - Service happyfox: Your HappyFox API key. - Service height: Your Height API key. - Service helpshift: Your Helpshift API Key. - Service incidentio: Your incident.io API key. - Service infobip: Your Infobip API key. - Service insightly: Your Insightly API key. - Service integrate: Your Integrate API key. - Service invoiced: Your Invoiced API key. - Service iterable: Your Iterable API key. - Service ivanti: Your Ivanti API Key. - Service jotform: Your Jotform API key. - Service justcall: Your JustCall API key. - Service katana: Your Katana API key. - Service kevel: Your Kevel API key. - Service keypay: Your KeyPay API key. - Service kisi: Your Kisi API key. - Service klaviyo: Your Klaviyo API key. - Service learnupon: Your Learnupon API key. - Service lemlist: Your Lemlist API key. - Service lever: Your Lever API key. - Service liftoff: Your Liftoff API key. - Service linear: Your Linear API key. - Service linksquares: Your LinkSquares API key. - Service lob: Your Lob API key. - Service loop: Your Loop API key. - Service lucca: Your Lucca API key. - Service luma: Your Luma API key. - Service maileon: Your Maileon API key. - Service mailgun: Your Mailgun API key. - Service mailjet: Your Mailjet API key. - Service malomo: Your Malomo API key. - Service mambu: Your Mambu API key. - Service mandrill: Your Mandrill API key. - Service maxio_chargify: Enter Your API Key. - Service messagebird: Your MessageBird API key. - Service mountain: Your MNTN API key. - Service myosh: Your myosh API key. - Service okendo: Your Okendo API key. - Service ometria: Your Ometria API Key. - Service oncehub: Your OnceHub API key. - Service ordway: Your Ordway API key. - Service ortto: Your Ortto API key. - Service pagerduty: Your PagerDuty API key. - Service pandadoc: Your PandaDoc API key. - Service papershift: Your Papershift API Key - Service partnerize: Your Partnerize user API key. - Service persona: Your Persona API key. - Service picqer: Your Picqer API key. - Service pigment: Your Pigment API key. - Service pinpoint: Your Pinpoint API key. - Service pipe17: The Pipe17 API key. - Service placerai: Your Placer.ai API key. - Service playvox: Your Playvox API Key. - Service posthog: Your PostHog API key. - Service prive: Your Prive API key. - Service prosperstack: Your ProsperStack API key. - Service qualaroo: Your Qualaroo API Key. - Service quorum: Your Quorum API key. - Service rebound_returns: Your ReBound Returns API key. - Service recurly: The Recurly API key. - Service replyio: Your Reply API key. - Service revenuecat: Your RevenueCat API key. - Service reviewsio: Your REVIEWS.io API key. - Service revops: Your RevOps bearer token. - Service ricochet360: Your Ricochet360 API key. - Service ringover: Your Ringover API key. - Service rippling: Your Rippling API key. - Service rocketlane: Your Rocketlane API key. - Service rootly: Your Rootly API key. - Service ruddr: Your Ruddr API key. - Service safebase: Your SafeBase API key. - Service sage_hr: Your Sage HR API key. - Service sailthru: The Sailthru API key. - Service salsify: Your Salsify API Key. - Service security_journey: Your Security Journey API key. - Service sendgrid: The SendGrid API key. - Service sendinblue: Your Sendinblue API key. - Service shortcut: Your Shortcut API token. - Service shortio: Your Short.io API key. - Service simplesat: Your Simplesat API key. - Service sistrix: Your SISTRIX API key. - Service skilljar: Your Skilljar API key. - Service smartwaiver: Your Smartwaiver API key. - Service snyk: Your Snyk API key. - Service sonarqube: Your Sonarqube API key. - Service sparkpost: Your SparkPost API key. - Service squarespace: Your Squarespace API key. - Service stackadapt: Your StackAdapt API key. - Service statuspage: Your Statuspage API Key. - Service stripe: Restricted API key - Service stripe_test: Restricted API key - Service subscript: Your Subscript API key. - Service survicate: Your Survicate API Key. - Service teads: Your Teads API key. - Service teamtailor: Your Teamtailor API key. - Service testrail: Your TestRail API key. - Service ticket_tailor: Your Ticket Tailor API key. - Service transcend: Your Transcend API key. - Service trello: Your TRELLO api key. - Service triple_whale: Your Triple Whale API key. - Service uppromote: Your UpPromote API key. - Service veeqo: Your Veeqo API key. - Service venminder: Your Venminder API key. - Service visit_by_ges: Your Visit by GES API key. - Service vitally: Your Vitally API key. - Service vonage: Your Vonage API Key. - Service vts: Your VTS API key. - Service webconnex: Your Webconnex API key. - Service wicked_reports: Your Wicked Reports API key. - Service workleap_officevibe: Your Workleap Officevibe API key. - Service xsolla: Your Xsolla API key. - Service yougov_sport: Your Yougov Sport API key. - Service zingtree: Your Zingtree API key. - Service zip: Your Zip API key.
ApiKeyApiSecret string: Field usage depends on service value: - Service revel: Your Revel Systems API Key and API Secret.
ApiKeys []string: Field usage depends on service value: - Service mandrill: Comma-separated list of API keys. Required if use_api_keys is set to true.
ApiPassword string: Field usage depends on service value: - Service duoplane: Your Duoplane API password.
ApiQuota float64: Field usage depends on service value: - Service marketo: Allowed number of API requests to Marketo instance per day, the default value is 10000.
ApiReadAccessToken string: Field usage depends on service value: - Service the_movie_database: Your The Movie Database API read access token.
ApiRequestsPerMinute float64: Field usage depends on service value: - Service qualtrics: Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
ApiSecret string: Field usage depends on service value: - Service confluent_cloud: API Secret - Service forj_community: Your Forj Community API secret. - Service friendbuy: Your Friendbuy API secret. - Service justcall: Your JustCall API secret. - Service liftoff: Your Liftoff API secret. - Service mixpanel: Mixpanel API Secret. - Service qualaroo: Your Qualaroo API Secret. - Service sailthru: The Sailthru API secret. - Service shareasale: Your ShareASale API secret. - Service vonage: Your Vonage API Secret.
ApiSecretKey string: Field usage depends on service value: - Service alchemer: Your Alchemer API Secret key.
ApiServer string: Field usage depends on service value: - Service sigma_computing_source: Your Sigma Computing api server.
ApiToken string: Field usage depends on service value: - Service aha: Your Aha! API key. - Service aircall: Your Aircall API Token. - Service appsflyer: API Token for AppsFlyer's PULL API. - Service awin: Your Awin API Token. - Service backbone_plm: Your Backbone PLM API token. - Service brex: Your Brex API token - Service buildkite: Your Buildkite API token. - Service buzzsprout: Your Buzzsprout API token. - Service centra: Your Centra API token. - Service chameleon: Your Chameleon API token. - Service clari: Your Clari API token. - Service cloudflare_analytics: Your Cloudflare Analytics API token. - Service confluence: The Confluence API token. - Service dixa: Your Dixa API token. - Service drip: Your Drip API Token. - Service factbird: Your Factbird API token. - Service fone_dynamics: Your Fone Dynamics API token. - Service fountain: Your Fountain API token. - Service g2: Your G2 API token. - Service gladly: Your Gladly API Token. - Service hibob: Your Hibob API token. - Service kandji: Your Kandji API token. - Service livechat: Your Livechat Access token. - Service livechat_partner: Your Livechat Partner API Token. - Service maxio_saasoptics: Your Maxio SaaSOptics API token. - Service megaphone: Your Megaphone API token. - Service missive: Your Missive API token. - Service mixmax: Mixmax API token. - Service okta: Your Okta API token. - Service ordway: Your Ordway API token. - Service packiyo: Your Packiyo API token. - Service pipedrive: (Optional)Your Pipedrive personal API token - Service pivotal_tracker: Pivotal Tracker API token. - Service postmark: Your Postmark account API token. - Service productive: Your Productive API token. - Service qualtrics: API token of the Qualtrics account. - Service rakutenadvertising: Your Rakuten Advertising API token. - Service recharge: The Recharge API token. - Service referralhero: Your Referralhero API token. - Service resource_management_by_smartsheet: Your Resource Management by Smartsheet API token. - Service retently: Your Retently API token. - Service reviewsai: Your REVIEWS.ai API token. - Service rundeck: Your Rundeck API token. - Service safetyculture: Your SafetyCulture API token. - Service sensor_tower: Your Sensor Tower API token. - Service sentry: Your Sentry auth token. - Service simplecast: Your Simplecast API token. - Service snyk: Your Snyk API token. - Service textus: Your TextUs API token. - Service toggl_track: Your Toggl Track API token - Service trello: Your TRELLO api token. - Service trisolute: Your Trisolute API token. - Service vwo: Your VWO API token. - Service web_scraper: Your Web Scraper API token. - Service zendesk: Zendesk API tokens are auto-generated passwords in the Support admin interface. - Service zendesk_sunshine: Zendesk API tokens are auto-generated passwords in the Support admin interface.
ApiType string
ApiUrl string: Field usage depends on service value: - Service braze: Your Braze API URL.
ApiUrlRegion string: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP API URL region.
ApiUsage string: Field usage depends on service value: - Service zendesk: Maximum Zendesk Api Usage allowed
ApiUserIdentifier string: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user identifier.
ApiUserSecret string: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user secret.
ApiUtilizationPercentage string: Field usage depends on service value: - Service kustomer: Api Utilization Percentage
ApiVersion string: Field usage depends on service value: - Service pardot: API Version
AppId string: Field usage depends on service value: - Service churnkey: Your Churnkey APP ID. - Service open_exchange_rates: Your Open Exchange Rates App Id. - Service rokt: Your Rokt app ID.
AppIds []string: Field usage depends on service value: - Service pendo: Specific App IDs to sync. Must be populated if sync_mode is set to SpecificAppIds.
AppIdsAppsflyers []GetConnectorConfigAppIdsAppsflyer: Field usage depends on service value: - Service appsflyer: * App ID(s)
AppKey string: Field usage depends on service value: - Service loopio: Your Loopio App Key. - Service servicetitan: Your ServiceTitan app key. - Service yotpo: Your Yotpo App Key
AppReference string: Field usage depends on service value: - Service brightpearl: Your Brightpearl app reference.
AppSecret string: Field usage depends on service value: - Service rokt: Your Rokt app secret.
AppSecretToken string
AppSpecificPassword string: Field usage depends on service value: - Service itunes_connect: Your app-specific password
AppSyncMode string: Field usage depends on service value: - Service itunes_connect: Whether to sync all apps or specific apps.
AppendFileOption string: Field usage depends on service value: - Service aws_cost_report: If you know that the source completely overwrites the same file with new data, you can append the changes instead of upserting based on filename and line number. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
ApplicationId string: Field usage depends on service value: - Service algolia: Your Algolia application ID. - Service xactly: Your Xactly Application ID.
ApplicationKey string: Field usage depends on service value: - Service cin7core: Your Cin7 Core application key. - Service datadog: Your Datadog application key. - Service dear: Your Dear Application key. - Service partnerize: Your Partnerize user application key.
Apps []string: Field usage depends on service value: - Service itunes_connect: Specific apps to sync. Must be populated if app_sync_mode is set to SpecificApps.
ArchiveLogFormat string: Field usage depends on service value: - Service sql_server_hva: Format for archive log file names - Service sql_server_sap_ecc_hva: Format for archive log file names
ArchiveLogPath string: Field usage depends on service value: - Service sql_server_hva: Directory where archive logs are located - Service sql_server_sap_ecc_hva: Directory where archive logs are located
ArchivePattern string: Field usage depends on service value: - Service aws_cost_report: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service azure_blob_storage: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service box: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service dropbox: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service email: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service ftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service gcs: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service google_drive: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service kinesis: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service s3: Files inside compressed archives with filenames matching this regular expression will be synced. - Service sftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service share_point: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service wasabi_cloud_storage: Files inside compressed archives with filenames matching this regular expression will be synced.
AreSoapCredentialsProvided bool: Field usage depends on service value: - Service marketo: Marketo SOAP credentials provided.
AsbIp string: Field usage depends on service value: - Service azure_service_bus: The IP address (or) the URL of ASB namespace
AsmOption bool: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using ASM on a non-RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you are using ASM on a non-RAC instance.
AsmOracleHome string: Field usage depends on service value: - Service oracle_hva: ASM Oracle Home path. - Service oracle_sap_hva: The Oracle ASM home directory.
AsmPassword string: Field usage depends on service value: - Service oracle_hva: ASM password. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user's password. Mandatory if use_oracle_rac or asm_option is set to true.
AsmTns string: Field usage depends on service value: - Service oracle_hva: ASM TNS. - Service oracle_sap_hva: ASM TNS.
AsmUser string: Field usage depends on service value: - Service oracle_hva: ASM user. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user. Mandatory if use_oracle_rac or asm_option is set to true.
AttributionWindow string: Field usage depends on service value: - Service amazon_ads: Time period used to attribute conversions based on clicks.
AttributionWindowSize string: Field usage depends on service value: - Service tiktok_ads: Rollback sync duration to capture conversions. Set this to your configured attribution window in TikTok Ads. The default value is 7 days.
Audience string: Field usage depends on service value: - Service auth0: Your Auth0 API audience.
Auth string: Field usage depends on service value: - Service databricks_db: Token-based authentication type - Service redshift_db: Password-based authentication type - Service snowflake_db: Password-based or key-based authentication type
AuthCode string: Field usage depends on service value: - Service happyfox: Your HappyFox auth code.
AuthEnvironment string: Field usage depends on service value: - Service younium: Your Younium auth environment.
AuthMethod string: Field usage depends on service value: - Service aurora_postgres: Database authentication method - Service azure_postgres: Database authentication method - Service azure_sql_db: Authentication Method. - Service azure_sql_managed_db: Authentication Method. - Service google_cloud_postgresql: Database authentication method - Service heroku_postgres: Database authentication method - Service postgres: Database authentication method - Service postgres_rds: Database authentication method - Service sql_server_hva: Authentication Method - Service sql_server_sap_ecc_hva: Authentication Method - Service webhooks: The authentication mechanism you want to use
AuthMode string: Field usage depends on service value: - Service anaplan: The Anaplan authentication method. - Service concur: The Authentication Mode used by SAP Concur. It can be PasswordGrant or CompanyLevel auth mode - Service github: Authorization type.
AuthToken string: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback auth token.
AuthType string: Field usage depends on service value: - Service airtable: Type of authentication being used by connector - Service aws_cost_report: Access approach - Service azure_service_bus: The authentication mode to access the topic - Service dynamics_365: Authentication mechanism. Either one of OAUTH2, or SERVICE_PRINCIPAL. Default value OAUTH2 - Service gcs: Authorization type. Required for storage bucket authentication. - Service google_sheets: The OAuth value must be specified for this type of authorization. - Service jira: Authorization type. - Service mixpanel: Authentication Method - Service pardot: Authenticate using OAuth or HTTP Basic - Service qualtrics: Type of authentication being used by connector - Service s3: Access approach - Service wasabi_cloud_storage: The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: ACCESS_KEY.
AuthUrlRegion string: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP auth grant URL region.
AuthenticationMethod string: Field usage depends on service value: - Service adobe_analytics: Authentication Method - Service elastic_cloud: The authentication method used to connect to your cluster. - Service es_self_hosted: The authentication method used to connect to your cluster. - Service opendistro: The authentication method used to connect to your cluster. - Service opensearch: The authentication method used to connect to your cluster. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud authentication method. - Service salesforce: (Optional) Authentication type (default value = STANDARD) - Service salesforce_sandbox: (Optional) Authentication type (default value = STANDARD)
AuthorizationMethod string
AwsRegionCode string: Field usage depends on service value: - Service dynamodb: The AWS region code for the DynamoDB instance, e.g. us-east-1.
BackintConfigurationPath string
BackintExecutablePath string
BackwardSyncLimit string: Field usage depends on service value: - Service zendesk: Limit of the Historical Sync Time for selected tables
BaseCurrency string: Field usage depends on service value: - Service open_exchange_rates: Your Open Exchange Rates Base Currency.
BaseDomain string: Field usage depends on service value: - Service freshteam: Your company's Freshteam base domain name (usually company.freshteam.com).
BaseId string: Field usage depends on service value: - Service airtable: ID of base in Airtable
BaseUrl string: Field usage depends on service value: - Service aha: Your Aha! subdomain. - Service akeneo: Your Akeneo base URL. - Service billing_platform: Your BillingPlatform subdomain. - Service boostr: Your Boostr base URL. - Service brex: Your Brex Base URL - Service centra: Your Centra base URL. - Service cornerstone: Your Cornerstone base URL. - Service culture_amp: Your Culture Amp base URL. - Service datadog: Your Datadog base url. - Service factbird: Your Factbird base url. - Service fillout: Your Fillout Base URL. - Service financial_force: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service freshsales: Your Freshsales product. - Service gongio: Your Gong API Base URL. - Service ironclad: Your Ironclad base url. - Service jotform: Your Jotform base URL. - Service mailgun: Your Mailgun base URL. - Service nice: Your NICE base URL. - Service ortto: Your Ortto base URL. Possible values: api, api.au, api.eu. - Service prisma_cloud: Your Prisma Cloud admin console URL. - Service salesforce: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service salesforce_sandbox: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service stickyio: Your sticky.io base URL . - Service veevavault: Your Veeva Vault base URL. - Service vitally: Your Vitally base URL.
BearerToken string: Field usage depends on service value: - Service ada: Your Ada API Access Token. - Service crowddev: Your crowd.dev Auth Token. - Service customerio: Your Customer.io App API Key. - Service freshchat: Your Freshchat API Token. - Service hopin: Your Hopin API key. - Service orbit: Your Orbit API Token. - Service productboard: Your Productboard API key. - Service smarthr: Your SmartHR access token. - Service sprout: Your Sprout Social API Access Token. - Service zenefits: Your Zenefits bearer token.
BlobSasUrl string: Field usage depends on service value: - Service webhooks: The blob SAS URL of your Azure container. Required if bucket_service is set to AZURE.
Blockchain string: Field usage depends on service value: - Service rarible: Your Rarible Blockchain.
BrandId string: Field usage depends on service value: - Service oracle_moat_analytics: Your Oracle Moat Analytics Brand ID.
Breakdowns []string: Field usage depends on service value: - Service facebook: List of breakdowns which connector will sync. Possible breakdowns values.
Bucket string: Field usage depends on service value: - Service appsflyer: Customer S3 Bucket - Service aws_cloudtrail: The AWS bucket name which is configured for AWS CloudTrail. - Service aws_cost_report: The S3 bucket name with the AWS Cost and Usage Report - Service aws_inventory: The AWS bucket name that is configured for AWS Config. - Service aws_lambda: S3 Bucket - Service cloudfront: The bucket name for CloudFront. - Service gcs: The name of the GCS bucket. - Service google_play: The Google Cloud Storage source bucket. - Service heap: The S3 bucket name. - Service kinesis: The name of the Kinesis bucket. - Service s3: The S3 bucket name. Required for connector creation. - Service segment: The name of the Segment bucket. Must be populated if sync_type is set to S3. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket name. Required for connector creation.
BucketName string: Field usage depends on service value: - Service adjust: Your AWS S3 or GCS bucket. - Service google_analytics_360: The name of the bucket. - Service google_analytics_4_export: The name of the bucket.
BucketService string: Field usage depends on service value: - Service webhooks: Whether to store the events in Fivetran's container service or your S3 bucket. Default value: Fivetran.
BusinessAccounts []string: Field usage depends on service value: - Service reddit_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
BusinessId string: Field usage depends on service value: - Service birdeye: Your Birdeye Business ID.
BusinessUnit string: Field usage depends on service value: - Service deposco: Your Deposco business unit.
BusinessUnitId string: Field usage depends on service value: - Service pardot: Business Unit Id
Catalog string: Field usage depends on service value: - Service databricks_db: catalog to sync
Certificate string: Field usage depends on service value: - Service anaplan: The contents of your PEM certificate file. Must be populated if auth_mode is set to Certificate. - Service qualtrics: Your Client Certificate - Service salesforce: Provide content of the .pem certificate (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .pem certificate (only when authentication_method = ADVANCED).
ClickAttributionWindow string: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on clicks. Possible click_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'click' action.
Client string
ClientCert string: Field usage depends on service value: - Service apache_kafka: Kafka client certificate. - Service heroku_kafka: Heroku Kafka client certificate. Required for TLS security protocol.
ClientCertKey string: Field usage depends on service value: - Service apache_kafka: Kafka client certificate key. - Service heroku_kafka: Heroku Kafka client certificate key. Required for TLS security protocol.
ClientHost string: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Host.
ClientId string: Field usage depends on service value: - Service acumatica: Your Acumatica client ID. - Service adobe_analytics: Client ID from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client ID. - Service adp_workforce_now: Your ADP Client ID. - Service akamai: Your Akamai client ID. - Service akeneo: Your Akeneo client ID. - Service auth0: Your Auth0 client ID. - Service autodesk_bim_360: Your Autodesk BIM 360 client ID. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Id - Service billing_platform: Your BillingPlatform client ID. - Service bing_webmaster_tools: Your Bing Webmaster Tools client ID. - Service brightcove: Your Brightcove client ID. - Service brightpearl: Your Brightpearl client ID. - Service buildium: Your Buildium API client ID. - Service canvas_by_instructure: Your Canvas by Instructure client ID. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure client ID. - Service castor_edc: Your Castor EDC client Id. - Service clazar: Your Clazar client ID. - Service cloudbeds: Your Cloudbeds client ID. - Service commercetools: Your commercetools client ID. - Service concur: The SAP Concur Client ID. - Service constant_contact: Your Constant Contact client ID. - Service cornerstone: Your Cornerstone client ID. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo Client ID. - Service criteo_retail_media: Your Criteo Retail Media client ID. - Service culture_amp: Your Culture Amp client ID. - Service cvent: Your Cvent client ID. - Service d2l_brightspace: Your D2L Brightspace client ID. - Service dialpad: Your Dialpad client ID. - Service ebay: Your eBay app ID. - Service exact_online: Your Exact Online client ID. - Service fillout: Your Fillout client ID. - Service flexport: The Flexport API Key. - Service formstack: Your Formstack client ID. - Service genesys: Your Genesys client ID. - Service hana_sap_hva_ecc_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hana_sap_hva_s4_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hilti_ontrack: Your Hilti On!Track client ID. - Service ilevel: Your iLevel Client ID. - Service instructure: Your Instructure client ID. - Service integral_ad_science: Your integral_ad_science client id. - Service ironclad: Your Ironclad client ID. - Service jama_software: Your Jama Software client ID. - Service jibble: Your Jibble client ID. - Service khoros_communities: Your Khoros Communities client ID. - Service looker_source: Your Looker Client ID. - Service marketo: Marketo REST API Client Id. - Service medallia: Medallia Client ID - Service microsoft_entra_id: Your Microsoft Entra ID Client ID. - Service microsoft_power_bi: Your Microsoft Power BI client ID. - Service microsoft_teams: Your Microsoft Teams Client ID. - Service navan: Your Navan client ID. - Service nice: Your NICE client ID. - Service on24: Your ON24 client ID. - Service oracle_sap_hva_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service paychex: Your Paychex client ID. - Service paypal: Client ID of your PayPal client application. - Service paypal_sandbox: Client ID of your PayPal client application. - Service personio: Your Personio Client ID. - Service piwik_pro: Your Piwik PRO client ID. - Service podio: Your Podio client ID. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client ID. - Service prisma_cloud: Your Prisma Cloud access key ID. - Service procore: Your Procore client ID. - Service quora_ads: Your Quora Ads client ID. - Service reltio: Your Reltio client ID. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client ID. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client ID. - Service salesloft: Client ID of your Salesloft client application. - Service sana: Your Sana client ID. - Service sap_success_factors: Your SAP SuccessFactors Client ID. - Service servicenow: ServiceNow Client ID. - Service servicetitan: Your ServiceTitan client ID. - Service sharetribe: Your Sharetribe client ID. - Service shipnetwork: Your ShipNetwork client ID. - Service sigma_computing_source: Your Sigma Computing client ID. - Service skillstx: Your SkillsTX client ID. - Service skimlinks: Your Skimlinks client ID. - Service smartrecruiters: Your SmartRecruiters client ID. - Service splash: Your Splash client ID. - Service square: The Application ID of your organization. - Service standard_metrics: Your Standard Metrics Client ID. - Service sugarcrm: Your SugarCRM client ID. - Service swoogo: Your Swoogo client Id. - Service taboola: The Taboola client ID. - Service talkdesk: The Client ID of your OAuth Client - Service tive: Your Tive client ID. - Service toast: Your Toast client ID. - Service trelica: Your Trelica client ID. - Service tremendous: Your Tremendous client ID. - Service tymeshift: Your Tymeshift email. - Service udemy_business: Your Udemy Business client ID. - Service vimeo: Your Vimeo client ID. - Service visma: Your Visma client ID. - Service vonage_contact_center: Your Vonage Contact Center client ID. - Service walmart_marketplace: Your Walmart Marketplace client ID. - Service xero: your clientId - Service xray: Your Xray Client ID. - Service yougov_sport: Your Yougov Sport client ID. - Service zendesk_chat: Your Zendesk client ID. - Service zoho_books: Your Zoho Books Client ID. - Service zoho_campaigns: Your Zoho Campaigns Client ID. - Service zoho_desk: Your Zoho Desk Client Id. - Service zoho_inventory: Your Zoho Inventory client ID. - Service zuora: Zuora Client ID. - Service zuora_sandbox: Zuora Client ID.
ClientKey string: Field usage depends on service value: - Service appfigures: Your Appfigures Client Key. - Service thinkific: Your Thinkific client key. - Service yougov_sport: Your Yougov Sport client key.
ClientName string: Field usage depends on service value: - Service destini: Your Destini Client Name. - Service medallia: Medallia company name
ClientNamespace string: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Namespace.
ClientPrivateKey string: Field usage depends on service value: - Service aurora_postgres: Client Private Key in .pem format. - Service azure_postgres: Client Private Key in .pem format. - Service google_cloud_postgresql: Client Private Key in .pem format. - Service heroku_postgres: Client Private Key in .pem format. - Service postgres: Client Private Key in .pem format. - Service postgres_rds: Client Private Key in .pem format.
ClientPublicCertificate string: Field usage depends on service value: - Service aurora_postgres: Client Certificate in .pem format. - Service azure_postgres: Client Certificate in .pem format. - Service google_cloud_postgresql: Client Certificate in .pem format. - Service heroku_postgres: Client Certificate in .pem format. - Service postgres: Client Certificate in .pem format. - Service postgres_rds: Client Certificate in .pem format.
ClientSecret string: Field usage depends on service value: - Service acumatica: Your Acumatica client secret. - Service adobe_analytics: Client Secret from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client secret. - Service adp_workforce_now: Your ADP Client Secret. - Service akamai: Your Akamai client secret. - Service akeneo: Your Akeneo client secret. - Service auth0: Your Auth0 client secret. - Service autodesk_bim_360: Your Autodesk BIM 360 client secret. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Secret - Service billing_platform: Your BillingPlatform client secret. - Service bing_webmaster_tools: Your Bing Webmaster Tools client secret. - Service brightcove: Your Brightcove client secret. - Service brightpearl: Your Brightpearl client secret. - Service canvas_by_instructure: Your Canvas by Instructure client secret. - Service castor_edc: Your Castor EDC Client Secret. - Service clazar: Your Clazar client secret. - Service cloudbeds: Your Cloudbeds client secret. - Service commercetools: Your commercetools client secret. - Service concur: The SAP Concur Client secret. - Service constant_contact: Your Constant Contact client secret. - Service cornerstone: Your Cornerstone client secret. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo client secret key. - Service criteo_retail_media: Your Criteo Retail Media client secret. - Service culture_amp: Your Culture Amp client secret. - Service cvent: Your Cvent client secret. - Service d2l_brightspace: Your D2L Brightspace client secret. - Service dialpad: Your Dialpad client secret. - Service ebay: Your eBay cert ID. - Service exact_online: Your Exact Online client secret. - Service fillout: Your Fillout client secret - Service flexport: The Flexport API Secret. - Service formstack: Your Formstack client secret. - Service genesys: Your Genesys client secret. - Service hilti_ontrack: Your Hilti On!Track client secret. - Service ilevel: Your iLevel Client Secret. - Service instructure: Your Instructure client secret. - Service integral_ad_science: Your integral_ad_science client secret. - Service ironclad: Your Ironclad client secret. - Service jama_software: Your Jama Software client secret. - Service jibble: Your Jibble client secret. - Service looker_source: Your Looker Client Secret. - Service marketo: Marketo REST API Client Secret. - Service medallia: Medallia Client Secret key - Service microsoft_entra_id: Your Microsoft Entra ID Client Secret. - Service microsoft_power_bi: Your Microsoft Power BI client secret. - Service microsoft_teams: Your Microsoft Teams Client Secret. - Service navan: Your Navan client secret. - Service nice: Your NICE client secret. - Service paychex: Your Paychex client secret. - Service personio: Your Personio secret. - Service piwik_pro: Your Piwik PRO client secret. - Service podio: Your Podio client secret. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client Secret. - Service prisma_cloud: Your Prisma Cloud secret access Key. - Service procore: Your Procore client secret. - Service quora_ads: Your Quora Ads client secret. - Service reltio: Your Reltio client secret. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client secret. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client secret. - Service salesloft: Client Secret of your Salesloft client application. - Service sana: Your Sana client secret. - Service sap_success_factors: Your SAP SuccessFactors Client Secret that you generated through SAML Assertion. - Service servicenow: ServiceNow Client Secret. - Service servicetitan: Your ServiceTitan secret key. - Service sharetribe: Your Sharetribe client secret. - Service sigma_computing_source: Your Sigma Computing client secret. - Service skillstx: Your SkillsTX client secret. - Service skimlinks: Your Skimlinks client secret. - Service smartrecruiters: Your SmartRecruiters client secret. - Service splash: Your Splash client secret. - Service square: The Application Secret of your organization. - Service standard_metrics: Your Standard Metrics Client secret. - Service sugarcrm: Your SugarCRM client secret. - Service swoogo: Your Swoogo Client Secret. - Service taboola: The Taboola client secret. - Service talkdesk: The Client Secret of your OAuth Client - Service thinkific: Your Thinkific client secret. - Service tive: Your Tive client secret. - Service toast: Your Toast client secret. - Service trelica: Your Trelica client secret. - Service tremendous: Your Tremendous client secret. - Service tymeshift: Your Tymeshift password. - Service udemy_business: Your Udemy Business client secret. - Service vimeo: Your Vimeo client secret. - Service visma: Your Visma client secret. - Service vonage_contact_center: Your Vonage Contact Center client secret. - Service walmart_marketplace: Your Walmart Marketplace client secret. - Service xero: your clientSecret - Service xray: Your Xray Client Secret. - Service zendesk_chat: Your Zendesk client secret. - Service zoho_books: Your Zoho Books Client Secret. - Service zoho_campaigns: Your Zoho Campaigns Client Secret. - Service zoho_desk: Your Zoho Desk Client secret. - Service zoho_inventory: Your Zoho Inventory client secret. - Service zuora: Zuora Client Secret. - Service zuora_sandbox: Zuora Client Secret.
CloudStorageType string: Field usage depends on service value: - Service braze: Cloud storage type Braze Current is connected to.
CollectionAddress string: Field usage depends on service value: - Service rarible: Your Rarible Collection Address.
Columns []string: Field usage depends on service value: - Service double_click_publishers: Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.
CommunityDomain string: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community domain.
CommunityId string: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community ID.
Companies []string: Field usage depends on service value: - Service business_central: List of companies to sync
Company string: Field usage depends on service value: - Service ordway: Your Ordway company name.
CompanyId string: Field usage depends on service value: - Service 360learning: Your 360Learning Company ID. - Service sage_intacct: Company ID - Service sap_success_factors: Your SAP SuccessFactors Company ID.
CompanyIds string: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail company IDs.
CompanyKey string: Field usage depends on service value: - Service khoros_care: Your Khoros Care companyKey. - Service upland: Your Upland Software Company Key.
CompanyName string: Field usage depends on service value: - Service clockodo: Your Clockodo company name.
CompanyRequestToken string: Field usage depends on service value: - Service concur: The SAP Concur Company Request Token
CompanyUuid string: Field usage depends on service value: - Service concur: The SAP Concur Company UUID
Compression string: Field usage depends on service value: - Service aws_cost_report: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service azure_blob_storage: The secrets that should be passed to the function at runtime. - Service box: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service dropbox: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service email: The secrets that should be passed to the function at runtime. - Service ftp: The secrets that should be passed to the function at runtime. - Service gcs: The secrets that should be passed to the function at runtime. - Service google_drive: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service kinesis: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service s3: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service sftp: The secrets that should be passed to the function at runtime. - Service share_point: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service wasabi_cloud_storage: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
ConfigMethod string: Field usage depends on service value: - Service google_display_and_video_360: The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is CREATE_NEW.
ConfigRepositoryUrl string: Field usage depends on service value: - Service snowplow: Public repository URL containing JSON configuration files.
ConfigType string: Field usage depends on service value: - Service facebook: Option to select Prebuilt Reports or Custom Reports. Possible config_type values. - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports.
ConnectPassword string: Field usage depends on service value: - Service xactly: Your Xactly Connect password.
ConnectUsername string: Field usage depends on service value: - Service xactly: Your Xactly Connect username.
ConnectingUser string
ConnectingUserEmail string
ConnectionMethod string: Field usage depends on service value: - Service aws_msk: How Fivetran connects to your message brokers in the cluster - Service azure_blob_storage: Connection Method. Possible values: 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. - Service azure_function: Connection Method. Possible values: DIRECT: Fivetran will connect directly to your function, PRIVATE_LINK: Fivetran will connect to your storage container using PrivateLink. - Service azure_service_bus: The connection method - Service sftp: The connection method used to connect to SFTP Server.
ConnectionName string: Field usage depends on service value: - Service appsflyer: Your Data Locker Connection Name. Default value: `data-locker-hourly/
ConnectionString string: Field usage depends on service value: - Service azure_blob_storage: The blob storage container connection string. - Service azure_event_hub: Connection string of the Event Hub Namespace you want to sync. - Service azure_service_bus: The connection string used for authentication. Required if the authentication type is ConnectionString - Service microsoft_dynamics_365_fno: The blob storage container's connection string. - Service microsoft_dynamics_365_fo: The blob storage container connection string.
ConnectionType string: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service aws_cost_report: Connection method. Default value: Directly. - Service aws_lambda: Connection method. Default value: Directly. - Service azure_blob_storage: Connection method. Default value: Directly. - Service azure_cosmos_for_mongo: Possible values:Directly, PrivateLink. Directly is the default value - Service azure_postgres: 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. - Service azure_sql_db: 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. - Service azure_sql_managed_db: 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. - Service bigquery_db: Direct or PrivateLink connection - Service clarity: 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. - Service cockroachdb: Possible values:Directly, 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. - Service db2i_hva: Possible values:SshTunnel. SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service db2i_sap_hva: 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. - Service documentdb: Possible values:SshTunnel, PrivateLink . SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service dynamics_365_fo: 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. - Service ehr: 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. - Service elastic_cloud: Possible values:Directly, 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. - Service email: Connection method. Default value: Directly. - Service es_self_hosted: Possible values:Directly, 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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service heroku_postgres: 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. - Service kinesis: Connection method. Default value: Directly. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mongo: 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. - Service mongo_sharded: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service opendistro: Possible values:Directly, 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. - Service opensearch: Possible values:Directly, 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Directly or Private Link - Service s3: Connection method. Default value: Directly. - Service sap_hana: 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. - Service sap_s4hana: Connection Method - Service snowflake_db: Directly or Private Link - Service sql_server: 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. - Service sql_server_hva: 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. - Service sql_server_rds: 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. - Service sql_server_sap_ecc_hva: 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.
ConsoleUrl string: Field usage depends on service value: - Service prisma_cloud: Your Prisma Cloud console URL.
ConsumerGroup string: Field usage depends on service value: - Service apache_kafka: Kafka consumer group name. - Service aws_msk: The name of consumer group created for Fivetran. - Service azure_event_hub: Name of consumer group created for Fivetran. - Service confluent_cloud: Confluent Cloud consumer group name. - Service heroku_kafka: Heroku Kafka consumer group name.
ConsumerKey string: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Key - Service twitter: API Key of your app - Service twitter_ads: The Twitter App consumer key. - Service woocommerce: Your WooCommerce Consumer key.
ConsumerName string: Field usage depends on service value: - Service xactly: Your Xactly Connect consumer name.
ConsumerSecret string: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Secret - Service twitter: API Secret of your app - Service twitter_ads: The Twitter App consumer secret. - Service woocommerce: Your WooCommerce Consumer secret.
ContainerAddress string: Field usage depends on service value: - Service azure_blob_storage: IP address of the Azure Storage Container which is accessible from host machine.
ContainerName string: Field usage depends on service value: - Service azure_blob_storage: The name of the blob container. - Service microsoft_dynamics_365_fno: The name of the blob container. - Service microsoft_dynamics_365_fo: The name of the blob container.
ContentOwnerId string: Field usage depends on service value: - Service youtube_analytics: Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.
ContractVersion string: Field usage depends on service value: - Service acumatica: Your Acumatica contract version.
ConversationWebhookUrl string: Field usage depends on service value: - Service helpscout: Your conversation webhook URL
ConversionDimensions []string: Field usage depends on service value: - Service double_click_campaign_manager: Conversion Dimensions.
ConversionReportTime string: Field usage depends on service value: - Service pinterest_ads: The date that the user interacted with the ad OR completed a conversion event.
ConversionWindowSize float64: Field usage depends on service value: - Service google_ads: A period of time in days during which a conversion is recorded.
ConvertDatsTypeToDate bool
CsvDefinition string: Field usage depends on service value: - Service adjust: CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition).
Currency string: Field usage depends on service value: - Service criteo: Currency - Service rokt: Your Rokt currency.
CustomBaseUrl string: Field usage depends on service value: - Service datadog: Your Datadog custom base url. - Service deposco: Your Deposco custom base URL.
CustomEventSyncMode string: Field usage depends on service value: - Service iterable: Custom Events Sync Mode.
CustomEvents []string: Field usage depends on service value: - Service iterable: List of custom events to sync. Should be specified when custom_event_sync_mode is SelectedEvents
CustomFieldIds []string: Field usage depends on service value: - Service double_click_publishers: The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.
CustomFloodlightVariables []string: Field usage depends on service value: - Service double_click_campaign_manager: Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.
CustomPayloads []GetConnectorConfigCustomPayload: Field usage depends on service value: - Service aws_lambda: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service azure_function: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service google_cloud_function: The list of key-value pairs that can be used to specify custom information to the function at runtime.
CustomReports []GetConnectorConfigCustomReport: Field usage depends on service value: - Service reddit_ads: The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data. - Service snapchat_ads: Custom reports for Snapchat Ads connector. - Service tiktok_ads: Title of Custom Report
CustomTables []GetConnectorConfigCustomTable: Field usage depends on service value: - Service facebook_ads: List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data.
CustomUrl string: Field usage depends on service value: - Service dbt_cloud: Your dbt Cloud access url. - Service factbird: Your Factbird custom base url. - Service jotform: Your Jotform custom base URL.
CustomerApiKey string: Field usage depends on service value: - Service ukg_pro: Your UKG Pro Customer API key.
CustomerId string: Field usage depends on service value: - Service google_ads: ID of the customer, can be retrieved from your AdWords dashboard.
CustomerListId string: Field usage depends on service value: - Service salesforce_commerce_cloud: The parameter to retrieve customer details.
DailyApiCallLimit float64
DataAccessMethod string: Field usage depends on service value: - Service cosmos: The source data access method. Supported values:ACCOUNT_KEY- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.RESOURCE_TOKEN- Fine-grained permission model based on native Azure Cosmos DB users and permissions. Learn more in our Azure Cosmos DB Data Access Methods documentation.
DataCenter string: Field usage depends on service value: - Service brightpearl: Your Brightpearl data center. - Service qualtrics: 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.) - Service zoho_crm: Data Center, depending on the Domain name
DataCenterId string: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback data center ID.
DataSetName string: Field usage depends on service value: - Service bigquery_db: Data set name
Database string: Field usage depends on service value: - Service aurora: The database name. - Service aurora_postgres: The database name. - Service azure_cosmos_for_mongo: Authentication database for the source. Usually 'admin'. - Service azure_postgres: The database name. - Service azure_sql_db: The database name. - Service azure_sql_managed_db: The database name. - Service clarity: The database name. - Service cockroachdb: The database name. - Service db2i_hva: The database name. - Service db2i_sap_hva: The database name. - Service dynamics_365_fo: The database name. - Service ehr: The database name. - Service google_cloud_mysql: The database name. - Service google_cloud_postgresql: The database name. - Service google_cloud_sqlserver: The database name. - Service hana_sap_hva_b1: The Hana database name. - Service hana_sap_hva_ecc: The Hana database name. - Service hana_sap_hva_ecc_netweaver: The Hana database name. - Service hana_sap_hva_s4: The Hana database name. - Service hana_sap_hva_s4_netweaver: The Hana database name. - Service heroku_postgres: The database name. - Service magento_mysql: The database name. - Service magento_mysql_rds: The database name. - Service maria: The database name. - Service maria_azure: The database name. - Service maria_rds: The database name. - Service mysql: The database name. - Service mysql_azure: The database name. - Service mysql_rds: The database name. - Service oracle: The database name. - Service oracle_ebs: The database name. - Service oracle_hva: The database name. - Service oracle_rac: The database name. - Service oracle_rds: The database name. - Service oracle_sap_hva: The database name. - Service postgres: The database name. - Service postgres_rds: The database name. - Service redshift_db: The database name: Redshift - Service sap_hana: The database name. - Service sap_s4hana: The database name. - Service snowflake_db: The database name: Snowflake - Service sql_server: The database name. - Service sql_server_hva: The database name. - Service sql_server_rds: The database name. - Service sql_server_sap_ecc_hva: The database name.
DatabaseName string: Field usage depends on service value: - Service firebase: Database Name
DatasetId string: Field usage depends on service value: - Service google_analytics_360: The dataset ID. - Service google_analytics_4_export: The Dataset ID.
Datasource string: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite data source value: NetSuite.com.
DateGranularity string: Field usage depends on service value: - Service adobe_analytics: The aggregation duration you want. Default value: HOUR .
Db string: Field usage depends on service value: - Service myosh: Your Myosh Server variables/db .
Delimiter string: Field usage depends on service value: - Service aws_cost_report: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service azure_blob_storage: 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. - Service box: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service dropbox: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service kinesis: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service s3: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service sftp: 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. - Service share_point: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service wasabi_cloud_storage: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
DeveloperReference string: Field usage depends on service value: - Service brightpearl: Your Brightpearl dev reference.
DimensionAttributes []string: Field usage depends on service value: - Service double_click_publishers: Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions.
Dimensions []string: Field usage depends on service value: - Service adroll: The dimenstions that you want to sync. - Service double_click_campaign_manager: 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 - Service double_click_publishers: Report dimensions to include in the sync. The date dimension is mandatory for all the report types. - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_display_and_video_360: 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.
DirectCaptureMethod string: Field usage depends on service value: - Service oracle_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY - Service oracle_sap_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY
DistributedConnectorClusterSize float64: Field usage depends on service value: - Service cosmos: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel. - Service dynamodb: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel.
Domain string: Field usage depends on service value: - Service auth0: Your Auth0 domain. - Service bubble: Your Bubble app name or domain name. - Service confluence: Your Confluence domain. - Service kustomer: Domain is the beginning of your kustomer URL going before .kustomerapp.com, e.g. for yourcompany.kustomerapp.com the domain name is yourcompany - Service okta: Your Okta domain. - Service pipedrive: Your Pipedrive domain. - Service shopware: Your Shopware domain. - Service sistrix: Your SISTRIX domain. - Service solarwinds_service_desk: Your SolarWinds Service Desk domain. - Service uservoice: Domain of your UserVoice site. If it ends with ".uservoice.com", you can specify just the subdomain ("mydomain.uservoice.com" - "mydomain") - Service zendesk: Zendesk domain. - Service zendesk_sunshine: Zendesk domain.
DomainHostName string: Field usage depends on service value: - Service workday: Workday host name. - Service workday_financial_management: Workday host name. - Service workday_hcm: Workday host name.
DomainName string: Field usage depends on service value: - Service calabrio: Your Calabrio domain name - Service dynamics_365: The custom domain name associated with Dynamics 365. - Service helpshift: Your Helpshift domain name.
DomainType string: Field usage depends on service value: - Service medallia: Domain type of your Medallia URL
DsvServiceAuth string
DsvSubscriptionKey string
EcommerceStores []string: Field usage depends on service value: - Service mailchimp: List of IDs of the Mailchimp E-Commerce Stores to Sync
Edition string
Elements []string
Email string: Field usage depends on service value: - Service appcues: Your Appcues Email. - Service boostr: Your Boostr email. - Service copper: Your Copper email address. - Service email: Send your emails to this address. - Service moloco: Your Moloco account email. - Service netsuite_suiteanalytics: The NetSuite user's email address. - Service pardot: The email of the Pardot user. - Service skuvault: Your SkuVault email. - Service smadex: Your Smadex account's email ID. - Service zendesk: Zendesk email. - Service zendesk_sunshine: Zendesk email.
EmailAddress string: Field usage depends on service value: - Service clockodo: Your Clockodo email address.
EmailId string: Field usage depends on service value: - Service ordway: Your Ordway user email ID. - Service planful: Your Planful email ID.
EmptyHeader bool: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service azure_blob_storage: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service box: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service dropbox: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service email: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service ftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service gcs: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service google_drive: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service kinesis: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service s3: 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. - Service sftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service share_point: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service wasabi_cloud_storage: 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.
EnableAllDimensionCombinations bool: Field usage depends on service value: - Service double_click_campaign_manager: Whether to enable all reach dimension combinations in the report. Default value: false
EnableArchiveLogOnly bool: Field usage depends on service value: - Service sql_server_hva: Use archive log only mode - Service sql_server_sap_ecc_hva: Use archive log only mode
EnableDataExtensionsSyncing bool
EnableDistributedConnectorMode bool: Field usage depends on service value: - Service cosmos: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors. - Service dynamodb: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors.
EnableEnrichments bool: Field usage depends on service value: - Service snowplow: Enable Enrichments
EnableExports bool: Field usage depends on service value: - Service braze: Enable User Profile Exports
EnableTde bool: Field usage depends on service value: - Service sql_server_hva: Using Transparent Data Encryption (TDE) - Service sql_server_sap_ecc_hva: Using Transparent Data Encryption (TDE)
EncodedPublicKey string: Field usage depends on service value: - Service apple_search_ads: Use the public key to grant Fivetran access to Apple Search Ads api.
EncryptionKey string: Field usage depends on service value: - Service marketo: Marketo SOAP API Encryption Key.
Endpoint string: Field usage depends on service value: - Service branch: Webhook Endpoint - Service iterable: Register the following URL for webhooks on your Iterable dashboard. - Service marketo: Marketo REST API endpoint. - Service snowplow: Connection-specific collector endpoint. The collector endpoint will have the webhooks.fivetran.com/snowplow/endpoint_ID format. You will need it to configure Snowplow to connect with Fivetran. - Service webhooks: You can send your events to https://webhooks.fivetran.com/webhooks/{endpoint}
EngagementAttributionWindow string: Field usage depends on service value: - Service pinterest_ads: The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action.
EnrichedExport string: Field usage depends on service value: - Service optimizely: Enriched Events S3 bucket
EntityId string: Field usage depends on service value: - Service checkout: Your Checkout.com entity ID. - Service zuora: If is_multi_entity_feature_enabled is true, then it's EntityId. - Service zuora_sandbox: If is_multi_entity_feature_enabled is true, then it's EntityId.
Environment string: Field usage depends on service value: - Service bazaarvoice: Your Bazaarvoice environment. - Service buildium: Your Buildium environment. - Service checkout: Your Checkout.com environment. - Service concord: Your Concord environment. - Service deposco: Your Deposco environment. - Service dialpad: Your Dialpad environment. - Service invoiced: Your Invoiced environment. - Service jibble: Your Jibble environment. - Service lucca: Your Lucca environment. - Service procore: Your Procore account environment. - Service reltio: Your Reltio environment. - Service servicetitan: Your ServiceTitan environment. - Service smarthr: Your SmartHR environment. - Service trelica: Your Trelica environment. - Service tremendous: Your Tremendous environment. - Service vts: Your VTS environment. - Service xactly: Your Xactly environment. - Service younium: Your Younium API environment. - Service zuora: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox. - Service zuora_sandbox: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
EnvironmentHost string: Field usage depends on service value: - Service xactly: Your Xactly environment host.
EnvironmentName string: Field usage depends on service value: - Service business_central: Name of the environment
EscapeChar string: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service azure_blob_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service box: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service dropbox: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service email: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service ftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service gcs: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service google_drive: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service kinesis: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service s3: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service sftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service share_point: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service wasabi_cloud_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
EscapeCharOptions string: Field usage depends on service value: - Service gcs: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true. - Service s3: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true.
EuRegion bool: Field usage depends on service value: - Service kustomer: Turn it on if your app is on EU region - Service survey_monkey: The SurveyMonkey account region. Specify true, if your account is hosted in the EU region. Default value is false.
Events []string: Field usage depends on service value: - Service iterable: List of events to sync. Should be specified when sync_mode is SelectedEvents
ExportStorageType string: Field usage depends on service value: - Service adjust: Your cloud storage. - Service braze: Export Storage. Required if enable_exports is true
ExternalId string: Field usage depends on service value: - Service appsflyer: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_cloudtrail: This is the same as your group_id, used for authentication along with the role_arn. - Service aws_cost_report: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_lambda: The external ID is a string that designates who can assume the role. - Service aws_msk: This is the same as your group_id. This is required when sasl_mechanism is set to IAM. - Service azure_function: External ID. - Service cloudfront: This is the same as your group_id, used for authentication along with the role_arn. - Service dynamodb: This is the same as your group_id, used for authentication along with the role_arn. - Service kinesis: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service s3: Used for authentication along with the role_arn. If not provided, it uses connector's group_id. Use the List All Groups endpoint to find the group_id. - Service segment: The external ID is a string that designates who can assume the role. For more information, see a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"Amazon's AWS Identity and Access Management User Guide/a.
FacilityCodes string: Field usage depends on service value: - Service unicommerce: Your uniware facility codes.
Fields []string: Field usage depends on service value: - Service facebook: List of fields which connector will sync. Possible field values.
FileType string: Field usage depends on service value: - Service aws_cost_report: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service azure_blob_storage: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service box: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service dropbox: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service email: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service ftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service gcs: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service google_drive: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service kinesis: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service s3: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service sftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service share_point: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service wasabi_cloud_storage: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
Filter string: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
FinanceAccountSyncMode string: Field usage depends on service value: - Service itunes_connect: Whether to sync all finance accounts or specific finance accounts.
FinanceAccounts []string: Field usage depends on service value: - Service itunes_connect: Specific finance accounts to sync. Must be populated if finance_account_sync_mode is set to SpecificFinanceAccounts.
Folder string: Field usage depends on service value: - Service dropbox: Your Dropbox Folder URL.
FolderId string: Field usage depends on service value: - Service box: Folder URL - Service google_drive: Folder URL
FolderPath string: Field usage depends on service value: - Service adobe_analytics_data_feed: Folder Path - Service one_drive: Your OneDrive folder URL - Service oracle_business_intelligence_publisher: The folder path to save data models and reports.
ForecastId string: Field usage depends on service value: - Service clari: Your Clari Forecast id .
FtpHost string: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP host.
FtpPassword string: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP password.
FtpPort float64: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP port.
FtpUser string: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP user.
Function string: Field usage depends on service value: - Service aws_lambda: The name of your AWS Lambda Function.
FunctionApp string: Field usage depends on service value: - Service azure_function: Function app name in Azure portal.
FunctionKey string: Field usage depends on service value: - Service azure_function: Function key used for authorization.
FunctionName string: Field usage depends on service value: - Service azure_function: Name of the function to be triggered.
FunctionTrigger string: Field usage depends on service value: - Service google_cloud_function: The trigger URL of the cloud function.
GcsBucket string: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the cloud_storage_type - Service webhooks: The GCS bucket name. Required if bucket_service is set to GCS.
GcsExportBucket string: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the export_storage_type
GcsExportFolder string: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the export_storage_type
GcsFolder string: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the cloud_storage_type
GenerateFivetranPk bool: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
GroupId string: Field usage depends on service value: - Service line_ads: Your LINE Ads group ID(s).
GroupName string: Field usage depends on service value: - Service fivetran_log: (Optional) The group name of the target_group_id.
HanaBackupPassword string
HanaMode string: Field usage depends on service value: - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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.
HasManagePermissions bool: Field usage depends on service value: - Service azure_service_bus: The boolean value specifying whether the connection string has manage permissions
HistoricSyncTimeFrame string: Field usage depends on service value: - Service braze: Range of data in history you would like to include in the initial sync. - Service iterable: The time range for which historical data should be synced. Default value: All Time. - Service klaviyo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service marketo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service sailthru: Range of historical data you would like to include in the initial sync. Default value: ALL_TIME. - Service salesforce_marketing_cloud: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME.
HistoricalSyncLimit string: Field usage depends on service value: - Service concur: Historical Sync Limit for the Sync - Service eloqua: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service pardot: The time range for which historical data should be synced. Default value: All Time.
HistoricalSyncTimeFrame string: Field usage depends on service value: - Service rokt: Your Rokt historical sync time frame. - Service skimlinks: Your Skimlinks Historical sync time frame. - Service vimeo: Your Vimeo Historical sync time frame. - Service zendesk: Used to configure Historical sync timeframe for selected tables
HomeFolder string: Field usage depends on service value: - Service appsflyer: Your S3 home folder path of the Data Locker.
Host string: Field usage depends on service value: - Service aurora: DB instance host or IP address. - Service aurora_postgres: DB instance host or IP address. - Service azure_postgres: DB instance host or IP address. - Service azure_sql_db: DB instance host or IP address. - Service azure_sql_managed_db: DB instance host or IP address. - Service clarity: DB instance host or IP address. - Service cockroachdb: DB instance host or IP address. - Service commercetools: Your commercetools host. - Service databricks_db: The host URL for your Databricks account. - Service db2i_hva: A host address of the primary node. It should be a DB instance host/IP address with a port number. - Service db2i_sap_hva: DB instance host or IP address. - Service documentdb: Host IP address of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: DB instance host or IP address. - Service ehr: DB instance host or IP address. - Service elastic_cloud: DB instance host or IP address. - Service es_self_hosted: DB instance host or IP address. - Service ftp: FTP host address. - Service google_cloud_mysql: DB instance host or IP address. - Service google_cloud_postgresql: DB instance host or IP address. - Service google_cloud_sqlserver: DB instance host or IP address. - Service hana_sap_hva_b1: DB instance host or IP address. - Service hana_sap_hva_ecc: DB instance host or IP address. - Service hana_sap_hva_ecc_netweaver: DB instance host or IP address. - Service hana_sap_hva_s4: DB instance host or IP address. - Service hana_sap_hva_s4_netweaver: DB instance host or IP address. - Service heroku_postgres: DB instance host or IP address. - Service jira: The Jira service host address. - Service magento_mysql: DB instance host or IP address. - Service magento_mysql_rds: DB instance host or IP address. - Service maria: DB instance host or IP address. - Service maria_azure: DB instance host or IP address. - Service maria_rds: DB instance host or IP address. - Service marin: The Marin host address. - Service mysql: DB instance host or IP address. - Service mysql_azure: DB instance host or IP address. - Service mysql_rds: DB instance host or IP address. - Service netsuite_suiteanalytics: The NetSuite service host address. - Service opendistro: DB instance host or IP address. - Service opensearch: DB instance host or IP address. - Service oracle: DB instance host or IP address. - Service oracle_ebs: DB instance host or IP address. - Service oracle_hva: DB instance host or IP address. - Service oracle_rac: DB instance host or IP address. - Service oracle_rds: DB instance host or IP address. - Service oracle_sap_hva: DB instance host or IP address. - Service oracle_sap_hva_netweaver: DB instance host or IP address. - Service postgres: DB instance host or IP address. - Service postgres_rds: DB instance host or IP address. - Service redshift_db: Host name - Service sap_hana: The SAP HANA host or IP address. - Service sap_s4hana: The SAP S/4 host or IP address. - Service sftp: SFTP host address. - Service snowflake_db: Host name - Service splunk: The Splunk service host address. - Service sql_server: DB instance host or IP address. - Service sql_server_hva: DB instance host or IP address. - Service sql_server_rds: DB instance host or IP address. - Service sql_server_sap_ecc_hva: DB instance host or IP address.
HostIp string: Field usage depends on service value: - Service azure_blob_storage: IP address of host tunnel machine which is used to connect to the Storage container. - Service azure_service_bus: The IP address of the host machine which we use to connect to ASB via ssh
HostName string: Field usage depends on service value: - Service coassemble: Your Coassemble Hostname. - Service datadog: Your Datadog host name.
HostUrl string: Field usage depends on service value: - Service adobe_commerce: Your Adobe Commerce host url. - Service sparkpost: Your SparkPost host URL.
HostUser string: Field usage depends on service value: - Service azure_blob_storage: Username in the host machine. - Service azure_service_bus: The username on the host machine which we use to connect to ASB via ssh
Hostname string: Field usage depends on service value: - Service akamai: Your Akamai hostname. - Service ukg_pro: Your UKG Pro hostname.
Hosts []string: Field usage depends on service value: - Service azure_cosmos_for_mongo: A list of host addresses for Azure Cosmos DB for Mongo DB. - Service mongo: 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. - Service mongo_sharded: 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.
HttpPath string: Field usage depends on service value: - Service databricks_db: http path
Identifier string: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management client identifier. - Service statistics_netherlands_cbs: Your Statistics Netherlands CBS catalog identifier.
Identity string: Field usage depends on service value: - Service marketo: Marketo REST API identity url.
IncludeOcapiEndpoints bool: Field usage depends on service value: - Service salesforce_commerce_cloud: Whether to sync data through OCAPI endpoints.
Instance string: Field usage depends on service value: - Service acumatica: Your Acumatica instance name. - Service coupa: The instance name of your Coupa account in the URL. - Service flywheel_digital: Your Flywheel Digital instance. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud instance ID - Service servicenow: ServiceNow Instance ID.
InstanceNumber string: Field usage depends on service value: - Service hana_sap_hva_b1: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service oracle_sap_hva_netweaver: Two-digit number (00-97) of the SAP instance within its host.
InstanceUrl string: Field usage depends on service value: - Service sap_business_by_design: The SAP Business ByDesign instance URL.
IntegrationKey string: Field usage depends on service value: - Service pendo: The integration key of the Pendo account.
IpAddress string: Field usage depends on service value: - Service aveva_pi: IP address of the AF Server
IsAccountLevelConnector bool: Field usage depends on service value: - Service fivetran_log: (Optional) Retrieve account-level logs.
IsAuth2Enabled bool: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Default value: false
IsCustomApiCredentials bool: Field usage depends on service value: - Service twitter_ads: Custom API credentials
IsExternalActivitiesEndpointSelected bool: Field usage depends on service value: - Service pardot: Whether the EXTERNAL_ACTIVITY table must be synced or not.
IsFtps bool: Field usage depends on service value: - Service adobe_analytics_data_feed: Use Secure FTP (FTPS).
IsKeypair bool: Field usage depends on service value: - Service sftp: Whether to use a key pair for authentication. When true, do not use password.
IsMultiEntityFeatureEnabled bool: Field usage depends on service value: - Service zuora: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false. - Service zuora_sandbox: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false.
IsNewPackage bool: Field usage depends on service value: - Service salesforce_marketing_cloud: Indicates that that your installed package uses OAuth 2.0. Default value: false
IsPrivateKeyEncrypted bool: Field usage depends on service value: - Service snowflake_db: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
IsPrivateLinkRequired bool: Field usage depends on service value: - Service aws_lambda: We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our PrivateLink documentation. - Service s3: Set to true if you want to connect to S3 bucket over PrivateLink. Default value: false.
IsPublic bool: Field usage depends on service value: - Service aws_cost_report: Whether you are syncing from a public bucket. Default value: false. - Service kinesis: Is the bucket public? (you don't need an AWS account for syncing public buckets!) - Service s3: Whether you are syncing from a public bucket. Default value: false.
IsSailthruConnectEnabled bool: Field usage depends on service value: - Service sailthru: Enable this if you want to sync Sailthru Connect
IsSecure bool: Field usage depends on service value: - Service ftp: Whether the server supports FTPS.
IsSftpCredsAvailable bool: Field usage depends on service value: - Service salesforce_marketing_cloud: Provide SFTP credentials
IsSingleTableMode bool: Field usage depends on service value: - Service box: Allows the creation of connector using Merge Mode strategy. - Service dropbox: Allows the creation of connector using Merge Mode strategy. - Service google_drive: Allows the creation of connector using Merge Mode strategy. - Service sftp: Allows the creation of connector using the specified Sync strategy. - Service share_point: Allows the creation of connector using Merge Mode strategy.
IsTestAccount bool: Field usage depends on service value: - Service adyen: Whether or not your Adyen Account is a Test Account. Default value: false.
IsVendor bool: Field usage depends on service value: - Service amazon_selling_partner: Whether or not you have a Vendor Account. Default value: false.
Issuer string: Field usage depends on service value: - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud issuer name.
JsonDeliveryMode string: Field usage depends on service value: - Service aws_cost_report: Control how your JSON data is delivered into your destination - Service azure_blob_storage: Control how your JSON data is delivered into your destination - Service box: Control how your JSON data is delivered into your destination - Service dropbox: Control how your JSON data is delivered into your destination - Service email: Control how your JSON data is delivered into your destination - Service ftp: Control how your JSON data is delivered into your destination - Service gcs: Control how your JSON data is delivered into your destination - Service google_drive: Control how your JSON data is delivered into your destination - Service kinesis: Control how your JSON data is delivered into your destination - Service s3: Control how your JSON data is delivered into your destination - Service sftp: Control how your JSON data is delivered into your destination - Service share_point: Control how your JSON data is delivered into your destination - Service wasabi_cloud_storage: Specifies how Fivetran should handle your JSON data. Default value: Packed.
Key string: Field usage depends on service value: - Service uservoice: The UserVoice API key.
KeyPassword string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Key Password.
KeyStoreType string: Field usage depends on service value: - Service heroku_kafka: Key Store Type
Keystore string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Keystore File as Base64 encoded string.
KeystorePassword string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Keystore Password.
LastSyncedChangesUtc_ string
LatestVersion string
LegalEntityId string: Field usage depends on service value: - Service younium: Your Younium legal entity ID.
LimitForApiCallsToExternalActivitiesEndpoint float64: Field usage depends on service value: - Service pardot: API limit for the external activities endpoint.
LineSeparator string: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
ListId string: Field usage depends on service value: - Service pigment: Your Pigment list ID.
ListOfCompanyIds string: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail list of company IDs.
ListStrategy string: Field usage depends on service value: - Service aws_cost_report: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service kinesis: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service s3: The listing strategy you want to use. Default value: complete_listing.
ListSyncMode string: Field usage depends on service value: - Service google_analytics_4_export: The Sync Mode
LogJournal string: Field usage depends on service value: - Service db2i_hva: The log journal name. - Service db2i_sap_hva: The log journal name.
LogJournalSchema string: Field usage depends on service value: - Service db2i_hva: The log journal schema. - Service db2i_sap_hva: The log journal schema.
LogOnGroup string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional. - Service hana_sap_hva_s4_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional.
Login string: Field usage depends on service value: - Service rebound_returns: Your ReBound Returns login. - Service the_trade_desk: The Trade Desk email. It is a part of the login credentials. - Service walmart_dsp: Walmart DSP email. It is a part of the login credentials.
LoginPassword string: Field usage depends on service value: - Service concur: The SAP Concur password. - Service sage_intacct: The login password. It is a part of the login credentials.
ManagerAccounts []string: Field usage depends on service value: - Service google_ads: The list of the Manager Account IDs whose clients will be synced. Must be populated if sync_mode is set to ManagerAccounts.
MaxApiRequestsPerDay float64: Field usage depends on service value: - Service reltio: Maximum API requests per day
MerchantId string: Field usage depends on service value: - Service afterpay: Your Afterpay Merchant ID. - Service amazon_selling_partner: The Merchant ID or Vendor Code. - Service avantlink: Your AvantLink Merchant ID. - Service braintree: Your Braintree merchant ID. - Service braintree_sandbox: Your Braintree merchant ID. - Service shareasale: Your ShareASale merchant ID. - Service xsolla: Your Xsolla Merchant ID.
MessageType string: Field usage depends on service value: - Service apache_kafka: Kafka message type. - Service aws_msk: The Message type. - Service azure_event_hub: Message type. - Service azure_service_bus: The format of messages in the topic - Service confluent_cloud: Confluent Cloud message type. - Service heroku_kafka: Heroku Kafka message type.
MetricId string: Field usage depends on service value: - Service pigment: Your Pigment metric ID.
Metrics []string: Field usage depends on service value: - Service adroll: The metrics that you want to sync. - Service criteo: Metrics - Service double_click_campaign_manager: Report metrics to include into a sync. - Service google_analytics: The report metrics to include into a sync. - Service google_display_and_video_360: 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.
NamedRange string: Field usage depends on service value: - Service google_sheets: The name of the named data range on the sheet that contains the data to be synced.
Namespace string: Field usage depends on service value: - Service azure_service_bus: The ASB namespace which we have to sync. Required for AzureActiveDirectory authentication.
NetworkCode float64: Field usage depends on service value: - Service double_click_publishers: Network code is a unique, numeric identifier for your Ad Manager network.
NonStandardEscapeChar bool: Field usage depends on service value: - Service gcs: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false. - Service s3: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false.
NullSequence string: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service azure_blob_storage: If your CSVs use a special value indicating null, you can specify it here. - Service box: If your CSVs use a special value indicating null, you can specify it here. - Service dropbox: If your CSVs use a special value indicating null, you can specify it here. - Service email: If your CSVs use a special value indicating null, you can specify it here. - Service ftp: If your CSVs use a special value indicating null, you can specify it here. - Service gcs: If your CSVs use a special value indicating null, you can specify it here. - Service google_drive: If your CSVs use a special value indicating null, you can specify it here. - Service kinesis: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service s3: If your CSVs use a special value indicating null, you can specify it here. - Service sftp: If your CSVs use a special value indicating null, you can specify it here. - Service share_point: If your CSVs use a special value indicating null, you can specify it here. - Service wasabi_cloud_storage: If your CSVs use a special value indicating null, you can specify it here.
OauthToken string
OauthTokenSecret string
OcapiClientId string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client ID.
OcapiClientSecret string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client secret.
OcapiCustomObjectTypes string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI custom object types.
OcapiHostname string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI hostname.
OdbcDriverManagerLibraryPath string: Field usage depends on service value: - Service hana_sap_hva_b1: ODBC manager library path - Service hana_sap_hva_ecc: ODBC manager library path - Service hana_sap_hva_s4: ODBC manager library path
OdbcSysIniPath string: Field usage depends on service value: - Service hana_sap_hva_b1: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_ecc: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_s4: odbc.ini and odbcsinst.ini location
OnError string: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
OnPremise bool: Field usage depends on service value: - Service jira: Whether the Jira instance is local or in cloud.
Organization string: Field usage depends on service value: - Service gladly: Your Gladly Organization Name. - Service statuspage: Your Statuspage Organization ID.
OrganizationDomain string: Field usage depends on service value: - Service adobe_workfront: Your Adobe Workfront organization domain.
OrganizationId string: Field usage depends on service value: - Service adobe_analytics: Organization ID from the Service Account (JWT) credentials of your Adobe Project. - Service integrate: Your Integrate organization ID. - Service megaphone: Your Megaphone organization ID. - Service productive: Your Productive Organization ID. - Service salesforce_commerce_cloud: The organization ID from Salesforce Commerce Cloud account. - Service sentry: Your Sentry organization ID. - Service zoho_books: Your Zoho Books Organization ID. - Service zoho_inventory: Your Zoho Inventory organization ID.
OrganizationName string: Field usage depends on service value: - Service brightpearl: Your Brightpearl organization name. - Service confluence: Your Confluence organization name.
Organizations []string: Field usage depends on service value: - Service apple_search_ads: Organizations - Service snapchat_ads: Specific organizations IDs to sync. Must be populated if syncMode is set to SpecificOrganizations.
PackedModeTables []string: Field usage depends on service value: - Service azure_cosmos_for_mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service dynamodb: List of tables to be synced in packed mode. - Service firebase: Specific tables to sync. Must be populated if packing_mode is set to SelectTablesForPackedMode. - Service mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service mongo_sharded: List of tables to be synced in packed mode; format:db.table(case-sensitive).
PackingMode string: Field usage depends on service value: - Service azure_cosmos_for_mongo: Indicates the desired sync pack mode. Accepted values are UsePackedModeOnly and UseUnpackedModeOnly. SelectTablesForPackedMode is deprecated. - Service firebase: Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service klaviyo: Packing mode for EVENT and PERSON tables. - Service mongo: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service mongo_sharded: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service optimizely: Packing mode for conversion and decision tables. - Service sailthru: Packing mode for LIST_STATE and USER tables.
Pages []string: Field usage depends on service value: - Service facebook_pages: Specific pages to sync. Must be populated if sync_mode is set to SpecificPages.
PartnerCode string: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission partner code.
PartnerUserId string: Field usage depends on service value: - Service expensify: Your Expensify partnerUserID.
PartnerUserSecret string: Field usage depends on service value: - Service expensify: Your Expensify partnerUserSecret.
Partners []string: Field usage depends on service value: - Service google_display_and_video_360: The list of partners to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service the_trade_desk: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service walmart_dsp: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
PassPhrase string: Field usage depends on service value: - Service qualtrics: Pass Phrase
Passphrase string: Field usage depends on service value: - Service snowflake_db: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
Password string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS password. - Service adobe_commerce: Your Adobe Commerce password. - Service akeneo: Your Akeneo password. - Service anaplan: Your Anaplan password. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Password. - Service aurora: The user's password. - Service aurora_postgres: The user's password. - Service azure_cosmos_for_mongo: Password used for source database authentication. - Service azure_postgres: The user's password. - Service azure_sql_db: The user's password. - Service azure_sql_managed_db: The user's password. - Service boostr: Your Boostr password. - Service ceridian_dayforce: Your Ceridian Dayforce Password. - Service cin7: Your Cin7 API Key. - Service clarity: The user's password. - Service cockroachdb: The user's password. - Service collibra: Your collibra password. - Service compliance_checkpoint: Your Compliance Checkpoint account password. - Service contrast_security: Your Contrast Security API Password. - Service db2i_hva: The user's password. - Service db2i_sap_hva: The user's password. - Service deposco: Your Deposco password. - Service documentdb: The user's password. - Service dynamics_365_fo: The user's password. - Service ehr: The user's password. - Service elastic_cloud: The user's password. - Service es_self_hosted: The user's password. - Service ftp: FTP password. - Service globalmeet: Your GlobalMeet Password. - Service google_cloud_mysql: The user's password. - Service google_cloud_postgresql: The user's password. - Service google_cloud_sqlserver: The user's password. - Service green_power_monitor: Your GreenPowerMonitor password. - Service guru: Your Guru password. - Service hana_sap_hva_b1: The user's password. - Service hana_sap_hva_ecc: The user's password. - Service hana_sap_hva_ecc_netweaver: The user's password. - Service hana_sap_hva_s4: The user's password. - Service hana_sap_hva_s4_netweaver: The user's password. - Service heroku_postgres: The user's password. - Service hilti_ontrack: Your Hilti On!Track password. - Service impact: Your Impact Account Token - Service integral_ad_science: Your integral_ad_science password. - Service itunes_connect: Your password - Service jamf: Your Jamf password. - Service jira: The Jira user's password. - Service khoros_care: Your Khoros Care password. - Service kissmetrics: Your Kissmetrics API Password. - Service klarna: Your Klarna Password. - Service lessonly: Your Lessonly password. - Service magento_mysql: The user's password. - Service magento_mysql_rds: The user's password. - Service maria: The user's password. - Service maria_azure: The user's password. - Service maria_rds: The user's password. - Service marin: The Marin user's password. - Service moloco: Your Moloco account password. - Service mongo: The user's password. - Service mongo_sharded: The user's password. - Service myosh: Your myosh password. - Service mysql: The user's password. - Service mysql_azure: The user's password. - Service mysql_rds: The user's password. - Service netsuite_suiteanalytics: The NetSuite user's password. - Service opendistro: The user's password. - Service opensearch: The user's password. - Service oracle: The user's password. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence user password. - Service oracle_ebs: The user's password. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud user password. - Service oracle_hva: The user's password. - Service oracle_rac: The user's password. - Service oracle_rds: The user's password. - Service oracle_sap_hva: The user's password. - Service oracle_sap_hva_netweaver: The user's password. - Service outbrain: The Outbrain user's password. - Service pardot: The Pardot user's password. - Service partnerize: Your Partnerize account's password. - Service podio: Your Podio account password. - Service postgres: The user's password. - Service postgres_rds: The user's password. - Service qmatic_data_connect: Your Qmatic Data Connect password. - Service redshift_db: The Redshift user's password. - Service revx: Your RevX Password. - Service rtb_house: Your RTB House password. - Service sap_business_by_design: The SAP Business ByDesign password. - Service sap_hana: Your SAP HANA password. - Service sap_s4hana: Your SAP S/4 password. - Service scorm: Your Scorm Secret Key. - Service servicenow: Your account password. - Service sftp: SFTP password. - Service shiphero: Your ShipHero password. - Service shipstation: Your ShipStation password. - Service shopware: Your Shopware password. - Service skuvault: Your SkuVault password. - Service smadex: Your Smadex Password. - Service snowflake_db: The Snowflake user's password. - Service splash: Your Splash password. - Service splunk: The Splunk user's password. - Service sql_server: The user's password. - Service sql_server_hva: The user's password. - Service sql_server_rds: The user's password. - Service sql_server_sap_ecc_hva: The user's password. - Service starrez: Your StarRez API password - Service stickyio: Your sticky.io password. - Service stylight: Your Stylight Password. - Service sugarcrm: Your SugarCRM password. - Service teamwork: Your Teamwork password. - Service the_trade_desk: The Trade Desk password. It is a part of the login credentials. - Service toggl_track: Your Toggl Track Password - Service ukg_pro: Your UKG Pro password. - Service unicommerce: Your uniware login password. - Service upland: Your Upland Software Password. - Service veevavault: Your Veeva Vault password. - Service walmart_dsp: Walmart DSP password. It is a part of the login credentials. - Service when_i_work: Your When I Work password. - Service wherefour: Your Wherefour password. - Service workday: Workday password. - Service workday_financial_management: Workday password. - Service workday_hcm: Workday password. - Service xandr: Your Xandr password. - Service younium: Your Younium password.
Pat string: Field usage depends on service value: - Service github: The Personal Access Token generated in Github.
PatName string: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Name.
PatSecret string: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Secret.
Path string: Field usage depends on service value: - Service jira: A URL subdirectory where the Jira instance is working.
Pats []string: Field usage depends on service value: - Service github: The Personal Access Tokens.
Pattern string: Field usage depends on service value: - Service aws_cost_report: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service azure_blob_storage: All files in your search path matching this regular expression will be synced. - Service box: All files in your search path matching this regular expression will be synced. - Service dropbox: All files in your search path matching this regular expression will be synced. - Service email: All files in your search path matching this regular expression will be synced. - Service ftp: All files in your search path matching this regular expression will be synced. - Service gcs: All files in your search path matching this regular expression will be synced. - Service google_drive: All files in your search path matching this regular expression will be synced. - Service kinesis: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service s3: All files in your search path matching this regular expression will be synced. - Service sftp: All files in your search path matching this regular expression will be synced. - Service share_point: All files in your search path matching this regular expression will be synced. - Service wasabi_cloud_storage: All files in your search path matching this regular expression will be synced.
PdbName string: Field usage depends on service value: - Service oracle: Optional: Required only for containerized database. - Service oracle_ebs: Optional: Required only for containerized database. - Service oracle_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases. - Service oracle_rac: Optional: Required only for containerized database. - Service oracle_rds: Optional: Required only for containerized database. - Service oracle_sap_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
PemCertificate string: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Must be populated if is_auth2_enabled is set to false.
PemPrivateKey string: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM secret key file. Must be populated if is_auth2_enabled is set to true.
PerInteractionDimensions []string: Field usage depends on service value: - Service double_click_campaign_manager: Per Interaction Dimensions.
PersonalAccessToken string: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail personal access token. - Service databricks_db: Access Token - Service harvest: Your Harvest Personal Access Token. - Service productive: Your Productive personal access token. - Service totango: Your Totango personal access token.
PersonalApiToken string: Field usage depends on service value: - Service circleci: Your CircleCI Personal API token. - Service monday: Your Monday.com Personal API Token.
PgpPassPhrase string: Field usage depends on service value: - Service azure_blob_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true.
PgpSecretKey string: Field usage depends on service value: - Service azure_blob_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true.
PhoneNumber string: Field usage depends on service value: - Service itunes_connect: Register the number on AppleId Account Page for 2FA
PlanType string: Field usage depends on service value: - Service justcall: Your JustCall Plan Type.
Port float64: Field usage depends on service value: - Service aurora: The port number. - Service aurora_postgres: The port number. - Service aveva_pi: Port number at which the AF Server is running - Service azure_postgres: The port number. - Service azure_sql_db: The port number. - Service azure_sql_managed_db: The port number. - Service clarity: The port number. - Service cockroachdb: The port number. - Service databricks_db: The port of your SQL warehouse. - Service db2i_hva: The port number. - Service db2i_sap_hva: The port number. - Service documentdb: Port of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: The port number. - Service ehr: The port number. - Service elastic_cloud: The port number. - Service es_self_hosted: The port number. - Service ftp: FTP port. - Service google_cloud_mysql: The port number. - Service google_cloud_postgresql: The port number. - Service google_cloud_sqlserver: The port number. - Service hana_sap_hva_b1: The port number. - Service hana_sap_hva_ecc: The port number. - Service hana_sap_hva_ecc_netweaver: The port number. - Service hana_sap_hva_s4: The port number. - Service hana_sap_hva_s4_netweaver: The port number. - Service heroku_postgres: The port number. - Service jira: The Jira service host port. - Service magento_mysql: The port number. - Service magento_mysql_rds: The port number. - Service maria: The port number. - Service maria_azure: The port number. - Service maria_rds: The port number. - Service mysql: The port number. - Service mysql_azure: The port number. - Service mysql_rds: The port number. - Service netsuite_suiteanalytics: The NetSuite service host port. - Service opendistro: The port number. - Service opensearch: The port number. - Service oracle: The port number. - Service oracle_ebs: The port number. - Service oracle_hva: The port number. - Service oracle_rac: The port number. - Service oracle_rds: The port number. - Service oracle_sap_hva: The port number. - Service postgres: The port number. - Service postgres_rds: The port number. - Service redshift_db: Port number - Service sap_hana: The SAP HANA port number. - Service sap_s4hana: The SAP S/4 port number. - Service sftp: SFTP port. - Service snowflake_db: The Snowflake optional port number. - Service splunk: The Splunk service host port. - Service sql_server: The port number. - Service sql_server_hva: The port number. - Service sql_server_rds: The port number. - Service sql_server_sap_ecc_hva: The port number.
PostClickAttributionWindowSize string: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on clicks. Default value: DAY_30
PrebuiltReport string: Field usage depends on service value: - Service facebook: The name of report of which connector will sync the data. Possible prebuilt_report values. - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data.
Prefix string: Field usage depends on service value: - Service aws_cloudtrail: If prefix is present when configuring the bucket. - Service aws_cost_report: Folder path to the aws_cost_report files within the bucket. - Service aws_inventory: The prefix if you used one when configuring the bucket. - Service azure_blob_storage: All files and folders under this folder path will be searched for files to sync. - Service box: All files and folders under this folder path will be searched for files to sync. - Service cloudfront: The name of the CloudFront folder in the bucket. - Service dropbox: All files and folders under this folder path will be searched for files to sync. - Service ftp: All files and folders under this folder path will be searched for files to sync. - Service gcs: All files and folders under this folder path will be searched for files to sync. - Service google_drive: 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 - Service kinesis: Folder path to the Kinesis files within the bucket. - Service marin: Folder path to the Marin manifest file. - Service microsoft_dynamics_365_fo: Folder name in which the exported dynamics 365 data resides. - Service s3: All files and folders under this folder path will be searched for files to sync. - Service segment: Folder path to the Segment files within the bucket. Must be populated if sync_type is set to S3. - Service sftp: All files and folders under this folder path will be searched for files to sync. - Service share_point: All files and folders under this folder path link will be searched for files to sync. This can be any shared folder link. - Service wasabi_cloud_storage: All files and folders under this folder path will be searched for files to sync.
PrimaryKey string: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission primary key.
PrimaryKeys []string: Field usage depends on service value: - Service workday: Primary Keys
PrivateKey string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS REST API private key. - Service adobe_analytics: The complete contents of your private key file including the start and end tags (----BEGIN PRIVATE KEY---- to ----END PRIVATE KEY----). - Service adp_workforce_now: Private Key. - Service anaplan: The contents of your private key file. Must be populated if auth_mode is set to Certificate. - Service apple_search_ads: The contents of your secret key file. Must be populated if is_auth2_enabled is set to false. - Service braintree: The contents of your secret key file. - Service braintree_sandbox: The contents of your secret key file. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud private key. - Service qualtrics: Your private key - Service salesforce: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service snowflake_db: Private access key. The field should be specified if authentication type is KEY_PAIR.
PrivateToken string: Field usage depends on service value: - Service eventbrite: Your Eventbrite private token.
Product string: Field usage depends on service value: - Service webconnex: Your Webconnex product.
Profiles []string: Field usage depends on service value: - Service amazon_ads: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SpecificProfiles. - Service google_analytics: Specific User Profile IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_mcf: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
ProfilesAmazonDsp string: Field usage depends on service value: - Service amazon_dsp: Comma-separated list of your Amazon DSP profiles.
ProjectAccessToken string: Field usage depends on service value: - Service rollbar: Your Rollbar project access token.
ProjectCredentials []GetConnectorConfigProjectCredential: Field usage depends on service value: - Service amplitude: * Project(s)
ProjectId string: Field usage depends on service value: - Service bigquery_db: BigQuery project ID - Service google_analytics_360: The project ID. - Service google_analytics_4_export: The Project ID. - Service mixpanel: Project ID
ProjectIds string: Field usage depends on service value: - Service sentry: Your Sentry project IDs.
ProjectKey string: Field usage depends on service value: - Service commercetools: Your commercetools project key.
Projects []string: Field usage depends on service value: - Service asana: Specific Project IDs to sync. Must be populated if syncMode is set to SpecificProjects. - Service jira: Specific projects to sync. Must be populated if syncMode is set to CUSTOM.
Properties []string: Field usage depends on service value: - Service google_analytics_4: The array of strings in the properties/{id} format where id is a Google Analytics 4 property identifier. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
PropertyId string: Field usage depends on service value: - Service cloudbeds: Your Cloudbeds property IDs.
PublicKey string: Field usage depends on service value: - Service aurora: Public Key - Service aurora_postgres: Public Key - Service azure_blob_storage: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_cosmos_for_mongo: Public Key - Service azure_postgres: Public Key - Service azure_service_bus: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_sql_db: Public Key. - Service azure_sql_managed_db: Public Key. - Service braintree: The contents of your PEM certificate file. - Service braintree_sandbox: The contents of your PEM certificate file. - Service clarity: Public Key. - Service cockroachdb: Public Key - Service db2i_hva: Public Key - Service db2i_sap_hva: Public Key - Service documentdb: Public Key - Service dynamics_365_fo: Public Key. - Service ehr: Public Key. - Service elastic_cloud: Public Key - Service es_self_hosted: Public Key - Service google_cloud_mysql: Public Key - Service google_cloud_postgresql: Public Key - Service google_cloud_sqlserver: Public Key. - Service hana_sap_hva_b1: Public Key - Service hana_sap_hva_ecc: Public Key - Service hana_sap_hva_ecc_netweaver: Public Key - Service hana_sap_hva_s4: Public Key - Service hana_sap_hva_s4_netweaver: Public Key - Service heroku_postgres: Public Key - Service magento_mysql: Public Key - Service magento_mysql_rds: Public Key - Service maria: Public Key - Service maria_azure: Public Key - Service maria_rds: Public Key - Service mongo: Public Key - Service mongo_sharded: Public Key - Service mysql: Public Key - Service mysql_azure: Public Key - Service mysql_rds: Public Key - Service opendistro: Public Key - Service opensearch: Public Key - Service oracle: Public Key - Service oracle_ebs: Public Key - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud public key. - Service oracle_hva: Public Key - Service oracle_rac: Public Key - Service oracle_rds: Public Key - Service oracle_sap_hva: Public Key - Service partnerstack_vendor: Your PartnerStack Vendor Public key. - Service postgres: Public Key - Service postgres_rds: Public Key - Service sap_hana: Public Key - Service sap_s4hana: Public Key - Service sftp: Public Key - Service sql_server: Public Key. - Service sql_server_hva: Public Key. - Service sql_server_rds: Public Key. - Service sql_server_sap_ecc_hva: Public Key.
PublicationName string: Field usage depends on service value: - Service aurora_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service azure_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service google_cloud_postgresql: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service heroku_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres_rds: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT".
PublisherId string: Field usage depends on service value: - Service skimlinks: Your Skimlinks publisher ID.
PullArchivedCampaigns bool: Field usage depends on service value: - Service outbrain: Include or ignore results from archived campaigns
PythonVersion string
QueryId string: Field usage depends on service value: - Service google_display_and_video_360: The ID of the query whose configuration you want to reuse. This is a required parameter when config_method is set to REUSE_EXISTING.
QueryParamValue string: Field usage depends on service value: - Service alchemer: Your Alchemer API key. - Service birdeye: Your Birdeye query-param-value.
QuotaProjectId string: Field usage depends on service value: - Service bigquery_db: Specify a different project ID to account for quota and billing of Fivetran query workload
QuoteChar string: Field usage depends on service value: - Service azure_blob_storage: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service gcs: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service google_drive: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service s3: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service sftp: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service share_point: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
QuoteCharacterEnabled bool: Field usage depends on service value: - Service azure_blob_storage: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service gcs: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service google_drive: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service s3: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service sftp: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service share_point: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
RateLimitPlan string: Field usage depends on service value: - Service vimeo: Your Vimeo rate limit plan.
RefreshToken string: Field usage depends on service value: - Service ironsource: Your Ironsource Client Secret.
RefreshTokenExpiresAt string: Field usage depends on service value: - Service pinterest_ads: The expiration date of the refresh token. Unix timestamp in seconds
Region string: Field usage depends on service value: - Service algolia: Your Algolia analytics region. - Service amazon_ads: The region used by the Amazon Ads profile. - Service amazon_selling_partner: The region used by the Amazon Selling Partner profile. - Service anaplan: Your Anaplan account region - Service atlassian_ops_genie: Your company's Osgenie region (usually company.opsgenie.com) - Service awin: Your Awin Region. - Service aws_lambda: The AWS region code for the DynamoDB instance. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Region - Service concur: The region. - Service cvent: Your Cvent region. - Service everflow: Your Everflow region. - Service exact_online: Your Exact Online region. - Service getfeedback: Your GetFeedback region. - Service happyfox: Your HappyFox region. - Service keypay: Your KeyPay region. - Service medallia_agile_research: Your Medallia Agile region. - Service messagebird: Your MessageBird Account region. - Service mixpanel: Data Region - Service navan: Your Navan region. - Service on24: Your ON24 region. - Service pendo: The Pendo account region. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Region. - Service ringover: Your Ringover region. - Service samsara: The region of your Samsara account. For instance, if your region is EUROPE, provide eu.samsara in the Region field. If your region is not in Europe, provide samsara. - Service snyk: Your Snyk region. - Service talkdesk: Your Talkdesk region (".com",".eu","ca.com") - Service totango: Your Totango region. - Service transcend: Your Transcend region. - Service vonage_contact_center: Your Vonage Contact Center region. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: US_EAST_1. - Service workday_strategic_sourcing: Your Workday Strategic Sourcing Region. - Service zoho_books: Your Zoho Books application host region. - Service zoho_campaigns: Your Zoho Campaigns application host region. - Service zoho_desk: Your Zoho Desk domain. - Service zoho_inventory: Your Zoho Inventory application host region.
RegionApiUrl string: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution API URL region.
RegionAuthUrl string: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution auth URL region.
RegionTokenUrl string: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution token URL region.
RegionUrl string: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management region URL.
ReplicaId float64: Field usage depends on service value: - Service aurora: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service google_cloud_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
ReplicationSlot string: Field usage depends on service value: - Service aurora_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service azure_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service google_cloud_postgresql: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service heroku_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres_rds: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT".
ReportConfigs []GetConnectorConfigReportConfig: Field usage depends on service value: - Service yahoo_dsp: Specify the reports you want to sync. This is optional.
ReportConfigurationIds []string: Field usage depends on service value: - Service double_click_campaign_manager: You can select only one Floodlight Configuration ID per account.
ReportFormatType string: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
ReportGranularity string: Field usage depends on service value: - Service pinterest_ads: Granularity at which reports will be
ReportKeys string: Field usage depends on service value: - Service rakutenadvertising: Your Rakuten Advertising report keys.
ReportLists []GetConnectorConfigReportList: Field usage depends on service value: - Service spotify_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
ReportServiceApiKey string: Field usage depends on service value: - Service adyen: Your Report Service API key.
ReportSuites []string
ReportTimezone string: Field usage depends on service value: - Service criteo: Report Timezone
ReportType string: Field usage depends on service value: - Service adroll: The report type you want. Default value: ALL_ADS. - Service double_click_campaign_manager: Type of reporting data to sync. Default value: STANDARD. - Service google_display_and_video_360: The type of the report to create. This is a required parameter when config_method is set to CREATE_NEW. - Service youtube_analytics: The name of report of which connector will sync the data.
ReportUrl string: Field usage depends on service value: - Service workday: URL for a live custom report.
Reports []GetConnectorConfigReport: Field usage depends on service value: - Service google_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics_4: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_search_ads_360: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service google_search_console: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service workday: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
ReportsLinkedinAds []string: Field usage depends on service value: - Service linkedin_ads: Specific analytics reports to sync. Must be populated if adAnalytics is set to 'SpecificReports'.
Repositories []string: Field usage depends on service value: - Service github: Specific Repository IDs to sync. Must be populated if syncMode is set to SpecificRepositories.
ResourceToken string: Field usage depends on service value: - Service cosmos: A token that provides access to a specific Azure Cosmos DB resource. Required for the RESOURCE_TOKEN data access method.
ResourceUrl string: Field usage depends on service value: - Service dynamics_365: URL at which Dynamics 365 is accessed
RestApiLimit float64: Field usage depends on service value: - Service pardot: The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
RfcLibraryPath string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service hana_sap_hva_s4_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service oracle_sap_hva_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files.
Role string: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Role ID for connection. - Service snowflake_db: Snowflake Connector role name
RoleArn string: Field usage depends on service value: - Service appsflyer: S3 Role ARN - Service aws_cloudtrail: The Role ARN required for authentication. - Service aws_cost: The Role ARN required for authentication. - Service aws_cost_report: The Role ARN required for authentication. - Service aws_inventory: The Role ARN required for authentication. - Service aws_lambda: The Role ARN required for authentication. - Service aws_msk: If sasl_mechanism is set to IAM, enter your Role ARN - Service cloudfront: The Role ARN required for authentication. - Service dynamodb: Role ARN - Service heap: The Role ARN required for authentication. - Service kinesis: The Role ARN required for authentication. - Service s3: The Role ARN required for authentication. Required for connector creation when syncing using private bucket. - Service segment: The Role ARN required for authentication. Must be populated if sync_type is set to S3.
RollbackWindow float64: Field usage depends on service value: - Service appsflyer: Rollback window
RollbackWindowSize float64: Field usage depends on service value: - Service bingads: A period of time in days during which a conversion is recorded.
S3Bucket string: Field usage depends on service value: - Service webhooks: The S3 bucket name. Required if bucket_service is set to S3.
S3ExportBucket string: Field usage depends on service value: - Service braze: Your S3 user export bucket. Required if AWS_S3 is the export_storage_type
S3ExportExternalId string: Field usage depends on service value: - Service braze: This is the same as your group_id, used if export_storage_type is AWS_S3
S3ExportFolder string: Field usage depends on service value: - Service braze: Your S3 user export folder name. Required if AWS_S3 is the export_storage_type
S3ExportRoleArn string: Field usage depends on service value: - Service braze: The Role ARN required for authentication required if AWS_S3 is the export_storage_type
S3RoleArn string: Field usage depends on service value: - Service adjust: Used if the export_storage_type is AWS_S3, the Role ARN required for authentication. - Service webhooks: The Role ARN required for authentication. Required if bucket_service is set to S3.
S3bucket string: Field usage depends on service value: - Service adobe_analytics_data_feed: The S3 bucket name. - Service braze: Your S3 bucket required if AWS_S3 is the cloud_storage_type - Service sailthru: Name of the bucket configured to receive sailthru connect data.
S3externalId string: Field usage depends on service value: - Service braze: 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 - Service sailthru: The external ID is a string that designates who can assume the role.
S3folder string: Field usage depends on service value: - Service braze: Your S3 folder name required if AWS_S3 is the cloud_storage_type
S3path string: Field usage depends on service value: - Service sailthru: Copy and use this to configure Sailthru Connect in your sailthru account.
S3roleArn string: Field usage depends on service value: - Service adobe_analytics_data_feed: The Role ARN required for authentication. - Service braze: The Role ARN required for authentication required if AWS_S3 is the cloud_storage_type - Service sailthru: Role ARN of the IAM role created for Fivetran.
SalesAccountSyncMode string: Field usage depends on service value: - Service itunes_connect: Whether to sync all sales accounts or specific sales accounts.
SalesAccounts []string: Field usage depends on service value: - Service itunes_connect: Specific sales account to sync. Must be populated if sales_account_sync_mode is set to SpecificSalesAccounts.
SalesforceSecurityToken string: Field usage depends on service value: - Service pardot: The Pardot user's Salesforce SSO Account Security Token.
SandboxAccount string: Field usage depends on service value: - Service gocardless: Your GoCardless account type.
SapSchema string: Field usage depends on service value: - Service db2i_hva: The SAP schema. - Service db2i_sap_hva: SAP schema name. - Service sql_server_hva: SAP Schema Name. Required only for High-Volume Agent SAP ECC connector. - Service sql_server_sap_ecc_hva: SAP Schema Name.
SapSourceSchema string: Field usage depends on service value: - Service hana_sap_hva_b1: The schema name where the HANA tables reside. - Service hana_sap_hva_ecc: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_ecc_netweaver: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4_netweaver: The Hana schema name where the SAP tables reside.
SapUser string: Field usage depends on service value: - Service oracle_sap_hva: The Oracle schema name where the SAP tables reside.
SaslMechanism string: Field usage depends on service value: - Service apache_kafka: SASL Mechanism - Service aws_msk: If security_protocol is set to SASL, enter the SASL Mechanism
SaslPlainKey string: Field usage depends on service value: - Service apache_kafka: API Key
SaslPlainSecret string: Field usage depends on service value: - Service apache_kafka: API Secret
SaslScram256Key string: Field usage depends on service value: - Service apache_kafka: API Key
SaslScram256Secret string: Field usage depends on service value: - Service apache_kafka: API Secret
SaslScram512Key string: Field usage depends on service value: - Service apache_kafka: API Key - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
SaslScram512Secret string: Field usage depends on service value: - Service apache_kafka: API Secret - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
SchemaRegistryCredentialsSource string: Field usage depends on service value: - Service apache_kafka: Schema Registry Credentials source - Service aws_msk: Schema Registry Credentials source - Service confluent_cloud: Schema Registry Credentials source
SchemaRegistryKey string: Field usage depends on service value: - Service apache_kafka: Schema Registry Key - Service aws_msk: Schema Registry Key - Service azure_service_bus: The key used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Key
SchemaRegistrySecret string: Field usage depends on service value: - Service apache_kafka: Schema Registry Secret - Service aws_msk: Schema Registry Secret - Service azure_service_bus: The secret used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Secret
SchemaRegistryUrls []string: Field usage depends on service value: - Service apache_kafka: Your schema registry URLs - Service aws_msk: Your schema registry URLs - Service azure_service_bus: The comma-separated list of schema registry servers in the server:port format - Service confluent_cloud: Your schema registry URLs
Scope string: Field usage depends on service value: - Service ebay: Your eBay scopes.
Scopes string: Field usage depends on service value: - Service cornerstone: Your Cornerstone scopes.
Seats []string: Field usage depends on service value: - Service yahoo_dsp: Specific Seats to sync. Must be populated if sync_mode_seat is set to SPECIFIC_SEATS.
Secret string: Field usage depends on service value: - Service appcues: Your Appcues Secret. - Service buildium: Your Buildium API secret. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure secret. - Service loopio: Your Loopio Secret. - Service mode: Your Mode Secret. - Service playvox_workforce_management: Your Playvox Workforce Management client secret. - Service twilio: The Twilio API secret - Service uservoice: The UserVoice API secret. - Service venminder: Your Venminder secret. - Service vts: Your VTS secret.
SecretKey string: Field usage depends on service value: - Service afterpay: Your Afterpay Secret Key. - Service appsflyer: Your AWS secret key. - Service bigquery_db: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service checkr: Your Checkr secret key. - Service ezofficeinventory: Your EZOfficeInventory API secret key. - Service gcs: Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket. - Service ironsource: Your Ironsource Client ID. - Service line_ads: Your LINE Ads secret key. - Service mailjet: Your Mailjet secret key. - Service partnerstack_vendor: Your PartnerStack Vendor Secret key. - Service paypal: Client Secret of your PayPal client application. - Service paypal_sandbox: Client Secret of your PayPal client application. - Service phoenix_ads: Your Phoenix Ads Secret key. - Service retailnext: Your RetailNext secret key. - Service statsig: Your Statsig secret key. - Service yotpo: Your Yotpo Secret key
Secrets string: Field usage depends on service value: - Service aws_lambda: The secrets that should be passed to the function at runtime. - Service azure_function: The secrets that should be passed to the function at runtime. - Service google_cloud_function: The secrets that should be passed to the function at runtime.
SecretsLists []GetConnectorConfigSecretsList: Field usage depends on service value: - Service aws_lambda: List of Secrets that should be passed to the function at runtime. - Service azure_function: The list of secrets that should be passed to the function at runtime. - Service google_cloud_function: The list of secrets that should be passed to the function at runtime.
SecurityProtocol string: Field usage depends on service value: - Service apache_kafka: Security protocol for Kafka interaction. - Service aws_msk: The security protocol for Kafka interaction. - Service confluent_cloud: Security protocol for Confluent Cloud interaction. - Service heroku_kafka: Security protocol for Heroku Kafka interaction.
Segments []string: Field usage depends on service value: - Service google_analytics: 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.
SelectedEventTypes []string: Field usage depends on service value: - Service salesforce_marketing_cloud: Select the event types to be synced.
SelectedExports []string: Field usage depends on service value: - Service anaplan: 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.
SenderId string: Field usage depends on service value: - Service sage_intacct: Your Sender ID
SenderPassword string: Field usage depends on service value: - Service sage_intacct: Your Sender Password
Server string: Field usage depends on service value: - Service castor_edc: Your Castor EDC Server.
ServerAddress string: Field usage depends on service value: - Service tableau_source: Your Tableau Source server address.
ServerRegion string: Field usage depends on service value: - Service clockify: Your Clockify server region.
ServerUrl string: Field usage depends on service value: - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence Instance URL. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud Instance URL.
ServerVariable string: Field usage depends on service value: - Service myosh: Your myosh server variable.
Servers []string: Field usage depends on service value: - Service apache_kafka: Comma-separated list of Kafka servers in the format server:port. - Service aws_msk: Comma-separated list of Kafka servers in the server:port format. - Service confluent_cloud: Comma-separated list of Confluent Cloud servers in the format server:port. - Service heroku_kafka: Comma-separated list of Heroku Kafka servers in the format server:port.
ServiceAccount string: Field usage depends on service value: - Service google_drive: Share the folder with the email address
ServiceAccountEmail string: Field usage depends on service value: - Service google_cloud_function: Provide Invoker role to this service account.
ServiceAccountKey string: Field usage depends on service value: - Service firebase: The contents of your service account key file. Required for authentication.
ServiceAccountSecret string: Field usage depends on service value: - Service mixpanel: Service Account Secret
ServiceAccountUsername string: Field usage depends on service value: - Service mixpanel: Service Account Username
ServiceAuthentication string: Field usage depends on service value: - Service dsv: A base64 encoded variant of your username:password string. Required for authentication.
ServiceName string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service walmart_marketplace: Your Walmart Marketplace service name.
ServiceVersion string
SftpHost string: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP host. - Service salesforce_marketing_cloud: Host
SftpIsKeyPair bool: Field usage depends on service value: - Service adobe_analytics_data_feed: Log in with key pair or password - Service salesforce_marketing_cloud: Set this field if you use a key pair for logging into your SFTP server. Don't set it if you use a username and password
SftpPassword string: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP password required if sftp_is_key_pair is false - Service salesforce_marketing_cloud: Password
SftpPort float64: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP port. - Service salesforce_marketing_cloud: Port
SftpPublicKey string: Field usage depends on service value: - Service adobe_analytics_data_feed: Public Key - Service salesforce_marketing_cloud: Public Key
SftpUser string: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP user. - Service salesforce_marketing_cloud: User
ShareUrl string: Field usage depends on service value: - Service share_point: Your SharePoint folder URL. You can find the folder URL by following the steps mentioned here.
SheetId string: Field usage depends on service value: - Service google_sheets: 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.
Shop string: Field usage depends on service value: - Service shopify: The Shopify shop name. Can be found in the URL before .myshopify.com.
ShopDomain string: Field usage depends on service value: - Service triple_whale: Your Triple Whale shop domain.
ShortCode string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce eight-character string assigned to a realm for routing purposes.
ShouldSyncEventsWithDeletedProfiles bool: Field usage depends on service value: - Service klaviyo: Sync events linked to deleted profiles
ShowRecordsWithNoMetrics bool: Field usage depends on service value: - Service apple_search_ads: Turn the toggle on if you want the reports to also return records without metrics.
Sid string: Field usage depends on service value: - Service twilio: The Twilio API key SID
SignerPublicKey string: Field usage depends on service value: - Service azure_blob_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service ftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service gcs: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service s3: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service sftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service wasabi_cloud_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed.
SiteAddress string: Field usage depends on service value: - Service teamwork: Your Teamwork site address.
SiteId string: Field usage depends on service value: - Service microsoft_lists: The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the id field in the Graph API response for sites. - Service salesforce_commerce_cloud: The name of the site from which you want to sync data.
SiteName string: Field usage depends on service value: - Service microsoft_lists: The Name of the SharePoint site. The Site Name is the name field in the Graph API response for sites. - Service tableau_source: Your Tableau Source site name.
SiteUrls []string: Field usage depends on service value: - Service google_search_console: Specific Site URLs to sync. Must be populated if sync_mode is set to SpecificSites.
SkipAfter float64: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service box: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service dropbox: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service email: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service ftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service gcs: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service google_drive: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination. - Service sftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service share_point: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service wasabi_cloud_storage: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
SkipBefore float64: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified before syncing data. - Service box: We will skip over the number of lines specified before syncing data. - Service dropbox: We will skip over the number of lines specified before syncing data. - Service email: We will skip over the number of lines specified before syncing data. - Service ftp: We will skip over the number of lines specified before syncing data. - Service gcs: We will skip over the number of lines specified before syncing data. - Service google_drive: We will skip over the number of lines specified before syncing data. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified before syncing data. - Service sftp: We will skip over the number of lines specified before syncing data. - Service share_point: We will skip over the number of lines specified before syncing data. - Service wasabi_cloud_storage: We will skip over the number of lines specified before syncing data.
SkipEmptyReports bool: Field usage depends on service value: - Service google_ads: Toggles the "Skip empty reports" feature. Enabled by default
SncCertificate string
SncCertificateSource string
SncFivetranName string
SncLibraryPath string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Path to the external security product's library. - Service hana_sap_hva_s4_netweaver: Path to the external security product's library.
SncMode string
SncMyName string
SncName string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Client SNC name. - Service hana_sap_hva_s4_netweaver: Client SNC name.
SncPartnerName string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Communication partner's SNC name. - Service hana_sap_hva_s4_netweaver: Communication partner's SNC name.
SncSourceName string
SoapUri string: Field usage depends on service value: - Service marketo: Marketo SOAP API Endpoint.
SocialDataSyncTimeframe string: Field usage depends on service value: - Service linkedin_company_pages: The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: SIX .
Source string: Field usage depends on service value: - Service adobe_analytics_data_feed: The data source.
StoreHash string: Field usage depends on service value: - Service big_commerce: The BigCommerce store hash.
StoreId string: Field usage depends on service value: - Service reviewsio: Your REVIEWS.io store ID
SubDomain string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS subdomain. - Service activecampaign: Your ActiveCampaign sub-domain. - Service acumatica: Your Acumatica subdomain. - Service ada: Your Ada sub-domain. - Service alchemer: Your Alchemer sub-domain. - Service atlassian_jira_align: Your Jira Align base URL. - Service azure_boards: Your Azure Boards Organization Name. - Service azure_devops: Your Azure Organization Name - Service betterworks: Your Betterworks subdomain. - Service bubble: Your Bubble subdomain. - Service buildium: Your Buildium subdomain. - Service canvas_by_instructure: Your Canvas by Instructure domain. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 subdomain. - Service chargebee_product_catalog_2: Your Chargebee subdomain. - Service checkr: Your Checkr subdomain. - Service clubspeed: Your Clubspeed subdomain. - Service collibra: Your collibra subdomain. - Service compliance_checkpoint: Your Compliance Checkpoint subdomain. - Service concord: Your Concord Sub Domain. - Service contrast_security: Your Contrast Security subdomain. - Service customerio: Your Customer.io region-specific Subdomain. - Service dbt_cloud: Your dbt Cloud API server region. - Service deputy: Your Deputy subdomain. - Service docebo: Your Docebo subdomain. - Service drata: Your Drata sub_domain. - Service eventsforce: Your Eventsforce subdomain. - Service ezofficeinventory: Your EZOfficeInventory Subdomain. - Service fountain: Your Fountain subdomain. - Service freshchat: Your Freshchat Sub Domain - Service gainsight_customer_success: The subdomain of your Gainsight account. - Service gainsight_product_experience: Your Gainsight Product Experience subdomain. - Service genesys: Your Genesys subdomain. - Service green_power_monitor: Your GreenPowerMonitor subdomain. - Service infobip: Your Infobip sub_domain. - Service insightly: Your company's Insightly subdomain name. - Service instructure: The Sub domain in which your Instructure account is hosted. - Service jamf: Your Jamf subdomain. - Service kandji: Your Kandji Subdomain. - Service khoros_care: Your Khoros Care subDomain. - Service looker_source: Your looker SubDomain name. - Service lucca: Your Lucca subdomain. - Service mailgun: Your Mailgun subdomain. - Service matomo: Your Matomo subdomain. - Service maxio_chargify: Enter Your Subdomain. - Service myosh: Your myosh subdomain. - Service namely: Your Namely subdomain. - Service nylas: Your Nylas subdomain. - Service okta: Your Okta subdomain. - Service picqer: Your Picqer subdomain. - Service pinpoint: Your Pinpoint sub domain name. - Service piwik_pro: Your Piwik PRO subdomain. - Service playvox: Your Playvox Subdomain. - Service posthog: Your PostHog data region (app or eu). - Service recurly: Your company's Recurly subdomain. - Service reltio: Your Reltio subdomain. - Service revel: Your Revel Systems subDomain. - Service rundeck: Your Rundeck subdomain. - Service sage_hr: Your Sage HR subdomain. - Service salesforce_marketing_cloud: Your Salesforce Marketing Cloud subdomain. - Service salsify: Your Salsify Organization ID. - Service sap_success_factors: Your SAP SuccessFactors Subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service starrez: Your StarRez subdomain - Service sugarcrm: Your SugarCRM subdomain. - Service tableau_source: Your Tableau Source subdomain. - Service tempo: Your Tempo subdomain. - Service testrail: Your TestRail subdomain. - Service thinkific: Your Thinkific subdomain. - Service totango: Your Totango Subdomain. - Service tymeshift: Your Tymeshift subdomain. - Service upland: Your Upland Software subDomain. - Service wordpress: Your WordPress subdomain. - Service workable: Your Workable Subdomain. - Service wrike: Your Wrike Subdomain.
Subdomain string: Field usage depends on service value: - Service bamboohr: The subdomain used to access your account. If you access BambooHR at 'https://mycompany.bamboohr.com', then the subdomain is 'mycompany'. - Service datadog: Your Datadog subdomain. - Service ebay: Your eBay environment. - Service freshdesk: Your company's freshdesk subdomain (usually company.freshdesk.com). - Service freshsales: Your Freshsales domain. - Service freshservice: Your company's freshservice subdomain (usually company.freshservice.com). - Service freshsuccess: Your Freshsuccess subdomain. - Service gorgias: Your Gorgias subdomain. - Service jama_software: Your Jama Software subdomain. - Service klarna: Your Klarna subdomain. - Service learnupon: Your Learnupon subdomain. - Service maxio_saasoptics: Your Maxio SaaSOptics subdomain. - Service medallia: Medallia subdomain - Service packiyo: Your Packiyo subdomain. - Service qmatic_data_connect: Your Qmatic Data Connect subdomain. - Service sana: Your Sana subdomain. - Service skillstx: Your SkillsTX subdomain. - Service smarthr: Your SmartHR subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service toast: Your Toast domain. - Service vts: Your VTS Subdomain. - Service zendesk_chat: Your Zendesk domain.
SubscriberName string: Field usage depends on service value: - Service azure_service_bus: 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
Subscription string: Field usage depends on service value: - Service retailnext: Your RetailNext subscription.
SubscriptionKey string: Field usage depends on service value: - Service dsv: Your DSV subscription key.
SupportConnectedAccountsSync bool: Field usage depends on service value: - Service stripe: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts. - Service stripe_test: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.
SupportNestedColumns bool: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
SurveyIds string: Field usage depends on service value: - Service qualaroo: Array of Qualaroo Survey IDs.
SwipeAttributionWindow string: Field usage depends on service value: - Service snapchat_ads: The time period to attribute conversions based on swipes. Default value: DAY_28
SyncDataLocker bool: Field usage depends on service value: - Service appsflyer: Sync AppsFlyer Data Locker. Default value is true, set it to false to sync AppsFlyer data using only webhooks.
SyncFormat string: Field usage depends on service value: - Service webhooks: The webhooks sync format. Default value: Unpacked. Unpacked messages must be valid JSON.
SyncFormulaFields bool: Field usage depends on service value: - Service financial_force: Enable this option to sync formula fields directly (default value = false) - Service salesforce: Enable this option to sync formula fields directly (default value = false) - Service salesforce_sandbox: Enable this option to sync formula fields directly (default value = false)
SyncMetadata bool: Field usage depends on service value: - Service facebook_ads: Parameter defining whether to enable or disable metadata synchronisation. Default value: TRUE.
SyncMethod string: Field usage depends on service value: - Service aws_lambda: Sync Method
SyncMode string: Field usage depends on service value: - Service adroll: Whether to sync all advertisables or specific advertisables. Default value: AllAdvertisables. - Service amazon_ads: Option to select connector should sync all profiles or specific profiles. - Service anaplan: Whether to sync all exports or specific exports. - Service apple_search_ads: Sync Mode - Service asana: Whether to sync all projects or specific projects. - Service bingads: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service double_click_campaign_manager: Whether to sync all user profiles or specific ones. Default value: AllAccounts. - Service dynamodb: Which packed mode setting to use. Default value: UsePackedModeOnly. - Service facebook: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_ad_account: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service facebook_ads: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_pages: Whether to sync all accounts or specific accounts. Default value: AllPages. - Service github: Whether to sync all repositories or specific repositories. - Service google_ads: Whether to sync all accounts or specific accounts. - Service google_analytics: Whether to sync all accounts or specific accounts. - Service google_analytics_4: Whether to sync all accounts or specific accounts. - Service google_analytics_mcf: Whether to sync all accounts or specific accounts. Default value: ALL_ACCOUNTS - Service google_search_console: Whether to sync all sites or specific sites. - Service instagram_business: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service iterable: Events Sync Mode. - Service jira: Whether to sync all projects or specific projects. - Service linkedin_ads: Whether to sync all accounts or specific accounts. Default value: AllAccounts - Service pendo: Whether to sync all App IDs or specific App IDs. Default value: AllAppIds. - Service pinterest_ads: Whether to sync all advertisers or specific advertisers. - Service reddit_ads: Whether to sync all accounts or specific accounts. - Service salesforce_marketing_cloud: Select the sync mode. - Service snapchat_ads: Whether to sync all organizations or specific organizations. Default value: AllOrganizations. - Service spotify_ads: Whether to sync all ad accounts or specific ad accounts. - Service taboola: Whether to sync all accounts or specific accounts. - Service the_trade_desk: Whether to sync all accounts or specific accounts. - Service tiktok_ads: Whether to sync all advertiser accounts or specific accounts. - Service twilio: Whether to sync all accounts or specific accounts. - Service twitter: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service twitter_ads: Whether to sync all accounts or specific accounts. - Service walmart_dsp: Whether to sync all accounts or specific accounts. - Service yahoo_gemini: Whether to sync all accounts or specific accounts. Default value: SpecificAccounts. - Service zuora: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both. - Service zuora_sandbox: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both.
SyncModeAdvertiser string: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all advertisers or specific advertisers. Default value: ALL_ADVERTISERS.
SyncModeSeat string: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all seats or specific seats. Default value: ALL_SEATS.
SyncMultipleAccounts bool: Field usage depends on service value: - Service reddit_ads: 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
SyncPackMode string: Field usage depends on service value: - Service cosmos: 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 Azure Cosmos DB Sync Pack Mode Options documentation. - Service documentdb: Indicates whether synced data will be packed into a single entry(column), or unpacked with one layer of nested fields.
SyncPullApi bool: Field usage depends on service value: - Service appsflyer: These options are for Appsflyer's Pull API, and are only necessary for syncing events from Pull API.
SyncType string: Field usage depends on service value: - Service apache_kafka: Kafka sync type. Unpacked messages must be valid JSON. - Service aws_msk: The sync type. Unpacked messages must be valid JSON. - Service azure_event_hub: Sync type. Unpacked messages must be valid JSON. - Service azure_service_bus: 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 - Service confluent_cloud: Kafka sync type. Unpacked messages must be valid JSON. - Service heroku_kafka: Heroku Kafka sync type. Unpacked messages must be valid JSON. - Service segment: The Segment connector sync type.
Sysnr string
SystemId string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
TableId string: Field usage depends on service value: - Service pigment: Your Pigment table ID.
TableName string: Field usage depends on service value: - Service airtable: Name of table in Airtable
TablesWithoutAccessUpdatedAt string: Field usage depends on service value: - Service hubspot: Timestamp to indicate when tables without access was updated
TargetEntityId string: Field usage depends on service value: - Service culture_amp: Your Culture Amp Target entity ID.
TargetHost string: Field usage depends on service value: - Service d2l_brightspace: Your D2L Brightspace target host.
TdeCertificate string: Field usage depends on service value: - Service sql_server_hva: Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Certificate used to protect a database encryption key
TdeCertificateName string: Field usage depends on service value: - Service sql_server_hva: Name of the Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Name of the Certificate used to protect a database encryption key
TdePassword string: Field usage depends on service value: - Service sql_server_hva: Password of the TDE private key - Service sql_server_sap_ecc_hva: Password of the TDE private key
TdePrivateKey string: Field usage depends on service value: - Service sql_server_hva: Private key associated with the TDE certificate - Service sql_server_sap_ecc_hva: Private key associated with the TDE certificate
TeamId string: Field usage depends on service value: - Service asana: Team ID
TechnicalAccountId string: Field usage depends on service value: - Service adobe_analytics: Technical Account ID from the Service Account (JWT) credentials of your Adobe Project.
TemplateLabels []string: Field usage depends on service value: - Service mandrill: Provide the labels to filter the templates
Tenant string: Field usage depends on service value: - Service microsoft_entra_id: Your Microsoft Entra ID Tenant. - Service microsoft_power_bi: Your Microsoft Power BI tenant. - Service microsoft_teams: Your Microsoft Teams Tenant. - Service unicommerce: Your uniware tenant. - Service workday: Workday tenant name - Service workday_financial_management: Workday tenant name - Service workday_hcm: Workday tenant name
TenantAppUrl string: Field usage depends on service value: - Service planful: Your Planful tenant app URL.
TenantCode string: Field usage depends on service value: - Service deposco: Your Deposco tenant code.
TenantConfigs []GetConnectorConfigTenantConfig: Field usage depends on service value: - Service reltio: * tenant(s)
TenantId string: Field usage depends on service value: - Service azure_sql_db: Azure AD tenant ID. - Service azure_sql_managed_db: Azure AD tenant ID. - Service business_central: Tenant ID of your Business Central application - Service crowddev: Your crowd.dev Tenant ID. - Service reltio: Your Reltio tenant ID. - Service servicetitan: Your ServiceTitan tenant ID. - Service visma: Your Visma tenant ID.
TenantName string: Field usage depends on service value: - Service mambu: Your Mambu tenant name.
TenantUrl string: Field usage depends on service value: - Service ivanti: Your Ivanti Tenant URL. - Service playvox_workforce_management: Your Playvox Workforce Management tenant URL. - Service reltio: Your Reltio tenant URL.
TestTableName string: Field usage depends on service value: - Service sap_hana: testTableName - Service sap_s4hana: testTableName
TimeZone string: Field usage depends on service value: - Service pardot: The time zone configured in your Pardot instance. An empty value defaults to UTC+00:00.
TimeframeMonths string: Field usage depends on service value: - Service adobe_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector has been created. Default value: TWELVE . - Service adroll: 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. - Service apple_search_ads: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service bingads: 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. - Service criteo: 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. NOTE: The greater number of months means the initial sync will take more time. - Service double_click_campaign_manager: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service double_click_publishers: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service facebook: 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. - Service facebook_ads: 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. - Service google_ads: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: TWELVE. - Service google_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_4: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_mcf: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service google_display_and_video_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service google_search_ads_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service google_search_console: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service instagram_business: 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. - Service itunes_connect: Historical sync time frame in months. - Service linkedin_ads: 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. - Service outbrain: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service pinterest_ads: 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. - Service reddit_ads: 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. - Service snapchat_ads: 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. - Service spotify_ads: 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: SIX. - Service taboola: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service the_trade_desk: 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. - Service tiktok_ads: 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. - Service twitter: 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. - Service twitter_ads: Historical sync timeframe in months. - Service walmart_dsp: 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. - Service yahoo_dsp: Number of monthsworth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value:THREE. - Service yahoo_gemini: 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`.
Timezone string: Field usage depends on service value: - Service rokt: Your Rokt timezone.
TimezoneMode string: Field usage depends on service value: - Service apple_search_ads: Determines whether to use UTC or the users timezone from the apple account
Tns string: Field usage depends on service value: - Service oracle_hva: Single-tenant database: The database's SID. Multi-tenant database: The database's TNS. - Service oracle_sap_hva: Single-tenant database: The database SID. Multi-tenant database: The database TNS.
ToastId string: Field usage depends on service value: - Service toast: Your Toast Restaurant External ID.
Token string: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities token. - Service matomo: Your Matomo auth token. - Service mode: Your Mode Token. - Service oracle_moat_analytics: Your Oracle Moat Analytics Token. - Service shareasale: Your ShareASale token. - Service solarwinds_service_desk: Your SolarWinds Service Desk token.
TokenAuthenticatedContainer string: Field usage depends on service value: - Service cosmos: The container name. Required for the RESOURCE_TOKEN data access method.
TokenAuthenticatedDatabase string: Field usage depends on service value: - Service cosmos: The database name. Required for the RESOURCE_TOKEN data access method.
TokenId string: Field usage depends on service value: - Service chargedesk: Your ChargeDesk token ID. - Service mux: Your Mux token ID
TokenKey string: Field usage depends on service value: - Service netsuite_suiteanalytics: Token ID - Service on24: Your ON24 token key. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Token Key.
TokenSecret string: Field usage depends on service value: - Service netsuite_suiteanalytics: Token Secret - Service on24: Your ON24 token secret.
TokenSecretKey string: Field usage depends on service value: - Service mux: Your Mux token secret key
TokenUrlRegion string: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP token URL region.
Topics []string: Field usage depends on service value: - Service azure_service_bus: The comma-separated list of topics which should be synced. Required if you do not have manage permissions
TrustStoreType string: Field usage depends on service value: - Service heroku_kafka: Trust Store Type
TrustedCert string: Field usage depends on service value: - Service apache_kafka: Kafka trusted certificate. - Service heroku_kafka: Heroku Kafka trusted certificate. Required for TLS security protocol.
Truststore string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Truststore File as Base64 encoded string.
TunnelHost string: Field usage depends on service value: - Service aurora: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service aurora_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_cosmos_for_mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_managed_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service clarity: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service cockroachdb: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service db2i_hva: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service db2i_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service documentdb: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service dynamics_365_fo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service ehr: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service elastic_cloud: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service es_self_hosted: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service google_cloud_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_postgresql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_sqlserver: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_b1: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service heroku_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo_sharded: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service opendistro: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service opensearch: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service oracle: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_ebs: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rac: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_s4hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sftp: Tunnel host address, specify only to connect via SSH tunnel. - Service sql_server: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_sap_ecc_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
TunnelPort float64: Field usage depends on service value: - Service aurora: SSH port, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH port, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH port, specify only to connect via an SSH tunnel. - Service clarity: SSH port, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH port, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service documentdb: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH port, specify only to connect via an SSH tunnel. - Service ehr: SSH port, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH port, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH port, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH port, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service maria: SSH port, specify only to connect via an SSH tunnel. - Service maria_azure: SSH port, specify only to connect via an SSH tunnel. - Service maria_rds: SSH port, specify only to connect via an SSH tunnel. - Service mongo: SSH port, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH port, specify only to connect via an SSH tunnel. - Service mysql: SSH port, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH port, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service opendistro: SSH port, specify only to connect using an SSH tunnel. - Service opensearch: SSH port, specify only to connect using an SSH tunnel. - Service oracle: SSH port, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH port, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service postgres: SSH port, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH port, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH port, specify only to connect via an SSH tunnel. - Service sftp: Tunnel port, specify only to connect via SSH tunnel. - Service sql_server: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH port, specify only to connect via an SSH tunnel.
TunnelUser string: Field usage depends on service value: - Service aurora: SSH user, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH user, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH user, specify only to connect via an SSH tunnel. - Service clarity: SSH user, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH user, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service documentdb: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH user, specify only to connect via an SSH tunnel. - Service ehr: SSH user, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH user, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH user, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH user, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service maria: SSH user, specify only to connect via an SSH tunnel. - Service maria_azure: SSH user, specify only to connect via an SSH tunnel. - Service maria_rds: SSH user, specify only to connect via an SSH tunnel. - Service mongo: SSH user, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH user, specify only to connect via an SSH tunnel. - Service mysql: SSH user, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH user, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service opendistro: SSH user, specify only to connect using an SSH tunnel. - Service opensearch: SSH user, specify only to connect using an SSH tunnel. - Service oracle: SSH user, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH user, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service postgres: SSH user, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH user, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH user, specify only to connect via an SSH tunnel. - Service sftp: Tunnel user, specify only to connect via SSH tunnel. - Service sql_server: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH user, specify only to connect via an SSH tunnel.
TypeName string: Field usage depends on service value: - Service akamai: Your Akamai type name. - Service bubble: Your Bubble type name.
UniqueId string
UpdateConfigOnEachSync bool: Field usage depends on service value: - Service google_display_and_video_360: 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.
UpdateMethod string: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service azure_postgres: 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. - Service azure_sql_db: (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. - Service azure_sql_managed_db: (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. - Service clarity: (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. - Service dynamics_365_fo: Update Method - Service ehr: (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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: (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. - Service heroku_postgres: 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. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Default value: Teleport - Service snowflake_db: Default value: Teleport - Service sql_server: (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. - Service sql_server_hva: (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. - Service sql_server_rds: (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. - Service sql_server_sap_ecc_hva: (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.
Uri string: Field usage depends on service value: - Service cosmos: Cosmos resource instance address.
UrlFormat string: Field usage depends on service value: - Service fountain: Your Fountain URL format.
UseApiKeys bool: Field usage depends on service value: - Service mandrill: Whether to use multiple API keys for interaction.
UseCustomerBucket bool: Field usage depends on service value: - Service appsflyer: Use Custom Bucket. Set it to 'true' if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket.
UseOracleRac bool: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using a RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you're using a RAC instance.
UsePgpEncryptionOptions bool: Field usage depends on service value: - Service azure_blob_storage: Set to true if files present in the Azure Blob Storage container are encrypted using PGP. Default value: false. - Service ftp: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service gcs: Set to true if files are encrypted using PGP in the GCS bucket. Default value: false. - Service s3: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service sftp: Set to true if files present in SFTP server are encrypted using PGP. Default value: false. - Service wasabi_cloud_storage: Set to true if files are encrypted using PGP in the Wasabi Cloud Storage bucket. Default value: false.
UseServiceAccount bool: Field usage depends on service value: - Service bigquery_db: BigQuery use service account; default is false
UseTemplateLabels bool: Field usage depends on service value: - Service mandrill: Use template labels to filter templates for sync
UseWebhooks bool: Field usage depends on service value: - Service github: Set to true to capture deletes. - Service xero: Updates to few fields like sent_to_contact in Invoice table might be missed if you don't enable this.
UseWorkspace bool: Field usage depends on service value: - Service bigquery_db: Create and drop tables in a query results dataset. Default is false - Service snowflake_db: Choose a database and schema to create temporary tables for syncs.
User string: Field usage depends on service value: - Service aurora: The user name. - Service aurora_postgres: The user name. - Service azure_cosmos_for_mongo: Username for source database access. - Service azure_postgres: The user name. - Service azure_sql_db: The user name. For Azure Databases, the format must be user@domain. - Service azure_sql_managed_db: The user name. For Azure Databases, the format must be user@domain. - Service clarity: The user name. For Azure Databases, the format must be user@domain. - Service cockroachdb: The user name. - Service db2i_hva: The user name. - Service db2i_sap_hva: The username. - Service documentdb: The user name. - Service dynamics_365_fo: The user name. The format must be user@domain. - Service ehr: The user name. For Azure Databases, the format must be user@domain. - Service elastic_cloud: The user name. - Service es_self_hosted: The user name. - Service ftp: FTP user. - Service google_cloud_mysql: The user name. - Service google_cloud_postgresql: The user name. - Service google_cloud_sqlserver: The user name. For Azure Databases, the format must be user@domain. - Service hana_sap_hva_b1: The username. - Service hana_sap_hva_ecc: The username. - Service hana_sap_hva_ecc_netweaver: The username. - Service hana_sap_hva_s4: The username. - Service hana_sap_hva_s4_netweaver: The username. - Service heroku_postgres: The user name. - Service jira: The Jira username. - Service magento_mysql: The user name. - Service magento_mysql_rds: The user name. - Service maria: The user name. - Service maria_azure: The user name. - Service maria_rds: The user name. - Service marin: The Marin username. - Service mongo: The user name. - Service mongo_sharded: The user name. - Service mysql: The user name. - Service mysql_azure: The user name. - Service mysql_rds: The user name. - Service opendistro: The user name. - Service opensearch: The user name. - Service oracle: The user name. - Service oracle_ebs: The user name. - Service oracle_hva: The user name. - Service oracle_rac: The user name. - Service oracle_rds: The user name. - Service oracle_sap_hva: The username. - Service oracle_sap_hva_netweaver: The username. - Service outbrain: The username or email of the Outbrain user. - Service postgres: The user name. - Service postgres_rds: The user name. - Service redshift_db: The Redshift username. - Service sap_hana: Your SAP HANA user name. - Service sap_s4hana: Your SAP S/4 user name. - Service sftp: SFTP user. - Service snowflake_db: The Snowflake username. - Service splunk: The Splunk username. - Service sql_server: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_hva: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_rds: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_sap_ecc_hva: The user name. For Azure Databases, the format must be user@domain.
UserId string: Field usage depends on service value: - Service coassemble: Your Coassemble user ID. - Service gmail: Your Gmail user ID. - Service hibob: Your HiBob Service User Token. - Service marketo: Marketo SOAP API User Id. - Service okendo: Your Okendo user ID. - Service playvox: Your Playvox User ID. - Service sage_intacct: User ID - Service vimeo: Your Vimeo user ID.
UserKey string
UserName string: Field usage depends on service value: - Service workday: Workday username.
UserProfiles []string: Field usage depends on service value: - Service double_click_campaign_manager: IDs of specific User Profiles to sync. Must be populated if sync_mode is set to SpecificAccounts.
UserToken string: Field usage depends on service value: - Service hibob: Your HiBob Service User ID. - Service konnect_insights: Your Konnect Insights User Token. - Service sonarqube: Your Sonarqube user token.
Username string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS username. - Service adobe_commerce: Your Adobe Commerce username. - Service akeneo: Your Akeneo username. - Service anaplan: Your Anaplan user ID. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Username. - Service aveva_pi: Username for the user to authenticate as with the AF Server - Service ceridian_dayforce: Your Ceridian Dayforce Username. - Service churnzero: Your ChurnZero username. - Service cin7: Your Cin7 API Username. - Service collibra: Your collibra username. - Service compliance_checkpoint: Your Compliance Checkpoint account username. - Service concur: The SAP Concur username. - Service confluence: Your Confluence username. - Service contrast_security: Your Contrast Security API Username. - Service dcl_logistics: Your DCL Logistics username. - Service deposco: Your Deposco username. - Service github: Login of your GitHub profile. - Service gladly: Your Gladly Username. - Service globalmeet: Your GlobalMeet Username. - Service gorgias: Your Gorgias username. - Service green_power_monitor: Your GreenPowerMonitor username. - Service guru: Your Guru username. - Service hilti_ontrack: Your Hilti On!Track username. - Service impact: Your Impact Account SID - Service integral_ad_science: Your integral_ad_science username. - Service itunes_connect: Your Apple ID - Service jamf: Your Jamf username. - Service khoros_care: Your Khoros Care username. - Service kissmetrics: Your Kissmetrics API Username. - Service klarna: Your Klarna Username. - Service learnupon: Your Learnupon username. - Service lessonly: Your Lessonly username. - Service mailgun: Your Mailgun API username. - Service myosh: Your myosh username. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence username. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud username. - Service partnerize: Your Partnerize account's username. - Service pingdom: Your Pingdom Username. - Service podio: Your Podio account username. - Service qmatic_data_connect: Your Qmatic Data Connect username. - Service quorum: Your Quorum username . - Service revx: Your RevX Username. - Service rtb_house: Your RTB House username. - Service sap_business_by_design: The SAP Business ByDesign username. - Service scorm: Your Scorm App ID. - Service servicenow: Your ServiceNow User ID (username). - Service shiphero: Your ShipHero username. - Service shipstation: Your ShipStation username. - Service shopware: Your Shopware username. - Service splash: Your Splash username. - Service starrez: Your StarRez API username - Service stickyio: Your sticky.io username . - Service stylight: Your Stylight Username. - Service sugarcrm: Your SugarCRM username. - Service teamwork: Your Teamwork username. - Service testrail: Your TestRail username. - Service ukg_pro: Your UKG Pro username. - Service unicommerce: Your uniware login username. - Service upland: Your Upland Software Username. - Service veevavault: Your Veeva Vault username. - Service when_i_work: Your When I Work username. - Service wherefour: Your Wherefour username. - Service workday_financial_management: Workday username. - Service workday_hcm: Username of your Workday Integration System User account - Service xandr: Your Xandr username. - Service younium: Your Younium username.
Version string: Field usage depends on service value: - Service criteo_retail_media: Your Criteo Retail Media version.
ViewAttributionWindow string: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on views. Possible view_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'view' action. - Service snapchat_ads: The time period to attribute conversions based on views. Default value: DAY_1
ViewId string: Field usage depends on service value: - Service pigment: Your Pigment view ID.
ViewThroughAttributionWindowSize string: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on views. Default value: DAY_7
WebServiceApiKey string: Field usage depends on service value: - Service adyen: Your Adyen Web Service API key.
WebhookEndpoint string: Field usage depends on service value: - Service appsflyer: Webhook Url
WebhookKey string: Field usage depends on service value: - Service xero: Webhook Key
WebhookUrl string: Field usage depends on service value: - Service branch: Webhook URL - Service pipedrive: The registered URL for webhooks in your Pipedrive dashboard. - Service segment: Webhook URL. - Service xero: (ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO.
WordPressSiteIdOrWoocommerceDomainName string: Field usage depends on service value: - Service woocommerce: The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance.
WorkplaceId string: Field usage depends on service value: - Service moloco: Your Moloco workplace ID.
Workspace string: Field usage depends on service value: - Service mode: Your Mode Workspace.
WorkspaceName string: Field usage depends on service value: - Service bigquery_db: Workspace Dataset Name - Service snowflake_db: The name of the database where the temporary tables will be created.
WorkspaceSameAsSource bool: Field usage depends on service value: - Service bigquery_db: Use the source dataset as the workspace dataset
WorkspaceSchema string: Field usage depends on service value: - Service snowflake_db: The name of the schema that belongs to the workspace database where the temporary tables will be created.
WsCertificate string: Field usage depends on service value: - Service adp_workforce_now: Web Services Certificate.
XApiKey string: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X API key.
XKey string: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research key.
XMasterKey string: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research master key.
XUserEmail string: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Email.
XUserToken string: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Token.

absConnectionMethod String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection method
absConnectionString String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection string. - Service braze: Connection String
absContainerAddress String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container address
absContainerName String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container name. - Service braze: Container Name
absHostIp String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage host IP
absHostUser String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage username
absPrefix String: Field usage depends on service value: - Service braze: Prefix
absPublicKey String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage public key
academyId String: Field usage depends on service value: - Service workramp: Your WorkRamp academy ID.
accessId String: Field usage depends on service value: - Service planful: Your Planful access ID.
accessKey String: Field usage depends on service value: - Service gainsight_customer_success: The access key for API authentication. - Service gongio: Your Gongio Access key. - Service line_ads: Your LINE Ads access key. - Service planful: Your Planful access key. - Service retailnext: Your RetailNext access key.
accessKeyId String: Field usage depends on service value: - Service appsflyer: Your AWS access key ID. - Service aws_cost_report: Access Key ID - Service checkout: Your Checkout.com access key ID. - Service cloudtalk: Your CloudTalk Access Key ID. - Service nice: Your NICE access key ID. - Service s3: Access Key ID - Service wasabi_cloud_storage: Access Key ID
accessKeySecret String: Field usage depends on service value: - Service aws_cost_report: Access Key Secret - Service checkout: Your Checkout.com access key secret. - Service cloudtalk: Your CloudTalk Access Key Secret. - Service gongio: Your Gongio Access Key Secret. - Service nice: Your NICE access key secret. - Service s3: Access Key Secret - Service wasabi_cloud_storage: Access Key Secret
accessToken String: Field usage depends on service value: - Service 7shifts: Your 7shifts access token. - Service attio: Your Attio bearer token - Service big_commerce: API access token of your store. - Service bitly: Your Bitly access token. - Service calabrio: Your Calabrio access token. - Service coupa: Your Coupa access token fetched using client_id and client_secret - Service deputy: Your Deputy API access token. - Service getfeedback: Your GetFeedback Access token. - Service gocardless: Your GoCardless API token. - Service ironclad: Your Ironclad access token. - Service khoros_marketing: Your Khoros Marketing access token. - Service kustomer: Your Kustomer API key. - Service lattice: Your Lattice API access token. - Service launchdarkly: Your LaunchDarkly access token. - Service leap_crm: Your Leap CRM access token. - Service nylas: Your Nylas access_token. - Service planhat: Your Planhat access token. - Service rollbar: Your Rollbar Access Token. - Service samsara: Your Samsara API token. - Service slab: Your Slab API key. - Service stripe: The Stripe API Restricted Key - Service stripe_test: The Stripe API Restricted Key - Service talkwalker: Your Talkwalker access token. - Service workable: Your Workable Access Token. - Service workramp: Your WorkRamp access token.
accessType String: Field usage depends on service value: - Service share_point: Access Type
account String: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Account ID. - Service ordway: Your Ordway account type.
accountAccessToken String: Field usage depends on service value: - Service rollbar: Your Rollbar account access token.
accountId String: Field usage depends on service value: - Service appcues: Your Appcues Account ID. - Service brightcove: Your Brightcove account ID. - Service cin7core: Your Cin7 Core account ID. - Service dear: Your Dear Account ID. - Service harvest: Your Harvest Account ID. - Service optimizely: Your Optimizely account ID. - Service rokt: Your Rokt account ID. - Service udemy_business: Your Udemy Business account ID.
accountIds List<String>: Field usage depends on service value: - Service taboola: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
accountKey String: Field usage depends on service value: - Service cosmos: The read-only primary or secondary account key for the database account. Required for the ACCOUNT_KEY data access method. - Service simplesat: Your Simplesat account key.
accountName String: Field usage depends on service value: - Service eventsforce: Your Eventsforce account name. - Service freshdesk_contact_center: Your Freshdesk Contact Center account name. - Service happyfox: Your HappyFox account name. - Service maxio_saasoptics: Your Maxio SaaSOptics account name. - Service talkdesk: Your Talkdesk Account Name. - Service udemy_business: Your Udemy Business account name.
accountPlan String: Field usage depends on service value: - Service tymeshift: Your Tymeshift account plan.
accountRegion String: Field usage depends on service value: - Service iterable: If your Iterable account URL starts with https://app.eu.iterable.com then provide EU else US
accountSid String: Field usage depends on service value: - Service fone_dynamics: Your Fone Dynamics account SID.
accountSyncMode String: Field usage depends on service value: - Service itunes_connect: Account Sync Mode
accountToken String: Field usage depends on service value: - Service konnect_insights: Your Konnect Insights Account Token.
accountType String: Field usage depends on service value: - Service freightview: Your Freightview Account Type.
accounts List<String>: Field usage depends on service value: - Service bingads: Specific accounts to sync. Must be populated if syncMode is set to SpecificAccounts. - Service facebook: List of accounts of which connector will sync the data. - Service facebook_ad_account: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service facebook_ads: List of accounts of which connector will sync the data. - Service google_ads: The list of Account IDs to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service google_analytics: The list of specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_4: The list of specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_analytics_mcf: Specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_search_ads_360: Specific accounts to sync. Must be populated if accountsSyncMode is set to SPECIFIC_ACCOUNTS. - Service instagram_business: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service itunes_connect: Accounts - Service linkedin_ads: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service spotify_ads: The list of Ad Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service tiktok_ads: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twilio: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
accountsRedditAds List<GetConnectorConfigAccountsRedditAd>: Field usage depends on service value: - Service reddit_ads: Accounts
accountsSyncMode String: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all accounts or specific.
actionBreakdowns List<String>: Field usage depends on service value: - Service facebook: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
actionReportTime String: Field usage depends on service value: - Service facebook: The report time of action stats. Possible action_report time values.
adAnalytics String: Field usage depends on service value: - Service linkedin_ads: Whether to sync all analytic reports or specific. Default value: AllReports
adUnitView String: Field usage depends on service value: - Service double_click_publishers: Ad unit view for the report.
adminApiKey String: Field usage depends on service value: - Service splitio: Your Split admin api key.
adobeAnalyticsConfigurations List<GetConnectorConfigAdobeAnalyticsConfiguration>: Field usage depends on service value: - Service adobe_analytics: 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.
advertisables List<String>: Field usage depends on service value: - Service adroll: Specific advertisables to sync. Must be populated if sync_mode is set to SpecificAdvertisables.
advertisers List<String>: Field usage depends on service value: - Service google_display_and_video_360: The list of advertisers to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service google_search_ads_360: Specific advertisers to sync. Must be populated if advertisersSyncMode is set to SPECIFIC_ADVERTISERS. - Service pinterest_ads: Specific Advertisers to sync. Must be populated if sync_mode is set to SpecificAdvertisers.
advertisersIds List<String>: Field usage depends on service value: - Service yahoo_gemini: Specific Advertiser IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
advertisersSyncMode String: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all or specific advertisers.
advertisersWithSeats List<String>: Field usage depends on service value: - Service yahoo_dsp: Specific Advertisers to sync. Must be populated if sync_mode_advertiser is set to SPECIFIC_ADVERTISERS. Pay attention to the format: AdvertiserId:SeatId
agentConfigMethod String
agentHost String: Field usage depends on service value: - Service db2i_hva: The agent host. - Service db2i_sap_hva: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service oracle_hva: The host of the agent. This is the same as database host, since the agent must be installed in the same machine as source database. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service sql_server_hva: The host address of the machine running the agent. Often the same as the DB host. - Service sql_server_sap_ecc_hva: The host address of the machine running the agent. Often the same as the DB host.
agentId String: Field usage depends on service value: - Service phoenix_ads: Your Phoenix Ads Agent ID.
agentOraHome String: Field usage depends on service value: - Service oracle_hva: The home directory of the Oracle database. - Service oracle_sap_hva: The home directory of the Oracle database.
agentPassword String: Field usage depends on service value: - Service db2i_hva: The agent password. - Service db2i_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_b1: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_hva: The agent user's password. It should have a minimum length of 10 characters. - Service oracle_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_sap_hva_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service sql_server_hva: The password for the agent user. - Service sql_server_sap_ecc_hva: The password for the agent user.
agentPort Double: Field usage depends on service value: - Service db2i_hva: The agent port. - Service db2i_sap_hva: The port number of the agent. - Service hana_sap_hva_b1: The port number of the agent. - Service hana_sap_hva_ecc: The port number of the agent. - Service hana_sap_hva_ecc_netweaver: The port number of the agent. - Service hana_sap_hva_s4: The port number of the agent. - Service hana_sap_hva_s4_netweaver: The port number of the agent. - Service oracle_hva: The port number of the agent. - Service oracle_sap_hva: The port number of the agent. - Service oracle_sap_hva_netweaver: The port number of the agent. - Service sql_server_hva: The port that the agent has open for Fivetran's connection. Default value is 4343. - Service sql_server_sap_ecc_hva: The port that the agent has open for Fivetran's connection. Default value is 4343.
agentPublicCert String: Field usage depends on service value: - Service db2i_hva: The public certificate for the agent. - Service db2i_sap_hva: The agent public certificate. - Service hana_sap_hva_b1: The agent public certificate. - Service hana_sap_hva_ecc: The agent public certificate. - Service hana_sap_hva_ecc_netweaver: The agent public certificate. - Service hana_sap_hva_s4: The agent public certificate. - Service hana_sap_hva_s4_netweaver: The agent public certificate. - Service oracle_hva: The agent public certificate. - Service oracle_sap_hva: The agent public certificate. - Service oracle_sap_hva_netweaver: The agent public certificate. - Service sql_server_hva: The public certificate generated by the agent. - Service sql_server_sap_ecc_hva: The public certificate generated by the agent.
agentUser String: Field usage depends on service value: - Service db2i_hva: The agent user name. - Service db2i_sap_hva: The agent's user. - Service hana_sap_hva_b1: The agent's user. - Service hana_sap_hva_ecc: The agent's user. - Service hana_sap_hva_ecc_netweaver: The agent's user. - Service hana_sap_hva_s4: The agent's user. - Service hana_sap_hva_s4_netweaver: The agent's user. - Service oracle_hva: The agent's user. - Service oracle_sap_hva: The agent's user. - Service oracle_sap_hva_netweaver: The agent's user. - Service sql_server_hva: The agent's username. - Service sql_server_sap_ecc_hva: The agent's username.
aggregation String: Field usage depends on service value: - Service facebook: Options to select aggregation duration. Possible aggregation values.
agreementGrantToken String: Field usage depends on service value: - Service economic: Your E-conomic X-AgreementGrantToken goes here.
alwaysEncrypted Boolean: Field usage depends on service value: - Service aurora: Require TLS through Tunnel - Service aurora_postgres: Require TLS through Tunnel - Service azure_cosmos_for_mongo: Require TLS - Service azure_postgres: Require TLS through Tunnel - Service azure_sql_db: Require TLS through Tunnel. - Service azure_sql_managed_db: Require TLS. - Service clarity: Require TLS through Tunnel. - Service cockroachdb: Require TLS - Service db2i_hva: Require TLS through Tunnel - Service db2i_sap_hva: Require TLS through Tunnel - Service documentdb: Require TLS encryption. - Service dynamics_365_fo: Require TLS through Tunnel. - Service ehr: Require TLS through Tunnel. - Service elastic_cloud: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service es_self_hosted: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service google_cloud_mysql: Require TLS through Tunnel - Service google_cloud_postgresql: Require TLS through Tunnel - Service google_cloud_sqlserver: Require TLS. - Service heroku_postgres: Require TLS through Tunnel - Service magento_mysql: Require TLS through Tunnel - Service magento_mysql_rds: Require TLS through Tunnel - Service maria: Require TLS through Tunnel - Service maria_azure: Require TLS through Tunnel - Service maria_rds: Require TLS through Tunnel - Service mongo: Require TLS - Service mongo_sharded: Require TLS through Tunnel - Service mysql: Require TLS through Tunnel - Service mysql_azure: Require TLS through Tunnel - Service mysql_rds: Require TLS through Tunnel - Service opendistro: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service opensearch: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service oracle: Require TLS through Tunnel - Service oracle_ebs: Require TLS through Tunnel - Service oracle_hva: Require TLS through Tunnel - Service oracle_rac: Require TLS through Tunnel - Service oracle_rds: Require TLS through Tunnel - Service oracle_sap_hva: Require TLS through Tunnel - Service oracle_sap_hva_netweaver: Require TLS. - Service postgres: Require TLS through Tunnel - Service postgres_rds: Require TLS through Tunnel - Service sql_server: Require TLS. - Service sql_server_hva: Require TLS. - Service sql_server_rds: Require TLS. - Service sql_server_sap_ecc_hva: Require TLS.
api String: Field usage depends on service value: - Service freshsuccess: Set this parameter to api.
apiAccessToken String: Field usage depends on service value: - Service flywheel_digital: Your Flywheel Digital API access token. - Service shopify: API access token of your custom app. - Service square: The Square API access token of your application.
apiEnvironment String: Field usage depends on service value: - Service afterpay: Your Afterpay API environment.
apiId String: Field usage depends on service value: - Service aircall: Your Aircall API ID.
apiKey String: Field usage depends on service value: - Service 15five: Your 15five API key. - Service 360learning: Your 360Learning API Key. - Service 6sense: Your 6sense API Key. - Service acculynx: Your Acculynx API key. - Service activecampaign: Your ActiveCampaign API key. - Service affinity: Your Affinity API key. - Service airtable: API key of the Airtable account. - Service algolia: Your Algolia API key. - Service anvyl: Your Anvyl API key. - Service appcues: Your Appcues API key. - Service ashby: Your Ashby API key. - Service assembled: Your Assembled API key. - Service atlassian_jira_align: Your Jira Align API key. - Service atlassian_ops_genie: Your Opsgenie API key - Service attentive: Your Attentive API key. - Service aumni: Your Aumni API key. - Service avantlink: Your AvantLink API key. - Service ballotready: Your BallotReady API token. - Service bamboohr: Your API Key. - Service bazaarvoice: Your Bazaarvoice API key. - Service betterworks: Your Betterworks API key. - Service bigmarker: Your BigMarker API key. - Service bizzabo: Your Bizzabo API key. - Service brave_ads: Your Brave Ads API key - Service braze: Your Braze API Key. - Service brevo: Your Brevo API key. - Service bubble: Your Bubble API token. - Service buildium: Your Buildium private API key. - Service callrail: Your CallRail API key. - Service campaignmonitor: Your Campaign Monitor API key. - Service canny: Your Canny API key. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 API key. - Service chargebee_product_catalog_2: Your Chargebee API key. - Service chartmogul: Your ChartMogul API key. - Service chorusai: Your Chorus API key. - Service churnkey: Your Churnkey API Key. - Service churnzero: Your ChurnZero API key. - Service cimis: Your Cimis API key. - Service circleci: Your CircleCI API Key. - Service clickup: Your ClickUp API key. - Service clockify: Your Clockify API key. - Service clockodo: Your Clockodo API key. - Service close: Your Close API key. - Service cloudbeds: Your Cloudbeds API key. - Service clubspeed: Your Clubspeed API key. - Service coassemble: Your Coassemble API key. - Service codefresh: Your Codefresh API Key. - Service column: Your Column API key. - Service concord: Your Concord API key. - Service confluent_cloud: API Key - Service contrast_security: Your Contrast Security API Key. - Service copper: Your Copper API key. - Service coupa: Your Coupa API key. - Service datadog: Your Datadog API key. - Service dbt_cloud: Your dbt Cloud service token. - Service dcl_logistics: Your DCL Logistics API key. - Service delighted: API Key for your Delighted account - Service destini: Your Destini API Key. - Service donus: Your Donus API key. - Service doorloop: Your DoorLoop API key. - Service drata: Your Drata API Key. - Service dropbox_sign: Your Dropbox Sign API key. - Service duoplane: Your Duoplane API key. - Service easypost: Your EasyPost API Key. - Service electronic_tenant_solutions: Your Electronic Tenant Solutions API key. - Service eventsforce: Your Eventsforce API secret key. - Service everflow: Your Everflow API key. - Service everhour: Your Everhour API Token. - Service expensein: Your ExpenseIn API key. - Service factorial: Your Factorial API key. - Service firehydrant: Your FireHydrant API key. - Service float: Your Float API key. - Service forj_community: Your Forj Community API key. - Service fourkites: Your FourKites API key. - Service freightview: Your Freightview API key. - Service freshdesk: Your Freshdesk API Key. - Service freshdesk_contact_center: Your Freshdesk Contact Center API key. - Service freshsales: Your Freshsales API key. - Service freshservice: Your Freshservice API Key. - Service freshsuccess: Your Freshsuccess API key. - Service freshteam: Your Freshteam API key. - Service friendbuy: Your Friendbuy API key. - Service fullstory: Your Fullstory API key. - Service gainsight_product_experience: Your Gainsight Product Experience API key. - Service gem: Your Gem API key. - Service gorgias: Your Gorgias API key. - Service greenhouse: Your Greenhouse API key. - Service grepsr: Your Grepsr API Key. - Service grin: Your Grin API key. - Service happyfox: Your HappyFox API key. - Service height: Your Height API key. - Service helpshift: Your Helpshift API Key. - Service incidentio: Your incident.io API key. - Service infobip: Your Infobip API key. - Service insightly: Your Insightly API key. - Service integrate: Your Integrate API key. - Service invoiced: Your Invoiced API key. - Service iterable: Your Iterable API key. - Service ivanti: Your Ivanti API Key. - Service jotform: Your Jotform API key. - Service justcall: Your JustCall API key. - Service katana: Your Katana API key. - Service kevel: Your Kevel API key. - Service keypay: Your KeyPay API key. - Service kisi: Your Kisi API key. - Service klaviyo: Your Klaviyo API key. - Service learnupon: Your Learnupon API key. - Service lemlist: Your Lemlist API key. - Service lever: Your Lever API key. - Service liftoff: Your Liftoff API key. - Service linear: Your Linear API key. - Service linksquares: Your LinkSquares API key. - Service lob: Your Lob API key. - Service loop: Your Loop API key. - Service lucca: Your Lucca API key. - Service luma: Your Luma API key. - Service maileon: Your Maileon API key. - Service mailgun: Your Mailgun API key. - Service mailjet: Your Mailjet API key. - Service malomo: Your Malomo API key. - Service mambu: Your Mambu API key. - Service mandrill: Your Mandrill API key. - Service maxio_chargify: Enter Your API Key. - Service messagebird: Your MessageBird API key. - Service mountain: Your MNTN API key. - Service myosh: Your myosh API key. - Service okendo: Your Okendo API key. - Service ometria: Your Ometria API Key. - Service oncehub: Your OnceHub API key. - Service ordway: Your Ordway API key. - Service ortto: Your Ortto API key. - Service pagerduty: Your PagerDuty API key. - Service pandadoc: Your PandaDoc API key. - Service papershift: Your Papershift API Key - Service partnerize: Your Partnerize user API key. - Service persona: Your Persona API key. - Service picqer: Your Picqer API key. - Service pigment: Your Pigment API key. - Service pinpoint: Your Pinpoint API key. - Service pipe17: The Pipe17 API key. - Service placerai: Your Placer.ai API key. - Service playvox: Your Playvox API Key. - Service posthog: Your PostHog API key. - Service prive: Your Prive API key. - Service prosperstack: Your ProsperStack API key. - Service qualaroo: Your Qualaroo API Key. - Service quorum: Your Quorum API key. - Service rebound_returns: Your ReBound Returns API key. - Service recurly: The Recurly API key. - Service replyio: Your Reply API key. - Service revenuecat: Your RevenueCat API key. - Service reviewsio: Your REVIEWS.io API key. - Service revops: Your RevOps bearer token. - Service ricochet360: Your Ricochet360 API key. - Service ringover: Your Ringover API key. - Service rippling: Your Rippling API key. - Service rocketlane: Your Rocketlane API key. - Service rootly: Your Rootly API key. - Service ruddr: Your Ruddr API key. - Service safebase: Your SafeBase API key. - Service sage_hr: Your Sage HR API key. - Service sailthru: The Sailthru API key. - Service salsify: Your Salsify API Key. - Service security_journey: Your Security Journey API key. - Service sendgrid: The SendGrid API key. - Service sendinblue: Your Sendinblue API key. - Service shortcut: Your Shortcut API token. - Service shortio: Your Short.io API key. - Service simplesat: Your Simplesat API key. - Service sistrix: Your SISTRIX API key. - Service skilljar: Your Skilljar API key. - Service smartwaiver: Your Smartwaiver API key. - Service snyk: Your Snyk API key. - Service sonarqube: Your Sonarqube API key. - Service sparkpost: Your SparkPost API key. - Service squarespace: Your Squarespace API key. - Service stackadapt: Your StackAdapt API key. - Service statuspage: Your Statuspage API Key. - Service stripe: Restricted API key - Service stripe_test: Restricted API key - Service subscript: Your Subscript API key. - Service survicate: Your Survicate API Key. - Service teads: Your Teads API key. - Service teamtailor: Your Teamtailor API key. - Service testrail: Your TestRail API key. - Service ticket_tailor: Your Ticket Tailor API key. - Service transcend: Your Transcend API key. - Service trello: Your TRELLO api key. - Service triple_whale: Your Triple Whale API key. - Service uppromote: Your UpPromote API key. - Service veeqo: Your Veeqo API key. - Service venminder: Your Venminder API key. - Service visit_by_ges: Your Visit by GES API key. - Service vitally: Your Vitally API key. - Service vonage: Your Vonage API Key. - Service vts: Your VTS API key. - Service webconnex: Your Webconnex API key. - Service wicked_reports: Your Wicked Reports API key. - Service workleap_officevibe: Your Workleap Officevibe API key. - Service xsolla: Your Xsolla API key. - Service yougov_sport: Your Yougov Sport API key. - Service zingtree: Your Zingtree API key. - Service zip: Your Zip API key.
apiKeyApiSecret String: Field usage depends on service value: - Service revel: Your Revel Systems API Key and API Secret.
apiKeys List<String>: Field usage depends on service value: - Service mandrill: Comma-separated list of API keys. Required if use_api_keys is set to true.
apiPassword String: Field usage depends on service value: - Service duoplane: Your Duoplane API password.
apiQuota Double: Field usage depends on service value: - Service marketo: Allowed number of API requests to Marketo instance per day, the default value is 10000.
apiReadAccessToken String: Field usage depends on service value: - Service the_movie_database: Your The Movie Database API read access token.
apiRequestsPerMinute Double: Field usage depends on service value: - Service qualtrics: Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
apiSecret String: Field usage depends on service value: - Service confluent_cloud: API Secret - Service forj_community: Your Forj Community API secret. - Service friendbuy: Your Friendbuy API secret. - Service justcall: Your JustCall API secret. - Service liftoff: Your Liftoff API secret. - Service mixpanel: Mixpanel API Secret. - Service qualaroo: Your Qualaroo API Secret. - Service sailthru: The Sailthru API secret. - Service shareasale: Your ShareASale API secret. - Service vonage: Your Vonage API Secret.
apiSecretKey String: Field usage depends on service value: - Service alchemer: Your Alchemer API Secret key.
apiServer String: Field usage depends on service value: - Service sigma_computing_source: Your Sigma Computing api server.
apiToken String: Field usage depends on service value: - Service aha: Your Aha! API key. - Service aircall: Your Aircall API Token. - Service appsflyer: API Token for AppsFlyer's PULL API. - Service awin: Your Awin API Token. - Service backbone_plm: Your Backbone PLM API token. - Service brex: Your Brex API token - Service buildkite: Your Buildkite API token. - Service buzzsprout: Your Buzzsprout API token. - Service centra: Your Centra API token. - Service chameleon: Your Chameleon API token. - Service clari: Your Clari API token. - Service cloudflare_analytics: Your Cloudflare Analytics API token. - Service confluence: The Confluence API token. - Service dixa: Your Dixa API token. - Service drip: Your Drip API Token. - Service factbird: Your Factbird API token. - Service fone_dynamics: Your Fone Dynamics API token. - Service fountain: Your Fountain API token. - Service g2: Your G2 API token. - Service gladly: Your Gladly API Token. - Service hibob: Your Hibob API token. - Service kandji: Your Kandji API token. - Service livechat: Your Livechat Access token. - Service livechat_partner: Your Livechat Partner API Token. - Service maxio_saasoptics: Your Maxio SaaSOptics API token. - Service megaphone: Your Megaphone API token. - Service missive: Your Missive API token. - Service mixmax: Mixmax API token. - Service okta: Your Okta API token. - Service ordway: Your Ordway API token. - Service packiyo: Your Packiyo API token. - Service pipedrive: (Optional)Your Pipedrive personal API token - Service pivotal_tracker: Pivotal Tracker API token. - Service postmark: Your Postmark account API token. - Service productive: Your Productive API token. - Service qualtrics: API token of the Qualtrics account. - Service rakutenadvertising: Your Rakuten Advertising API token. - Service recharge: The Recharge API token. - Service referralhero: Your Referralhero API token. - Service resource_management_by_smartsheet: Your Resource Management by Smartsheet API token. - Service retently: Your Retently API token. - Service reviewsai: Your REVIEWS.ai API token. - Service rundeck: Your Rundeck API token. - Service safetyculture: Your SafetyCulture API token. - Service sensor_tower: Your Sensor Tower API token. - Service sentry: Your Sentry auth token. - Service simplecast: Your Simplecast API token. - Service snyk: Your Snyk API token. - Service textus: Your TextUs API token. - Service toggl_track: Your Toggl Track API token - Service trello: Your TRELLO api token. - Service trisolute: Your Trisolute API token. - Service vwo: Your VWO API token. - Service web_scraper: Your Web Scraper API token. - Service zendesk: Zendesk API tokens are auto-generated passwords in the Support admin interface. - Service zendesk_sunshine: Zendesk API tokens are auto-generated passwords in the Support admin interface.
apiType String
apiUrl String: Field usage depends on service value: - Service braze: Your Braze API URL.
apiUrlRegion String: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP API URL region.
apiUsage String: Field usage depends on service value: - Service zendesk: Maximum Zendesk Api Usage allowed
apiUserIdentifier String: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user identifier.
apiUserSecret String: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user secret.
apiUtilizationPercentage String: Field usage depends on service value: - Service kustomer: Api Utilization Percentage
apiVersion String: Field usage depends on service value: - Service pardot: API Version
appId String: Field usage depends on service value: - Service churnkey: Your Churnkey APP ID. - Service open_exchange_rates: Your Open Exchange Rates App Id. - Service rokt: Your Rokt app ID.
appIds List<String>: Field usage depends on service value: - Service pendo: Specific App IDs to sync. Must be populated if sync_mode is set to SpecificAppIds.
appIdsAppsflyers List<GetConnectorConfigAppIdsAppsflyer>: Field usage depends on service value: - Service appsflyer: * App ID(s)
appKey String: Field usage depends on service value: - Service loopio: Your Loopio App Key. - Service servicetitan: Your ServiceTitan app key. - Service yotpo: Your Yotpo App Key
appReference String: Field usage depends on service value: - Service brightpearl: Your Brightpearl app reference.
appSecret String: Field usage depends on service value: - Service rokt: Your Rokt app secret.
appSecretToken String
appSpecificPassword String: Field usage depends on service value: - Service itunes_connect: Your app-specific password
appSyncMode String: Field usage depends on service value: - Service itunes_connect: Whether to sync all apps or specific apps.
appendFileOption String: Field usage depends on service value: - Service aws_cost_report: If you know that the source completely overwrites the same file with new data, you can append the changes instead of upserting based on filename and line number. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
applicationId String: Field usage depends on service value: - Service algolia: Your Algolia application ID. - Service xactly: Your Xactly Application ID.
applicationKey String: Field usage depends on service value: - Service cin7core: Your Cin7 Core application key. - Service datadog: Your Datadog application key. - Service dear: Your Dear Application key. - Service partnerize: Your Partnerize user application key.
apps List<String>: Field usage depends on service value: - Service itunes_connect: Specific apps to sync. Must be populated if app_sync_mode is set to SpecificApps.
archiveLogFormat String: Field usage depends on service value: - Service sql_server_hva: Format for archive log file names - Service sql_server_sap_ecc_hva: Format for archive log file names
archiveLogPath String: Field usage depends on service value: - Service sql_server_hva: Directory where archive logs are located - Service sql_server_sap_ecc_hva: Directory where archive logs are located
archivePattern String: Field usage depends on service value: - Service aws_cost_report: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service azure_blob_storage: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service box: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service dropbox: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service email: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service ftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service gcs: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service google_drive: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service kinesis: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service s3: Files inside compressed archives with filenames matching this regular expression will be synced. - Service sftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service share_point: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service wasabi_cloud_storage: Files inside compressed archives with filenames matching this regular expression will be synced.
areSoapCredentialsProvided Boolean: Field usage depends on service value: - Service marketo: Marketo SOAP credentials provided.
asbIp String: Field usage depends on service value: - Service azure_service_bus: The IP address (or) the URL of ASB namespace
asmOption Boolean: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using ASM on a non-RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you are using ASM on a non-RAC instance.
asmOracleHome String: Field usage depends on service value: - Service oracle_hva: ASM Oracle Home path. - Service oracle_sap_hva: The Oracle ASM home directory.
asmPassword String: Field usage depends on service value: - Service oracle_hva: ASM password. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user's password. Mandatory if use_oracle_rac or asm_option is set to true.
asmTns String: Field usage depends on service value: - Service oracle_hva: ASM TNS. - Service oracle_sap_hva: ASM TNS.
asmUser String: Field usage depends on service value: - Service oracle_hva: ASM user. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user. Mandatory if use_oracle_rac or asm_option is set to true.
attributionWindow String: Field usage depends on service value: - Service amazon_ads: Time period used to attribute conversions based on clicks.
attributionWindowSize String: Field usage depends on service value: - Service tiktok_ads: Rollback sync duration to capture conversions. Set this to your configured attribution window in TikTok Ads. The default value is 7 days.
audience String: Field usage depends on service value: - Service auth0: Your Auth0 API audience.
auth String: Field usage depends on service value: - Service databricks_db: Token-based authentication type - Service redshift_db: Password-based authentication type - Service snowflake_db: Password-based or key-based authentication type
authCode String: Field usage depends on service value: - Service happyfox: Your HappyFox auth code.
authEnvironment String: Field usage depends on service value: - Service younium: Your Younium auth environment.
authMethod String: Field usage depends on service value: - Service aurora_postgres: Database authentication method - Service azure_postgres: Database authentication method - Service azure_sql_db: Authentication Method. - Service azure_sql_managed_db: Authentication Method. - Service google_cloud_postgresql: Database authentication method - Service heroku_postgres: Database authentication method - Service postgres: Database authentication method - Service postgres_rds: Database authentication method - Service sql_server_hva: Authentication Method - Service sql_server_sap_ecc_hva: Authentication Method - Service webhooks: The authentication mechanism you want to use
authMode String: Field usage depends on service value: - Service anaplan: The Anaplan authentication method. - Service concur: The Authentication Mode used by SAP Concur. It can be PasswordGrant or CompanyLevel auth mode - Service github: Authorization type.
authToken String: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback auth token.
authType String: Field usage depends on service value: - Service airtable: Type of authentication being used by connector - Service aws_cost_report: Access approach - Service azure_service_bus: The authentication mode to access the topic - Service dynamics_365: Authentication mechanism. Either one of OAUTH2, or SERVICE_PRINCIPAL. Default value OAUTH2 - Service gcs: Authorization type. Required for storage bucket authentication. - Service google_sheets: The OAuth value must be specified for this type of authorization. - Service jira: Authorization type. - Service mixpanel: Authentication Method - Service pardot: Authenticate using OAuth or HTTP Basic - Service qualtrics: Type of authentication being used by connector - Service s3: Access approach - Service wasabi_cloud_storage: The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: ACCESS_KEY.
authUrlRegion String: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP auth grant URL region.
authenticationMethod String: Field usage depends on service value: - Service adobe_analytics: Authentication Method - Service elastic_cloud: The authentication method used to connect to your cluster. - Service es_self_hosted: The authentication method used to connect to your cluster. - Service opendistro: The authentication method used to connect to your cluster. - Service opensearch: The authentication method used to connect to your cluster. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud authentication method. - Service salesforce: (Optional) Authentication type (default value = STANDARD) - Service salesforce_sandbox: (Optional) Authentication type (default value = STANDARD)
authorizationMethod String
awsRegionCode String: Field usage depends on service value: - Service dynamodb: The AWS region code for the DynamoDB instance, e.g. us-east-1.
backintConfigurationPath String
backintExecutablePath String
backwardSyncLimit String: Field usage depends on service value: - Service zendesk: Limit of the Historical Sync Time for selected tables
baseCurrency String: Field usage depends on service value: - Service open_exchange_rates: Your Open Exchange Rates Base Currency.
baseDomain String: Field usage depends on service value: - Service freshteam: Your company's Freshteam base domain name (usually company.freshteam.com).
baseId String: Field usage depends on service value: - Service airtable: ID of base in Airtable
baseUrl String: Field usage depends on service value: - Service aha: Your Aha! subdomain. - Service akeneo: Your Akeneo base URL. - Service billing_platform: Your BillingPlatform subdomain. - Service boostr: Your Boostr base URL. - Service brex: Your Brex Base URL - Service centra: Your Centra base URL. - Service cornerstone: Your Cornerstone base URL. - Service culture_amp: Your Culture Amp base URL. - Service datadog: Your Datadog base url. - Service factbird: Your Factbird base url. - Service fillout: Your Fillout Base URL. - Service financial_force: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service freshsales: Your Freshsales product. - Service gongio: Your Gong API Base URL. - Service ironclad: Your Ironclad base url. - Service jotform: Your Jotform base URL. - Service mailgun: Your Mailgun base URL. - Service nice: Your NICE base URL. - Service ortto: Your Ortto base URL. Possible values: api, api.au, api.eu. - Service prisma_cloud: Your Prisma Cloud admin console URL. - Service salesforce: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service salesforce_sandbox: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service stickyio: Your sticky.io base URL . - Service veevavault: Your Veeva Vault base URL. - Service vitally: Your Vitally base URL.
bearerToken String: Field usage depends on service value: - Service ada: Your Ada API Access Token. - Service crowddev: Your crowd.dev Auth Token. - Service customerio: Your Customer.io App API Key. - Service freshchat: Your Freshchat API Token. - Service hopin: Your Hopin API key. - Service orbit: Your Orbit API Token. - Service productboard: Your Productboard API key. - Service smarthr: Your SmartHR access token. - Service sprout: Your Sprout Social API Access Token. - Service zenefits: Your Zenefits bearer token.
blobSasUrl String: Field usage depends on service value: - Service webhooks: The blob SAS URL of your Azure container. Required if bucket_service is set to AZURE.
blockchain String: Field usage depends on service value: - Service rarible: Your Rarible Blockchain.
brandId String: Field usage depends on service value: - Service oracle_moat_analytics: Your Oracle Moat Analytics Brand ID.
breakdowns List<String>: Field usage depends on service value: - Service facebook: List of breakdowns which connector will sync. Possible breakdowns values.
bucket String: Field usage depends on service value: - Service appsflyer: Customer S3 Bucket - Service aws_cloudtrail: The AWS bucket name which is configured for AWS CloudTrail. - Service aws_cost_report: The S3 bucket name with the AWS Cost and Usage Report - Service aws_inventory: The AWS bucket name that is configured for AWS Config. - Service aws_lambda: S3 Bucket - Service cloudfront: The bucket name for CloudFront. - Service gcs: The name of the GCS bucket. - Service google_play: The Google Cloud Storage source bucket. - Service heap: The S3 bucket name. - Service kinesis: The name of the Kinesis bucket. - Service s3: The S3 bucket name. Required for connector creation. - Service segment: The name of the Segment bucket. Must be populated if sync_type is set to S3. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket name. Required for connector creation.
bucketName String: Field usage depends on service value: - Service adjust: Your AWS S3 or GCS bucket. - Service google_analytics_360: The name of the bucket. - Service google_analytics_4_export: The name of the bucket.
bucketService String: Field usage depends on service value: - Service webhooks: Whether to store the events in Fivetran's container service or your S3 bucket. Default value: Fivetran.
businessAccounts List<String>: Field usage depends on service value: - Service reddit_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
businessId String: Field usage depends on service value: - Service birdeye: Your Birdeye Business ID.
businessUnit String: Field usage depends on service value: - Service deposco: Your Deposco business unit.
businessUnitId String: Field usage depends on service value: - Service pardot: Business Unit Id
catalog String: Field usage depends on service value: - Service databricks_db: catalog to sync
certificate String: Field usage depends on service value: - Service anaplan: The contents of your PEM certificate file. Must be populated if auth_mode is set to Certificate. - Service qualtrics: Your Client Certificate - Service salesforce: Provide content of the .pem certificate (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .pem certificate (only when authentication_method = ADVANCED).
clickAttributionWindow String: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on clicks. Possible click_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'click' action.
client String
clientCert String: Field usage depends on service value: - Service apache_kafka: Kafka client certificate. - Service heroku_kafka: Heroku Kafka client certificate. Required for TLS security protocol.
clientCertKey String: Field usage depends on service value: - Service apache_kafka: Kafka client certificate key. - Service heroku_kafka: Heroku Kafka client certificate key. Required for TLS security protocol.
clientHost String: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Host.
clientId String: Field usage depends on service value: - Service acumatica: Your Acumatica client ID. - Service adobe_analytics: Client ID from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client ID. - Service adp_workforce_now: Your ADP Client ID. - Service akamai: Your Akamai client ID. - Service akeneo: Your Akeneo client ID. - Service auth0: Your Auth0 client ID. - Service autodesk_bim_360: Your Autodesk BIM 360 client ID. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Id - Service billing_platform: Your BillingPlatform client ID. - Service bing_webmaster_tools: Your Bing Webmaster Tools client ID. - Service brightcove: Your Brightcove client ID. - Service brightpearl: Your Brightpearl client ID. - Service buildium: Your Buildium API client ID. - Service canvas_by_instructure: Your Canvas by Instructure client ID. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure client ID. - Service castor_edc: Your Castor EDC client Id. - Service clazar: Your Clazar client ID. - Service cloudbeds: Your Cloudbeds client ID. - Service commercetools: Your commercetools client ID. - Service concur: The SAP Concur Client ID. - Service constant_contact: Your Constant Contact client ID. - Service cornerstone: Your Cornerstone client ID. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo Client ID. - Service criteo_retail_media: Your Criteo Retail Media client ID. - Service culture_amp: Your Culture Amp client ID. - Service cvent: Your Cvent client ID. - Service d2l_brightspace: Your D2L Brightspace client ID. - Service dialpad: Your Dialpad client ID. - Service ebay: Your eBay app ID. - Service exact_online: Your Exact Online client ID. - Service fillout: Your Fillout client ID. - Service flexport: The Flexport API Key. - Service formstack: Your Formstack client ID. - Service genesys: Your Genesys client ID. - Service hana_sap_hva_ecc_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hana_sap_hva_s4_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hilti_ontrack: Your Hilti On!Track client ID. - Service ilevel: Your iLevel Client ID. - Service instructure: Your Instructure client ID. - Service integral_ad_science: Your integral_ad_science client id. - Service ironclad: Your Ironclad client ID. - Service jama_software: Your Jama Software client ID. - Service jibble: Your Jibble client ID. - Service khoros_communities: Your Khoros Communities client ID. - Service looker_source: Your Looker Client ID. - Service marketo: Marketo REST API Client Id. - Service medallia: Medallia Client ID - Service microsoft_entra_id: Your Microsoft Entra ID Client ID. - Service microsoft_power_bi: Your Microsoft Power BI client ID. - Service microsoft_teams: Your Microsoft Teams Client ID. - Service navan: Your Navan client ID. - Service nice: Your NICE client ID. - Service on24: Your ON24 client ID. - Service oracle_sap_hva_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service paychex: Your Paychex client ID. - Service paypal: Client ID of your PayPal client application. - Service paypal_sandbox: Client ID of your PayPal client application. - Service personio: Your Personio Client ID. - Service piwik_pro: Your Piwik PRO client ID. - Service podio: Your Podio client ID. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client ID. - Service prisma_cloud: Your Prisma Cloud access key ID. - Service procore: Your Procore client ID. - Service quora_ads: Your Quora Ads client ID. - Service reltio: Your Reltio client ID. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client ID. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client ID. - Service salesloft: Client ID of your Salesloft client application. - Service sana: Your Sana client ID. - Service sap_success_factors: Your SAP SuccessFactors Client ID. - Service servicenow: ServiceNow Client ID. - Service servicetitan: Your ServiceTitan client ID. - Service sharetribe: Your Sharetribe client ID. - Service shipnetwork: Your ShipNetwork client ID. - Service sigma_computing_source: Your Sigma Computing client ID. - Service skillstx: Your SkillsTX client ID. - Service skimlinks: Your Skimlinks client ID. - Service smartrecruiters: Your SmartRecruiters client ID. - Service splash: Your Splash client ID. - Service square: The Application ID of your organization. - Service standard_metrics: Your Standard Metrics Client ID. - Service sugarcrm: Your SugarCRM client ID. - Service swoogo: Your Swoogo client Id. - Service taboola: The Taboola client ID. - Service talkdesk: The Client ID of your OAuth Client - Service tive: Your Tive client ID. - Service toast: Your Toast client ID. - Service trelica: Your Trelica client ID. - Service tremendous: Your Tremendous client ID. - Service tymeshift: Your Tymeshift email. - Service udemy_business: Your Udemy Business client ID. - Service vimeo: Your Vimeo client ID. - Service visma: Your Visma client ID. - Service vonage_contact_center: Your Vonage Contact Center client ID. - Service walmart_marketplace: Your Walmart Marketplace client ID. - Service xero: your clientId - Service xray: Your Xray Client ID. - Service yougov_sport: Your Yougov Sport client ID. - Service zendesk_chat: Your Zendesk client ID. - Service zoho_books: Your Zoho Books Client ID. - Service zoho_campaigns: Your Zoho Campaigns Client ID. - Service zoho_desk: Your Zoho Desk Client Id. - Service zoho_inventory: Your Zoho Inventory client ID. - Service zuora: Zuora Client ID. - Service zuora_sandbox: Zuora Client ID.
clientKey String: Field usage depends on service value: - Service appfigures: Your Appfigures Client Key. - Service thinkific: Your Thinkific client key. - Service yougov_sport: Your Yougov Sport client key.
clientName String: Field usage depends on service value: - Service destini: Your Destini Client Name. - Service medallia: Medallia company name
clientNamespace String: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Namespace.
clientPrivateKey String: Field usage depends on service value: - Service aurora_postgres: Client Private Key in .pem format. - Service azure_postgres: Client Private Key in .pem format. - Service google_cloud_postgresql: Client Private Key in .pem format. - Service heroku_postgres: Client Private Key in .pem format. - Service postgres: Client Private Key in .pem format. - Service postgres_rds: Client Private Key in .pem format.
clientPublicCertificate String: Field usage depends on service value: - Service aurora_postgres: Client Certificate in .pem format. - Service azure_postgres: Client Certificate in .pem format. - Service google_cloud_postgresql: Client Certificate in .pem format. - Service heroku_postgres: Client Certificate in .pem format. - Service postgres: Client Certificate in .pem format. - Service postgres_rds: Client Certificate in .pem format.
clientSecret String: Field usage depends on service value: - Service acumatica: Your Acumatica client secret. - Service adobe_analytics: Client Secret from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client secret. - Service adp_workforce_now: Your ADP Client Secret. - Service akamai: Your Akamai client secret. - Service akeneo: Your Akeneo client secret. - Service auth0: Your Auth0 client secret. - Service autodesk_bim_360: Your Autodesk BIM 360 client secret. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Secret - Service billing_platform: Your BillingPlatform client secret. - Service bing_webmaster_tools: Your Bing Webmaster Tools client secret. - Service brightcove: Your Brightcove client secret. - Service brightpearl: Your Brightpearl client secret. - Service canvas_by_instructure: Your Canvas by Instructure client secret. - Service castor_edc: Your Castor EDC Client Secret. - Service clazar: Your Clazar client secret. - Service cloudbeds: Your Cloudbeds client secret. - Service commercetools: Your commercetools client secret. - Service concur: The SAP Concur Client secret. - Service constant_contact: Your Constant Contact client secret. - Service cornerstone: Your Cornerstone client secret. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo client secret key. - Service criteo_retail_media: Your Criteo Retail Media client secret. - Service culture_amp: Your Culture Amp client secret. - Service cvent: Your Cvent client secret. - Service d2l_brightspace: Your D2L Brightspace client secret. - Service dialpad: Your Dialpad client secret. - Service ebay: Your eBay cert ID. - Service exact_online: Your Exact Online client secret. - Service fillout: Your Fillout client secret - Service flexport: The Flexport API Secret. - Service formstack: Your Formstack client secret. - Service genesys: Your Genesys client secret. - Service hilti_ontrack: Your Hilti On!Track client secret. - Service ilevel: Your iLevel Client Secret. - Service instructure: Your Instructure client secret. - Service integral_ad_science: Your integral_ad_science client secret. - Service ironclad: Your Ironclad client secret. - Service jama_software: Your Jama Software client secret. - Service jibble: Your Jibble client secret. - Service looker_source: Your Looker Client Secret. - Service marketo: Marketo REST API Client Secret. - Service medallia: Medallia Client Secret key - Service microsoft_entra_id: Your Microsoft Entra ID Client Secret. - Service microsoft_power_bi: Your Microsoft Power BI client secret. - Service microsoft_teams: Your Microsoft Teams Client Secret. - Service navan: Your Navan client secret. - Service nice: Your NICE client secret. - Service paychex: Your Paychex client secret. - Service personio: Your Personio secret. - Service piwik_pro: Your Piwik PRO client secret. - Service podio: Your Podio client secret. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client Secret. - Service prisma_cloud: Your Prisma Cloud secret access Key. - Service procore: Your Procore client secret. - Service quora_ads: Your Quora Ads client secret. - Service reltio: Your Reltio client secret. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client secret. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client secret. - Service salesloft: Client Secret of your Salesloft client application. - Service sana: Your Sana client secret. - Service sap_success_factors: Your SAP SuccessFactors Client Secret that you generated through SAML Assertion. - Service servicenow: ServiceNow Client Secret. - Service servicetitan: Your ServiceTitan secret key. - Service sharetribe: Your Sharetribe client secret. - Service sigma_computing_source: Your Sigma Computing client secret. - Service skillstx: Your SkillsTX client secret. - Service skimlinks: Your Skimlinks client secret. - Service smartrecruiters: Your SmartRecruiters client secret. - Service splash: Your Splash client secret. - Service square: The Application Secret of your organization. - Service standard_metrics: Your Standard Metrics Client secret. - Service sugarcrm: Your SugarCRM client secret. - Service swoogo: Your Swoogo Client Secret. - Service taboola: The Taboola client secret. - Service talkdesk: The Client Secret of your OAuth Client - Service thinkific: Your Thinkific client secret. - Service tive: Your Tive client secret. - Service toast: Your Toast client secret. - Service trelica: Your Trelica client secret. - Service tremendous: Your Tremendous client secret. - Service tymeshift: Your Tymeshift password. - Service udemy_business: Your Udemy Business client secret. - Service vimeo: Your Vimeo client secret. - Service visma: Your Visma client secret. - Service vonage_contact_center: Your Vonage Contact Center client secret. - Service walmart_marketplace: Your Walmart Marketplace client secret. - Service xero: your clientSecret - Service xray: Your Xray Client Secret. - Service zendesk_chat: Your Zendesk client secret. - Service zoho_books: Your Zoho Books Client Secret. - Service zoho_campaigns: Your Zoho Campaigns Client Secret. - Service zoho_desk: Your Zoho Desk Client secret. - Service zoho_inventory: Your Zoho Inventory client secret. - Service zuora: Zuora Client Secret. - Service zuora_sandbox: Zuora Client Secret.
cloudStorageType String: Field usage depends on service value: - Service braze: Cloud storage type Braze Current is connected to.
collectionAddress String: Field usage depends on service value: - Service rarible: Your Rarible Collection Address.
columns List<String>: Field usage depends on service value: - Service double_click_publishers: Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.
communityDomain String: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community domain.
communityId String: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community ID.
companies List<String>: Field usage depends on service value: - Service business_central: List of companies to sync
company String: Field usage depends on service value: - Service ordway: Your Ordway company name.
companyId String: Field usage depends on service value: - Service 360learning: Your 360Learning Company ID. - Service sage_intacct: Company ID - Service sap_success_factors: Your SAP SuccessFactors Company ID.
companyIds String: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail company IDs.
companyKey String: Field usage depends on service value: - Service khoros_care: Your Khoros Care companyKey. - Service upland: Your Upland Software Company Key.
companyName String: Field usage depends on service value: - Service clockodo: Your Clockodo company name.
companyRequestToken String: Field usage depends on service value: - Service concur: The SAP Concur Company Request Token
companyUuid String: Field usage depends on service value: - Service concur: The SAP Concur Company UUID
compression String: Field usage depends on service value: - Service aws_cost_report: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service azure_blob_storage: The secrets that should be passed to the function at runtime. - Service box: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service dropbox: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service email: The secrets that should be passed to the function at runtime. - Service ftp: The secrets that should be passed to the function at runtime. - Service gcs: The secrets that should be passed to the function at runtime. - Service google_drive: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service kinesis: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service s3: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service sftp: The secrets that should be passed to the function at runtime. - Service share_point: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service wasabi_cloud_storage: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
configMethod String: Field usage depends on service value: - Service google_display_and_video_360: The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is CREATE_NEW.
configRepositoryUrl String: Field usage depends on service value: - Service snowplow: Public repository URL containing JSON configuration files.
configType String: Field usage depends on service value: - Service facebook: Option to select Prebuilt Reports or Custom Reports. Possible config_type values. - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports.
connectPassword String: Field usage depends on service value: - Service xactly: Your Xactly Connect password.
connectUsername String: Field usage depends on service value: - Service xactly: Your Xactly Connect username.
connectingUser String
connectingUserEmail String
connectionMethod String: Field usage depends on service value: - Service aws_msk: How Fivetran connects to your message brokers in the cluster - Service azure_blob_storage: Connection Method. Possible values: 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. - Service azure_function: Connection Method. Possible values: DIRECT: Fivetran will connect directly to your function, PRIVATE_LINK: Fivetran will connect to your storage container using PrivateLink. - Service azure_service_bus: The connection method - Service sftp: The connection method used to connect to SFTP Server.
connectionName String: Field usage depends on service value: - Service appsflyer: Your Data Locker Connection Name. Default value: `data-locker-hourly/
connectionString String: Field usage depends on service value: - Service azure_blob_storage: The blob storage container connection string. - Service azure_event_hub: Connection string of the Event Hub Namespace you want to sync. - Service azure_service_bus: The connection string used for authentication. Required if the authentication type is ConnectionString - Service microsoft_dynamics_365_fno: The blob storage container's connection string. - Service microsoft_dynamics_365_fo: The blob storage container connection string.
connectionType String: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service aws_cost_report: Connection method. Default value: Directly. - Service aws_lambda: Connection method. Default value: Directly. - Service azure_blob_storage: Connection method. Default value: Directly. - Service azure_cosmos_for_mongo: Possible values:Directly, PrivateLink. Directly is the default value - Service azure_postgres: 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. - Service azure_sql_db: 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. - Service azure_sql_managed_db: 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. - Service bigquery_db: Direct or PrivateLink connection - Service clarity: 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. - Service cockroachdb: Possible values:Directly, 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. - Service db2i_hva: Possible values:SshTunnel. SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service db2i_sap_hva: 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. - Service documentdb: Possible values:SshTunnel, PrivateLink . SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service dynamics_365_fo: 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. - Service ehr: 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. - Service elastic_cloud: Possible values:Directly, 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. - Service email: Connection method. Default value: Directly. - Service es_self_hosted: Possible values:Directly, 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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service heroku_postgres: 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. - Service kinesis: Connection method. Default value: Directly. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mongo: 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. - Service mongo_sharded: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service opendistro: Possible values:Directly, 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. - Service opensearch: Possible values:Directly, 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Directly or Private Link - Service s3: Connection method. Default value: Directly. - Service sap_hana: 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. - Service sap_s4hana: Connection Method - Service snowflake_db: Directly or Private Link - Service sql_server: 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. - Service sql_server_hva: 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. - Service sql_server_rds: 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. - Service sql_server_sap_ecc_hva: 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.
consoleUrl String: Field usage depends on service value: - Service prisma_cloud: Your Prisma Cloud console URL.
consumerGroup String: Field usage depends on service value: - Service apache_kafka: Kafka consumer group name. - Service aws_msk: The name of consumer group created for Fivetran. - Service azure_event_hub: Name of consumer group created for Fivetran. - Service confluent_cloud: Confluent Cloud consumer group name. - Service heroku_kafka: Heroku Kafka consumer group name.
consumerKey String: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Key - Service twitter: API Key of your app - Service twitter_ads: The Twitter App consumer key. - Service woocommerce: Your WooCommerce Consumer key.
consumerName String: Field usage depends on service value: - Service xactly: Your Xactly Connect consumer name.
consumerSecret String: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Secret - Service twitter: API Secret of your app - Service twitter_ads: The Twitter App consumer secret. - Service woocommerce: Your WooCommerce Consumer secret.
containerAddress String: Field usage depends on service value: - Service azure_blob_storage: IP address of the Azure Storage Container which is accessible from host machine.
containerName String: Field usage depends on service value: - Service azure_blob_storage: The name of the blob container. - Service microsoft_dynamics_365_fno: The name of the blob container. - Service microsoft_dynamics_365_fo: The name of the blob container.
contentOwnerId String: Field usage depends on service value: - Service youtube_analytics: Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.
contractVersion String: Field usage depends on service value: - Service acumatica: Your Acumatica contract version.
conversationWebhookUrl String: Field usage depends on service value: - Service helpscout: Your conversation webhook URL
conversionDimensions List<String>: Field usage depends on service value: - Service double_click_campaign_manager: Conversion Dimensions.
conversionReportTime String: Field usage depends on service value: - Service pinterest_ads: The date that the user interacted with the ad OR completed a conversion event.
conversionWindowSize Double: Field usage depends on service value: - Service google_ads: A period of time in days during which a conversion is recorded.
convertDatsTypeToDate Boolean
csvDefinition String: Field usage depends on service value: - Service adjust: CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition).
currency String: Field usage depends on service value: - Service criteo: Currency - Service rokt: Your Rokt currency.
customBaseUrl String: Field usage depends on service value: - Service datadog: Your Datadog custom base url. - Service deposco: Your Deposco custom base URL.
customEventSyncMode String: Field usage depends on service value: - Service iterable: Custom Events Sync Mode.
customEvents List<String>: Field usage depends on service value: - Service iterable: List of custom events to sync. Should be specified when custom_event_sync_mode is SelectedEvents
customFieldIds List<String>: Field usage depends on service value: - Service double_click_publishers: The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.
customFloodlightVariables List<String>: Field usage depends on service value: - Service double_click_campaign_manager: Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.
customPayloads List<GetConnectorConfigCustomPayload>: Field usage depends on service value: - Service aws_lambda: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service azure_function: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service google_cloud_function: The list of key-value pairs that can be used to specify custom information to the function at runtime.
customReports List<GetConnectorConfigCustomReport>: Field usage depends on service value: - Service reddit_ads: The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data. - Service snapchat_ads: Custom reports for Snapchat Ads connector. - Service tiktok_ads: Title of Custom Report
customTables List<GetConnectorConfigCustomTable>: Field usage depends on service value: - Service facebook_ads: List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data.
customUrl String: Field usage depends on service value: - Service dbt_cloud: Your dbt Cloud access url. - Service factbird: Your Factbird custom base url. - Service jotform: Your Jotform custom base URL.
customerApiKey String: Field usage depends on service value: - Service ukg_pro: Your UKG Pro Customer API key.
customerId String: Field usage depends on service value: - Service google_ads: ID of the customer, can be retrieved from your AdWords dashboard.
customerListId String: Field usage depends on service value: - Service salesforce_commerce_cloud: The parameter to retrieve customer details.
dailyApiCallLimit Double
dataAccessMethod String: Field usage depends on service value: - Service cosmos: The source data access method. Supported values:ACCOUNT_KEY- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.RESOURCE_TOKEN- Fine-grained permission model based on native Azure Cosmos DB users and permissions. Learn more in our Azure Cosmos DB Data Access Methods documentation.
dataCenter String: Field usage depends on service value: - Service brightpearl: Your Brightpearl data center. - Service qualtrics: 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.) - Service zoho_crm: Data Center, depending on the Domain name
dataCenterId String: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback data center ID.
dataSetName String: Field usage depends on service value: - Service bigquery_db: Data set name
database String: Field usage depends on service value: - Service aurora: The database name. - Service aurora_postgres: The database name. - Service azure_cosmos_for_mongo: Authentication database for the source. Usually 'admin'. - Service azure_postgres: The database name. - Service azure_sql_db: The database name. - Service azure_sql_managed_db: The database name. - Service clarity: The database name. - Service cockroachdb: The database name. - Service db2i_hva: The database name. - Service db2i_sap_hva: The database name. - Service dynamics_365_fo: The database name. - Service ehr: The database name. - Service google_cloud_mysql: The database name. - Service google_cloud_postgresql: The database name. - Service google_cloud_sqlserver: The database name. - Service hana_sap_hva_b1: The Hana database name. - Service hana_sap_hva_ecc: The Hana database name. - Service hana_sap_hva_ecc_netweaver: The Hana database name. - Service hana_sap_hva_s4: The Hana database name. - Service hana_sap_hva_s4_netweaver: The Hana database name. - Service heroku_postgres: The database name. - Service magento_mysql: The database name. - Service magento_mysql_rds: The database name. - Service maria: The database name. - Service maria_azure: The database name. - Service maria_rds: The database name. - Service mysql: The database name. - Service mysql_azure: The database name. - Service mysql_rds: The database name. - Service oracle: The database name. - Service oracle_ebs: The database name. - Service oracle_hva: The database name. - Service oracle_rac: The database name. - Service oracle_rds: The database name. - Service oracle_sap_hva: The database name. - Service postgres: The database name. - Service postgres_rds: The database name. - Service redshift_db: The database name: Redshift - Service sap_hana: The database name. - Service sap_s4hana: The database name. - Service snowflake_db: The database name: Snowflake - Service sql_server: The database name. - Service sql_server_hva: The database name. - Service sql_server_rds: The database name. - Service sql_server_sap_ecc_hva: The database name.
databaseName String: Field usage depends on service value: - Service firebase: Database Name
datasetId String: Field usage depends on service value: - Service google_analytics_360: The dataset ID. - Service google_analytics_4_export: The Dataset ID.
datasource String: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite data source value: NetSuite.com.
dateGranularity String: Field usage depends on service value: - Service adobe_analytics: The aggregation duration you want. Default value: HOUR .
db String: Field usage depends on service value: - Service myosh: Your Myosh Server variables/db .
delimiter String: Field usage depends on service value: - Service aws_cost_report: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service azure_blob_storage: 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. - Service box: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service dropbox: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service kinesis: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service s3: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service sftp: 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. - Service share_point: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service wasabi_cloud_storage: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
developerReference String: Field usage depends on service value: - Service brightpearl: Your Brightpearl dev reference.
dimensionAttributes List<String>: Field usage depends on service value: - Service double_click_publishers: Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions.
dimensions List<String>: Field usage depends on service value: - Service adroll: The dimenstions that you want to sync. - Service double_click_campaign_manager: 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 - Service double_click_publishers: Report dimensions to include in the sync. The date dimension is mandatory for all the report types. - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_display_and_video_360: 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.
directCaptureMethod String: Field usage depends on service value: - Service oracle_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY - Service oracle_sap_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY
distributedConnectorClusterSize Double: Field usage depends on service value: - Service cosmos: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel. - Service dynamodb: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel.
domain String: Field usage depends on service value: - Service auth0: Your Auth0 domain. - Service bubble: Your Bubble app name or domain name. - Service confluence: Your Confluence domain. - Service kustomer: Domain is the beginning of your kustomer URL going before .kustomerapp.com, e.g. for yourcompany.kustomerapp.com the domain name is yourcompany - Service okta: Your Okta domain. - Service pipedrive: Your Pipedrive domain. - Service shopware: Your Shopware domain. - Service sistrix: Your SISTRIX domain. - Service solarwinds_service_desk: Your SolarWinds Service Desk domain. - Service uservoice: Domain of your UserVoice site. If it ends with ".uservoice.com", you can specify just the subdomain ("mydomain.uservoice.com" - "mydomain") - Service zendesk: Zendesk domain. - Service zendesk_sunshine: Zendesk domain.
domainHostName String: Field usage depends on service value: - Service workday: Workday host name. - Service workday_financial_management: Workday host name. - Service workday_hcm: Workday host name.
domainName String: Field usage depends on service value: - Service calabrio: Your Calabrio domain name - Service dynamics_365: The custom domain name associated with Dynamics 365. - Service helpshift: Your Helpshift domain name.
domainType String: Field usage depends on service value: - Service medallia: Domain type of your Medallia URL
dsvServiceAuth String
dsvSubscriptionKey String
ecommerceStores List<String>: Field usage depends on service value: - Service mailchimp: List of IDs of the Mailchimp E-Commerce Stores to Sync
edition String
elements List<String>
email String: Field usage depends on service value: - Service appcues: Your Appcues Email. - Service boostr: Your Boostr email. - Service copper: Your Copper email address. - Service email: Send your emails to this address. - Service moloco: Your Moloco account email. - Service netsuite_suiteanalytics: The NetSuite user's email address. - Service pardot: The email of the Pardot user. - Service skuvault: Your SkuVault email. - Service smadex: Your Smadex account's email ID. - Service zendesk: Zendesk email. - Service zendesk_sunshine: Zendesk email.
emailAddress String: Field usage depends on service value: - Service clockodo: Your Clockodo email address.
emailId String: Field usage depends on service value: - Service ordway: Your Ordway user email ID. - Service planful: Your Planful email ID.
emptyHeader Boolean: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service azure_blob_storage: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service box: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service dropbox: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service email: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service ftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service gcs: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service google_drive: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service kinesis: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service s3: 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. - Service sftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service share_point: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service wasabi_cloud_storage: 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.
enableAllDimensionCombinations Boolean: Field usage depends on service value: - Service double_click_campaign_manager: Whether to enable all reach dimension combinations in the report. Default value: false
enableArchiveLogOnly Boolean: Field usage depends on service value: - Service sql_server_hva: Use archive log only mode - Service sql_server_sap_ecc_hva: Use archive log only mode
enableDataExtensionsSyncing Boolean
enableDistributedConnectorMode Boolean: Field usage depends on service value: - Service cosmos: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors. - Service dynamodb: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors.
enableEnrichments Boolean: Field usage depends on service value: - Service snowplow: Enable Enrichments
enableExports Boolean: Field usage depends on service value: - Service braze: Enable User Profile Exports
enableTde Boolean: Field usage depends on service value: - Service sql_server_hva: Using Transparent Data Encryption (TDE) - Service sql_server_sap_ecc_hva: Using Transparent Data Encryption (TDE)
encodedPublicKey String: Field usage depends on service value: - Service apple_search_ads: Use the public key to grant Fivetran access to Apple Search Ads api.
encryptionKey String: Field usage depends on service value: - Service marketo: Marketo SOAP API Encryption Key.
endpoint String: Field usage depends on service value: - Service branch: Webhook Endpoint - Service iterable: Register the following URL for webhooks on your Iterable dashboard. - Service marketo: Marketo REST API endpoint. - Service snowplow: Connection-specific collector endpoint. The collector endpoint will have the webhooks.fivetran.com/snowplow/endpoint_ID format. You will need it to configure Snowplow to connect with Fivetran. - Service webhooks: You can send your events to https://webhooks.fivetran.com/webhooks/{endpoint}
engagementAttributionWindow String: Field usage depends on service value: - Service pinterest_ads: The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action.
enrichedExport String: Field usage depends on service value: - Service optimizely: Enriched Events S3 bucket
entityId String: Field usage depends on service value: - Service checkout: Your Checkout.com entity ID. - Service zuora: If is_multi_entity_feature_enabled is true, then it's EntityId. - Service zuora_sandbox: If is_multi_entity_feature_enabled is true, then it's EntityId.
environment String: Field usage depends on service value: - Service bazaarvoice: Your Bazaarvoice environment. - Service buildium: Your Buildium environment. - Service checkout: Your Checkout.com environment. - Service concord: Your Concord environment. - Service deposco: Your Deposco environment. - Service dialpad: Your Dialpad environment. - Service invoiced: Your Invoiced environment. - Service jibble: Your Jibble environment. - Service lucca: Your Lucca environment. - Service procore: Your Procore account environment. - Service reltio: Your Reltio environment. - Service servicetitan: Your ServiceTitan environment. - Service smarthr: Your SmartHR environment. - Service trelica: Your Trelica environment. - Service tremendous: Your Tremendous environment. - Service vts: Your VTS environment. - Service xactly: Your Xactly environment. - Service younium: Your Younium API environment. - Service zuora: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox. - Service zuora_sandbox: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
environmentHost String: Field usage depends on service value: - Service xactly: Your Xactly environment host.
environmentName String: Field usage depends on service value: - Service business_central: Name of the environment
escapeChar String: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service azure_blob_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service box: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service dropbox: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service email: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service ftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service gcs: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service google_drive: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service kinesis: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service s3: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service sftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service share_point: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service wasabi_cloud_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
escapeCharOptions String: Field usage depends on service value: - Service gcs: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true. - Service s3: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true.
euRegion Boolean: Field usage depends on service value: - Service kustomer: Turn it on if your app is on EU region - Service survey_monkey: The SurveyMonkey account region. Specify true, if your account is hosted in the EU region. Default value is false.
events List<String>: Field usage depends on service value: - Service iterable: List of events to sync. Should be specified when sync_mode is SelectedEvents
exportStorageType String: Field usage depends on service value: - Service adjust: Your cloud storage. - Service braze: Export Storage. Required if enable_exports is true
externalId String: Field usage depends on service value: - Service appsflyer: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_cloudtrail: This is the same as your group_id, used for authentication along with the role_arn. - Service aws_cost_report: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_lambda: The external ID is a string that designates who can assume the role. - Service aws_msk: This is the same as your group_id. This is required when sasl_mechanism is set to IAM. - Service azure_function: External ID. - Service cloudfront: This is the same as your group_id, used for authentication along with the role_arn. - Service dynamodb: This is the same as your group_id, used for authentication along with the role_arn. - Service kinesis: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service s3: Used for authentication along with the role_arn. If not provided, it uses connector's group_id. Use the List All Groups endpoint to find the group_id. - Service segment: The external ID is a string that designates who can assume the role. For more information, see a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"Amazon's AWS Identity and Access Management User Guide/a.
facilityCodes String: Field usage depends on service value: - Service unicommerce: Your uniware facility codes.
fields List<String>: Field usage depends on service value: - Service facebook: List of fields which connector will sync. Possible field values.
fileType String: Field usage depends on service value: - Service aws_cost_report: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service azure_blob_storage: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service box: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service dropbox: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service email: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service ftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service gcs: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service google_drive: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service kinesis: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service s3: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service sftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service share_point: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service wasabi_cloud_storage: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
filter String: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
financeAccountSyncMode String: Field usage depends on service value: - Service itunes_connect: Whether to sync all finance accounts or specific finance accounts.
financeAccounts List<String>: Field usage depends on service value: - Service itunes_connect: Specific finance accounts to sync. Must be populated if finance_account_sync_mode is set to SpecificFinanceAccounts.
folder String: Field usage depends on service value: - Service dropbox: Your Dropbox Folder URL.
folderId String: Field usage depends on service value: - Service box: Folder URL - Service google_drive: Folder URL
folderPath String: Field usage depends on service value: - Service adobe_analytics_data_feed: Folder Path - Service one_drive: Your OneDrive folder URL - Service oracle_business_intelligence_publisher: The folder path to save data models and reports.
forecastId String: Field usage depends on service value: - Service clari: Your Clari Forecast id .
ftpHost String: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP host.
ftpPassword String: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP password.
ftpPort Double: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP port.
ftpUser String: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP user.
function String: Field usage depends on service value: - Service aws_lambda: The name of your AWS Lambda Function.
functionApp String: Field usage depends on service value: - Service azure_function: Function app name in Azure portal.
functionKey String: Field usage depends on service value: - Service azure_function: Function key used for authorization.
functionName String: Field usage depends on service value: - Service azure_function: Name of the function to be triggered.
functionTrigger String: Field usage depends on service value: - Service google_cloud_function: The trigger URL of the cloud function.
gcsBucket String: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the cloud_storage_type - Service webhooks: The GCS bucket name. Required if bucket_service is set to GCS.
gcsExportBucket String: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the export_storage_type
gcsExportFolder String: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the export_storage_type
gcsFolder String: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the cloud_storage_type
generateFivetranPk Boolean: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
groupId String: Field usage depends on service value: - Service line_ads: Your LINE Ads group ID(s).
groupName String: Field usage depends on service value: - Service fivetran_log: (Optional) The group name of the target_group_id.
hanaBackupPassword String
hanaMode String: Field usage depends on service value: - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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.
hasManagePermissions Boolean: Field usage depends on service value: - Service azure_service_bus: The boolean value specifying whether the connection string has manage permissions
historicSyncTimeFrame String: Field usage depends on service value: - Service braze: Range of data in history you would like to include in the initial sync. - Service iterable: The time range for which historical data should be synced. Default value: All Time. - Service klaviyo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service marketo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service sailthru: Range of historical data you would like to include in the initial sync. Default value: ALL_TIME. - Service salesforce_marketing_cloud: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME.
historicalSyncLimit String: Field usage depends on service value: - Service concur: Historical Sync Limit for the Sync - Service eloqua: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service pardot: The time range for which historical data should be synced. Default value: All Time.
historicalSyncTimeFrame String: Field usage depends on service value: - Service rokt: Your Rokt historical sync time frame. - Service skimlinks: Your Skimlinks Historical sync time frame. - Service vimeo: Your Vimeo Historical sync time frame. - Service zendesk: Used to configure Historical sync timeframe for selected tables
homeFolder String: Field usage depends on service value: - Service appsflyer: Your S3 home folder path of the Data Locker.
host String: Field usage depends on service value: - Service aurora: DB instance host or IP address. - Service aurora_postgres: DB instance host or IP address. - Service azure_postgres: DB instance host or IP address. - Service azure_sql_db: DB instance host or IP address. - Service azure_sql_managed_db: DB instance host or IP address. - Service clarity: DB instance host or IP address. - Service cockroachdb: DB instance host or IP address. - Service commercetools: Your commercetools host. - Service databricks_db: The host URL for your Databricks account. - Service db2i_hva: A host address of the primary node. It should be a DB instance host/IP address with a port number. - Service db2i_sap_hva: DB instance host or IP address. - Service documentdb: Host IP address of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: DB instance host or IP address. - Service ehr: DB instance host or IP address. - Service elastic_cloud: DB instance host or IP address. - Service es_self_hosted: DB instance host or IP address. - Service ftp: FTP host address. - Service google_cloud_mysql: DB instance host or IP address. - Service google_cloud_postgresql: DB instance host or IP address. - Service google_cloud_sqlserver: DB instance host or IP address. - Service hana_sap_hva_b1: DB instance host or IP address. - Service hana_sap_hva_ecc: DB instance host or IP address. - Service hana_sap_hva_ecc_netweaver: DB instance host or IP address. - Service hana_sap_hva_s4: DB instance host or IP address. - Service hana_sap_hva_s4_netweaver: DB instance host or IP address. - Service heroku_postgres: DB instance host or IP address. - Service jira: The Jira service host address. - Service magento_mysql: DB instance host or IP address. - Service magento_mysql_rds: DB instance host or IP address. - Service maria: DB instance host or IP address. - Service maria_azure: DB instance host or IP address. - Service maria_rds: DB instance host or IP address. - Service marin: The Marin host address. - Service mysql: DB instance host or IP address. - Service mysql_azure: DB instance host or IP address. - Service mysql_rds: DB instance host or IP address. - Service netsuite_suiteanalytics: The NetSuite service host address. - Service opendistro: DB instance host or IP address. - Service opensearch: DB instance host or IP address. - Service oracle: DB instance host or IP address. - Service oracle_ebs: DB instance host or IP address. - Service oracle_hva: DB instance host or IP address. - Service oracle_rac: DB instance host or IP address. - Service oracle_rds: DB instance host or IP address. - Service oracle_sap_hva: DB instance host or IP address. - Service oracle_sap_hva_netweaver: DB instance host or IP address. - Service postgres: DB instance host or IP address. - Service postgres_rds: DB instance host or IP address. - Service redshift_db: Host name - Service sap_hana: The SAP HANA host or IP address. - Service sap_s4hana: The SAP S/4 host or IP address. - Service sftp: SFTP host address. - Service snowflake_db: Host name - Service splunk: The Splunk service host address. - Service sql_server: DB instance host or IP address. - Service sql_server_hva: DB instance host or IP address. - Service sql_server_rds: DB instance host or IP address. - Service sql_server_sap_ecc_hva: DB instance host or IP address.
hostIp String: Field usage depends on service value: - Service azure_blob_storage: IP address of host tunnel machine which is used to connect to the Storage container. - Service azure_service_bus: The IP address of the host machine which we use to connect to ASB via ssh
hostName String: Field usage depends on service value: - Service coassemble: Your Coassemble Hostname. - Service datadog: Your Datadog host name.
hostUrl String: Field usage depends on service value: - Service adobe_commerce: Your Adobe Commerce host url. - Service sparkpost: Your SparkPost host URL.
hostUser String: Field usage depends on service value: - Service azure_blob_storage: Username in the host machine. - Service azure_service_bus: The username on the host machine which we use to connect to ASB via ssh
hostname String: Field usage depends on service value: - Service akamai: Your Akamai hostname. - Service ukg_pro: Your UKG Pro hostname.
hosts List<String>: Field usage depends on service value: - Service azure_cosmos_for_mongo: A list of host addresses for Azure Cosmos DB for Mongo DB. - Service mongo: 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. - Service mongo_sharded: 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.
httpPath String: Field usage depends on service value: - Service databricks_db: http path
identifier String: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management client identifier. - Service statistics_netherlands_cbs: Your Statistics Netherlands CBS catalog identifier.
identity String: Field usage depends on service value: - Service marketo: Marketo REST API identity url.
includeOcapiEndpoints Boolean: Field usage depends on service value: - Service salesforce_commerce_cloud: Whether to sync data through OCAPI endpoints.
instance String: Field usage depends on service value: - Service acumatica: Your Acumatica instance name. - Service coupa: The instance name of your Coupa account in the URL. - Service flywheel_digital: Your Flywheel Digital instance. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud instance ID - Service servicenow: ServiceNow Instance ID.
instanceNumber String: Field usage depends on service value: - Service hana_sap_hva_b1: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service oracle_sap_hva_netweaver: Two-digit number (00-97) of the SAP instance within its host.
instanceUrl String: Field usage depends on service value: - Service sap_business_by_design: The SAP Business ByDesign instance URL.
integrationKey String: Field usage depends on service value: - Service pendo: The integration key of the Pendo account.
ipAddress String: Field usage depends on service value: - Service aveva_pi: IP address of the AF Server
isAccountLevelConnector Boolean: Field usage depends on service value: - Service fivetran_log: (Optional) Retrieve account-level logs.
isAuth2Enabled Boolean: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Default value: false
isCustomApiCredentials Boolean: Field usage depends on service value: - Service twitter_ads: Custom API credentials
isExternalActivitiesEndpointSelected Boolean: Field usage depends on service value: - Service pardot: Whether the EXTERNAL_ACTIVITY table must be synced or not.
isFtps Boolean: Field usage depends on service value: - Service adobe_analytics_data_feed: Use Secure FTP (FTPS).
isKeypair Boolean: Field usage depends on service value: - Service sftp: Whether to use a key pair for authentication. When true, do not use password.
isMultiEntityFeatureEnabled Boolean: Field usage depends on service value: - Service zuora: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false. - Service zuora_sandbox: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false.
isNewPackage Boolean: Field usage depends on service value: - Service salesforce_marketing_cloud: Indicates that that your installed package uses OAuth 2.0. Default value: false
isPrivateKeyEncrypted Boolean: Field usage depends on service value: - Service snowflake_db: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
isPrivateLinkRequired Boolean: Field usage depends on service value: - Service aws_lambda: We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our PrivateLink documentation. - Service s3: Set to true if you want to connect to S3 bucket over PrivateLink. Default value: false.
isPublic Boolean: Field usage depends on service value: - Service aws_cost_report: Whether you are syncing from a public bucket. Default value: false. - Service kinesis: Is the bucket public? (you don't need an AWS account for syncing public buckets!) - Service s3: Whether you are syncing from a public bucket. Default value: false.
isSailthruConnectEnabled Boolean: Field usage depends on service value: - Service sailthru: Enable this if you want to sync Sailthru Connect
isSecure Boolean: Field usage depends on service value: - Service ftp: Whether the server supports FTPS.
isSftpCredsAvailable Boolean: Field usage depends on service value: - Service salesforce_marketing_cloud: Provide SFTP credentials
isSingleTableMode Boolean: Field usage depends on service value: - Service box: Allows the creation of connector using Merge Mode strategy. - Service dropbox: Allows the creation of connector using Merge Mode strategy. - Service google_drive: Allows the creation of connector using Merge Mode strategy. - Service sftp: Allows the creation of connector using the specified Sync strategy. - Service share_point: Allows the creation of connector using Merge Mode strategy.
isTestAccount Boolean: Field usage depends on service value: - Service adyen: Whether or not your Adyen Account is a Test Account. Default value: false.
isVendor Boolean: Field usage depends on service value: - Service amazon_selling_partner: Whether or not you have a Vendor Account. Default value: false.
issuer String: Field usage depends on service value: - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud issuer name.
jsonDeliveryMode String: Field usage depends on service value: - Service aws_cost_report: Control how your JSON data is delivered into your destination - Service azure_blob_storage: Control how your JSON data is delivered into your destination - Service box: Control how your JSON data is delivered into your destination - Service dropbox: Control how your JSON data is delivered into your destination - Service email: Control how your JSON data is delivered into your destination - Service ftp: Control how your JSON data is delivered into your destination - Service gcs: Control how your JSON data is delivered into your destination - Service google_drive: Control how your JSON data is delivered into your destination - Service kinesis: Control how your JSON data is delivered into your destination - Service s3: Control how your JSON data is delivered into your destination - Service sftp: Control how your JSON data is delivered into your destination - Service share_point: Control how your JSON data is delivered into your destination - Service wasabi_cloud_storage: Specifies how Fivetran should handle your JSON data. Default value: Packed.
key String: Field usage depends on service value: - Service uservoice: The UserVoice API key.
keyPassword String: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Key Password.
keyStoreType String: Field usage depends on service value: - Service heroku_kafka: Key Store Type
keystore String: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Keystore File as Base64 encoded string.
keystorePassword String: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Keystore Password.
lastSyncedChangesUtc_ String
latestVersion String
legalEntityId String: Field usage depends on service value: - Service younium: Your Younium legal entity ID.
limitForApiCallsToExternalActivitiesEndpoint Double: Field usage depends on service value: - Service pardot: API limit for the external activities endpoint.
lineSeparator String: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
listId String: Field usage depends on service value: - Service pigment: Your Pigment list ID.
listOfCompanyIds String: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail list of company IDs.
listStrategy String: Field usage depends on service value: - Service aws_cost_report: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service kinesis: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service s3: The listing strategy you want to use. Default value: complete_listing.
listSyncMode String: Field usage depends on service value: - Service google_analytics_4_export: The Sync Mode
logJournal String: Field usage depends on service value: - Service db2i_hva: The log journal name. - Service db2i_sap_hva: The log journal name.
logJournalSchema String: Field usage depends on service value: - Service db2i_hva: The log journal schema. - Service db2i_sap_hva: The log journal schema.
logOnGroup String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional. - Service hana_sap_hva_s4_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional.
login String: Field usage depends on service value: - Service rebound_returns: Your ReBound Returns login. - Service the_trade_desk: The Trade Desk email. It is a part of the login credentials. - Service walmart_dsp: Walmart DSP email. It is a part of the login credentials.
loginPassword String: Field usage depends on service value: - Service concur: The SAP Concur password. - Service sage_intacct: The login password. It is a part of the login credentials.
managerAccounts List<String>: Field usage depends on service value: - Service google_ads: The list of the Manager Account IDs whose clients will be synced. Must be populated if sync_mode is set to ManagerAccounts.
maxApiRequestsPerDay Double: Field usage depends on service value: - Service reltio: Maximum API requests per day
merchantId String: Field usage depends on service value: - Service afterpay: Your Afterpay Merchant ID. - Service amazon_selling_partner: The Merchant ID or Vendor Code. - Service avantlink: Your AvantLink Merchant ID. - Service braintree: Your Braintree merchant ID. - Service braintree_sandbox: Your Braintree merchant ID. - Service shareasale: Your ShareASale merchant ID. - Service xsolla: Your Xsolla Merchant ID.
messageType String: Field usage depends on service value: - Service apache_kafka: Kafka message type. - Service aws_msk: The Message type. - Service azure_event_hub: Message type. - Service azure_service_bus: The format of messages in the topic - Service confluent_cloud: Confluent Cloud message type. - Service heroku_kafka: Heroku Kafka message type.
metricId String: Field usage depends on service value: - Service pigment: Your Pigment metric ID.
metrics List<String>: Field usage depends on service value: - Service adroll: The metrics that you want to sync. - Service criteo: Metrics - Service double_click_campaign_manager: Report metrics to include into a sync. - Service google_analytics: The report metrics to include into a sync. - Service google_display_and_video_360: 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.
namedRange String: Field usage depends on service value: - Service google_sheets: The name of the named data range on the sheet that contains the data to be synced.
namespace String: Field usage depends on service value: - Service azure_service_bus: The ASB namespace which we have to sync. Required for AzureActiveDirectory authentication.
networkCode Double: Field usage depends on service value: - Service double_click_publishers: Network code is a unique, numeric identifier for your Ad Manager network.
nonStandardEscapeChar Boolean: Field usage depends on service value: - Service gcs: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false. - Service s3: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false.
nullSequence String: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service azure_blob_storage: If your CSVs use a special value indicating null, you can specify it here. - Service box: If your CSVs use a special value indicating null, you can specify it here. - Service dropbox: If your CSVs use a special value indicating null, you can specify it here. - Service email: If your CSVs use a special value indicating null, you can specify it here. - Service ftp: If your CSVs use a special value indicating null, you can specify it here. - Service gcs: If your CSVs use a special value indicating null, you can specify it here. - Service google_drive: If your CSVs use a special value indicating null, you can specify it here. - Service kinesis: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service s3: If your CSVs use a special value indicating null, you can specify it here. - Service sftp: If your CSVs use a special value indicating null, you can specify it here. - Service share_point: If your CSVs use a special value indicating null, you can specify it here. - Service wasabi_cloud_storage: If your CSVs use a special value indicating null, you can specify it here.
oauthToken String
oauthTokenSecret String
ocapiClientId String: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client ID.
ocapiClientSecret String: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client secret.
ocapiCustomObjectTypes String: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI custom object types.
ocapiHostname String: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI hostname.
odbcDriverManagerLibraryPath String: Field usage depends on service value: - Service hana_sap_hva_b1: ODBC manager library path - Service hana_sap_hva_ecc: ODBC manager library path - Service hana_sap_hva_s4: ODBC manager library path
odbcSysIniPath String: Field usage depends on service value: - Service hana_sap_hva_b1: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_ecc: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_s4: odbc.ini and odbcsinst.ini location
onError String: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
onPremise Boolean: Field usage depends on service value: - Service jira: Whether the Jira instance is local or in cloud.
organization String: Field usage depends on service value: - Service gladly: Your Gladly Organization Name. - Service statuspage: Your Statuspage Organization ID.
organizationDomain String: Field usage depends on service value: - Service adobe_workfront: Your Adobe Workfront organization domain.
organizationId String: Field usage depends on service value: - Service adobe_analytics: Organization ID from the Service Account (JWT) credentials of your Adobe Project. - Service integrate: Your Integrate organization ID. - Service megaphone: Your Megaphone organization ID. - Service productive: Your Productive Organization ID. - Service salesforce_commerce_cloud: The organization ID from Salesforce Commerce Cloud account. - Service sentry: Your Sentry organization ID. - Service zoho_books: Your Zoho Books Organization ID. - Service zoho_inventory: Your Zoho Inventory organization ID.
organizationName String: Field usage depends on service value: - Service brightpearl: Your Brightpearl organization name. - Service confluence: Your Confluence organization name.
organizations List<String>: Field usage depends on service value: - Service apple_search_ads: Organizations - Service snapchat_ads: Specific organizations IDs to sync. Must be populated if syncMode is set to SpecificOrganizations.
packedModeTables List<String>: Field usage depends on service value: - Service azure_cosmos_for_mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service dynamodb: List of tables to be synced in packed mode. - Service firebase: Specific tables to sync. Must be populated if packing_mode is set to SelectTablesForPackedMode. - Service mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service mongo_sharded: List of tables to be synced in packed mode; format:db.table(case-sensitive).
packingMode String: Field usage depends on service value: - Service azure_cosmos_for_mongo: Indicates the desired sync pack mode. Accepted values are UsePackedModeOnly and UseUnpackedModeOnly. SelectTablesForPackedMode is deprecated. - Service firebase: Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service klaviyo: Packing mode for EVENT and PERSON tables. - Service mongo: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service mongo_sharded: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service optimizely: Packing mode for conversion and decision tables. - Service sailthru: Packing mode for LIST_STATE and USER tables.
pages List<String>: Field usage depends on service value: - Service facebook_pages: Specific pages to sync. Must be populated if sync_mode is set to SpecificPages.
partnerCode String: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission partner code.
partnerUserId String: Field usage depends on service value: - Service expensify: Your Expensify partnerUserID.
partnerUserSecret String: Field usage depends on service value: - Service expensify: Your Expensify partnerUserSecret.
partners List<String>: Field usage depends on service value: - Service google_display_and_video_360: The list of partners to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service the_trade_desk: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service walmart_dsp: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
passPhrase String: Field usage depends on service value: - Service qualtrics: Pass Phrase
passphrase String: Field usage depends on service value: - Service snowflake_db: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
password String: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS password. - Service adobe_commerce: Your Adobe Commerce password. - Service akeneo: Your Akeneo password. - Service anaplan: Your Anaplan password. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Password. - Service aurora: The user's password. - Service aurora_postgres: The user's password. - Service azure_cosmos_for_mongo: Password used for source database authentication. - Service azure_postgres: The user's password. - Service azure_sql_db: The user's password. - Service azure_sql_managed_db: The user's password. - Service boostr: Your Boostr password. - Service ceridian_dayforce: Your Ceridian Dayforce Password. - Service cin7: Your Cin7 API Key. - Service clarity: The user's password. - Service cockroachdb: The user's password. - Service collibra: Your collibra password. - Service compliance_checkpoint: Your Compliance Checkpoint account password. - Service contrast_security: Your Contrast Security API Password. - Service db2i_hva: The user's password. - Service db2i_sap_hva: The user's password. - Service deposco: Your Deposco password. - Service documentdb: The user's password. - Service dynamics_365_fo: The user's password. - Service ehr: The user's password. - Service elastic_cloud: The user's password. - Service es_self_hosted: The user's password. - Service ftp: FTP password. - Service globalmeet: Your GlobalMeet Password. - Service google_cloud_mysql: The user's password. - Service google_cloud_postgresql: The user's password. - Service google_cloud_sqlserver: The user's password. - Service green_power_monitor: Your GreenPowerMonitor password. - Service guru: Your Guru password. - Service hana_sap_hva_b1: The user's password. - Service hana_sap_hva_ecc: The user's password. - Service hana_sap_hva_ecc_netweaver: The user's password. - Service hana_sap_hva_s4: The user's password. - Service hana_sap_hva_s4_netweaver: The user's password. - Service heroku_postgres: The user's password. - Service hilti_ontrack: Your Hilti On!Track password. - Service impact: Your Impact Account Token - Service integral_ad_science: Your integral_ad_science password. - Service itunes_connect: Your password - Service jamf: Your Jamf password. - Service jira: The Jira user's password. - Service khoros_care: Your Khoros Care password. - Service kissmetrics: Your Kissmetrics API Password. - Service klarna: Your Klarna Password. - Service lessonly: Your Lessonly password. - Service magento_mysql: The user's password. - Service magento_mysql_rds: The user's password. - Service maria: The user's password. - Service maria_azure: The user's password. - Service maria_rds: The user's password. - Service marin: The Marin user's password. - Service moloco: Your Moloco account password. - Service mongo: The user's password. - Service mongo_sharded: The user's password. - Service myosh: Your myosh password. - Service mysql: The user's password. - Service mysql_azure: The user's password. - Service mysql_rds: The user's password. - Service netsuite_suiteanalytics: The NetSuite user's password. - Service opendistro: The user's password. - Service opensearch: The user's password. - Service oracle: The user's password. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence user password. - Service oracle_ebs: The user's password. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud user password. - Service oracle_hva: The user's password. - Service oracle_rac: The user's password. - Service oracle_rds: The user's password. - Service oracle_sap_hva: The user's password. - Service oracle_sap_hva_netweaver: The user's password. - Service outbrain: The Outbrain user's password. - Service pardot: The Pardot user's password. - Service partnerize: Your Partnerize account's password. - Service podio: Your Podio account password. - Service postgres: The user's password. - Service postgres_rds: The user's password. - Service qmatic_data_connect: Your Qmatic Data Connect password. - Service redshift_db: The Redshift user's password. - Service revx: Your RevX Password. - Service rtb_house: Your RTB House password. - Service sap_business_by_design: The SAP Business ByDesign password. - Service sap_hana: Your SAP HANA password. - Service sap_s4hana: Your SAP S/4 password. - Service scorm: Your Scorm Secret Key. - Service servicenow: Your account password. - Service sftp: SFTP password. - Service shiphero: Your ShipHero password. - Service shipstation: Your ShipStation password. - Service shopware: Your Shopware password. - Service skuvault: Your SkuVault password. - Service smadex: Your Smadex Password. - Service snowflake_db: The Snowflake user's password. - Service splash: Your Splash password. - Service splunk: The Splunk user's password. - Service sql_server: The user's password. - Service sql_server_hva: The user's password. - Service sql_server_rds: The user's password. - Service sql_server_sap_ecc_hva: The user's password. - Service starrez: Your StarRez API password - Service stickyio: Your sticky.io password. - Service stylight: Your Stylight Password. - Service sugarcrm: Your SugarCRM password. - Service teamwork: Your Teamwork password. - Service the_trade_desk: The Trade Desk password. It is a part of the login credentials. - Service toggl_track: Your Toggl Track Password - Service ukg_pro: Your UKG Pro password. - Service unicommerce: Your uniware login password. - Service upland: Your Upland Software Password. - Service veevavault: Your Veeva Vault password. - Service walmart_dsp: Walmart DSP password. It is a part of the login credentials. - Service when_i_work: Your When I Work password. - Service wherefour: Your Wherefour password. - Service workday: Workday password. - Service workday_financial_management: Workday password. - Service workday_hcm: Workday password. - Service xandr: Your Xandr password. - Service younium: Your Younium password.
pat String: Field usage depends on service value: - Service github: The Personal Access Token generated in Github.
patName String: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Name.
patSecret String: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Secret.
path String: Field usage depends on service value: - Service jira: A URL subdirectory where the Jira instance is working.
pats List<String>: Field usage depends on service value: - Service github: The Personal Access Tokens.
pattern String: Field usage depends on service value: - Service aws_cost_report: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service azure_blob_storage: All files in your search path matching this regular expression will be synced. - Service box: All files in your search path matching this regular expression will be synced. - Service dropbox: All files in your search path matching this regular expression will be synced. - Service email: All files in your search path matching this regular expression will be synced. - Service ftp: All files in your search path matching this regular expression will be synced. - Service gcs: All files in your search path matching this regular expression will be synced. - Service google_drive: All files in your search path matching this regular expression will be synced. - Service kinesis: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service s3: All files in your search path matching this regular expression will be synced. - Service sftp: All files in your search path matching this regular expression will be synced. - Service share_point: All files in your search path matching this regular expression will be synced. - Service wasabi_cloud_storage: All files in your search path matching this regular expression will be synced.
pdbName String: Field usage depends on service value: - Service oracle: Optional: Required only for containerized database. - Service oracle_ebs: Optional: Required only for containerized database. - Service oracle_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases. - Service oracle_rac: Optional: Required only for containerized database. - Service oracle_rds: Optional: Required only for containerized database. - Service oracle_sap_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
pemCertificate String: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Must be populated if is_auth2_enabled is set to false.
pemPrivateKey String: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM secret key file. Must be populated if is_auth2_enabled is set to true.
perInteractionDimensions List<String>: Field usage depends on service value: - Service double_click_campaign_manager: Per Interaction Dimensions.
personalAccessToken String: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail personal access token. - Service databricks_db: Access Token - Service harvest: Your Harvest Personal Access Token. - Service productive: Your Productive personal access token. - Service totango: Your Totango personal access token.
personalApiToken String: Field usage depends on service value: - Service circleci: Your CircleCI Personal API token. - Service monday: Your Monday.com Personal API Token.
pgpPassPhrase String: Field usage depends on service value: - Service azure_blob_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true.
pgpSecretKey String: Field usage depends on service value: - Service azure_blob_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true.
phoneNumber String: Field usage depends on service value: - Service itunes_connect: Register the number on AppleId Account Page for 2FA
planType String: Field usage depends on service value: - Service justcall: Your JustCall Plan Type.
port Double: Field usage depends on service value: - Service aurora: The port number. - Service aurora_postgres: The port number. - Service aveva_pi: Port number at which the AF Server is running - Service azure_postgres: The port number. - Service azure_sql_db: The port number. - Service azure_sql_managed_db: The port number. - Service clarity: The port number. - Service cockroachdb: The port number. - Service databricks_db: The port of your SQL warehouse. - Service db2i_hva: The port number. - Service db2i_sap_hva: The port number. - Service documentdb: Port of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: The port number. - Service ehr: The port number. - Service elastic_cloud: The port number. - Service es_self_hosted: The port number. - Service ftp: FTP port. - Service google_cloud_mysql: The port number. - Service google_cloud_postgresql: The port number. - Service google_cloud_sqlserver: The port number. - Service hana_sap_hva_b1: The port number. - Service hana_sap_hva_ecc: The port number. - Service hana_sap_hva_ecc_netweaver: The port number. - Service hana_sap_hva_s4: The port number. - Service hana_sap_hva_s4_netweaver: The port number. - Service heroku_postgres: The port number. - Service jira: The Jira service host port. - Service magento_mysql: The port number. - Service magento_mysql_rds: The port number. - Service maria: The port number. - Service maria_azure: The port number. - Service maria_rds: The port number. - Service mysql: The port number. - Service mysql_azure: The port number. - Service mysql_rds: The port number. - Service netsuite_suiteanalytics: The NetSuite service host port. - Service opendistro: The port number. - Service opensearch: The port number. - Service oracle: The port number. - Service oracle_ebs: The port number. - Service oracle_hva: The port number. - Service oracle_rac: The port number. - Service oracle_rds: The port number. - Service oracle_sap_hva: The port number. - Service postgres: The port number. - Service postgres_rds: The port number. - Service redshift_db: Port number - Service sap_hana: The SAP HANA port number. - Service sap_s4hana: The SAP S/4 port number. - Service sftp: SFTP port. - Service snowflake_db: The Snowflake optional port number. - Service splunk: The Splunk service host port. - Service sql_server: The port number. - Service sql_server_hva: The port number. - Service sql_server_rds: The port number. - Service sql_server_sap_ecc_hva: The port number.
postClickAttributionWindowSize String: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on clicks. Default value: DAY_30
prebuiltReport String: Field usage depends on service value: - Service facebook: The name of report of which connector will sync the data. Possible prebuilt_report values. - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data.
prefix String: Field usage depends on service value: - Service aws_cloudtrail: If prefix is present when configuring the bucket. - Service aws_cost_report: Folder path to the aws_cost_report files within the bucket. - Service aws_inventory: The prefix if you used one when configuring the bucket. - Service azure_blob_storage: All files and folders under this folder path will be searched for files to sync. - Service box: All files and folders under this folder path will be searched for files to sync. - Service cloudfront: The name of the CloudFront folder in the bucket. - Service dropbox: All files and folders under this folder path will be searched for files to sync. - Service ftp: All files and folders under this folder path will be searched for files to sync. - Service gcs: All files and folders under this folder path will be searched for files to sync. - Service google_drive: 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 - Service kinesis: Folder path to the Kinesis files within the bucket. - Service marin: Folder path to the Marin manifest file. - Service microsoft_dynamics_365_fo: Folder name in which the exported dynamics 365 data resides. - Service s3: All files and folders under this folder path will be searched for files to sync. - Service segment: Folder path to the Segment files within the bucket. Must be populated if sync_type is set to S3. - Service sftp: All files and folders under this folder path will be searched for files to sync. - Service share_point: All files and folders under this folder path link will be searched for files to sync. This can be any shared folder link. - Service wasabi_cloud_storage: All files and folders under this folder path will be searched for files to sync.
primaryKey String: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission primary key.
primaryKeys List<String>: Field usage depends on service value: - Service workday: Primary Keys
privateKey String: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS REST API private key. - Service adobe_analytics: The complete contents of your private key file including the start and end tags (----BEGIN PRIVATE KEY---- to ----END PRIVATE KEY----). - Service adp_workforce_now: Private Key. - Service anaplan: The contents of your private key file. Must be populated if auth_mode is set to Certificate. - Service apple_search_ads: The contents of your secret key file. Must be populated if is_auth2_enabled is set to false. - Service braintree: The contents of your secret key file. - Service braintree_sandbox: The contents of your secret key file. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud private key. - Service qualtrics: Your private key - Service salesforce: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service snowflake_db: Private access key. The field should be specified if authentication type is KEY_PAIR.
privateToken String: Field usage depends on service value: - Service eventbrite: Your Eventbrite private token.
product String: Field usage depends on service value: - Service webconnex: Your Webconnex product.
profiles List<String>: Field usage depends on service value: - Service amazon_ads: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SpecificProfiles. - Service google_analytics: Specific User Profile IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_mcf: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
profilesAmazonDsp String: Field usage depends on service value: - Service amazon_dsp: Comma-separated list of your Amazon DSP profiles.
projectAccessToken String: Field usage depends on service value: - Service rollbar: Your Rollbar project access token.
projectCredentials List<GetConnectorConfigProjectCredential>: Field usage depends on service value: - Service amplitude: * Project(s)
projectId String: Field usage depends on service value: - Service bigquery_db: BigQuery project ID - Service google_analytics_360: The project ID. - Service google_analytics_4_export: The Project ID. - Service mixpanel: Project ID
projectIds String: Field usage depends on service value: - Service sentry: Your Sentry project IDs.
projectKey String: Field usage depends on service value: - Service commercetools: Your commercetools project key.
projects List<String>: Field usage depends on service value: - Service asana: Specific Project IDs to sync. Must be populated if syncMode is set to SpecificProjects. - Service jira: Specific projects to sync. Must be populated if syncMode is set to CUSTOM.
properties List<String>: Field usage depends on service value: - Service google_analytics_4: The array of strings in the properties/{id} format where id is a Google Analytics 4 property identifier. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
propertyId String: Field usage depends on service value: - Service cloudbeds: Your Cloudbeds property IDs.
publicKey String: Field usage depends on service value: - Service aurora: Public Key - Service aurora_postgres: Public Key - Service azure_blob_storage: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_cosmos_for_mongo: Public Key - Service azure_postgres: Public Key - Service azure_service_bus: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_sql_db: Public Key. - Service azure_sql_managed_db: Public Key. - Service braintree: The contents of your PEM certificate file. - Service braintree_sandbox: The contents of your PEM certificate file. - Service clarity: Public Key. - Service cockroachdb: Public Key - Service db2i_hva: Public Key - Service db2i_sap_hva: Public Key - Service documentdb: Public Key - Service dynamics_365_fo: Public Key. - Service ehr: Public Key. - Service elastic_cloud: Public Key - Service es_self_hosted: Public Key - Service google_cloud_mysql: Public Key - Service google_cloud_postgresql: Public Key - Service google_cloud_sqlserver: Public Key. - Service hana_sap_hva_b1: Public Key - Service hana_sap_hva_ecc: Public Key - Service hana_sap_hva_ecc_netweaver: Public Key - Service hana_sap_hva_s4: Public Key - Service hana_sap_hva_s4_netweaver: Public Key - Service heroku_postgres: Public Key - Service magento_mysql: Public Key - Service magento_mysql_rds: Public Key - Service maria: Public Key - Service maria_azure: Public Key - Service maria_rds: Public Key - Service mongo: Public Key - Service mongo_sharded: Public Key - Service mysql: Public Key - Service mysql_azure: Public Key - Service mysql_rds: Public Key - Service opendistro: Public Key - Service opensearch: Public Key - Service oracle: Public Key - Service oracle_ebs: Public Key - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud public key. - Service oracle_hva: Public Key - Service oracle_rac: Public Key - Service oracle_rds: Public Key - Service oracle_sap_hva: Public Key - Service partnerstack_vendor: Your PartnerStack Vendor Public key. - Service postgres: Public Key - Service postgres_rds: Public Key - Service sap_hana: Public Key - Service sap_s4hana: Public Key - Service sftp: Public Key - Service sql_server: Public Key. - Service sql_server_hva: Public Key. - Service sql_server_rds: Public Key. - Service sql_server_sap_ecc_hva: Public Key.
publicationName String: Field usage depends on service value: - Service aurora_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service azure_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service google_cloud_postgresql: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service heroku_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres_rds: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT".
publisherId String: Field usage depends on service value: - Service skimlinks: Your Skimlinks publisher ID.
pullArchivedCampaigns Boolean: Field usage depends on service value: - Service outbrain: Include or ignore results from archived campaigns
pythonVersion String
queryId String: Field usage depends on service value: - Service google_display_and_video_360: The ID of the query whose configuration you want to reuse. This is a required parameter when config_method is set to REUSE_EXISTING.
queryParamValue String: Field usage depends on service value: - Service alchemer: Your Alchemer API key. - Service birdeye: Your Birdeye query-param-value.
quotaProjectId String: Field usage depends on service value: - Service bigquery_db: Specify a different project ID to account for quota and billing of Fivetran query workload
quoteChar String: Field usage depends on service value: - Service azure_blob_storage: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service gcs: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service google_drive: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service s3: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service sftp: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service share_point: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
quoteCharacterEnabled Boolean: Field usage depends on service value: - Service azure_blob_storage: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service gcs: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service google_drive: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service s3: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service sftp: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service share_point: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
rateLimitPlan String: Field usage depends on service value: - Service vimeo: Your Vimeo rate limit plan.
refreshToken String: Field usage depends on service value: - Service ironsource: Your Ironsource Client Secret.
refreshTokenExpiresAt String: Field usage depends on service value: - Service pinterest_ads: The expiration date of the refresh token. Unix timestamp in seconds
region String: Field usage depends on service value: - Service algolia: Your Algolia analytics region. - Service amazon_ads: The region used by the Amazon Ads profile. - Service amazon_selling_partner: The region used by the Amazon Selling Partner profile. - Service anaplan: Your Anaplan account region - Service atlassian_ops_genie: Your company's Osgenie region (usually company.opsgenie.com) - Service awin: Your Awin Region. - Service aws_lambda: The AWS region code for the DynamoDB instance. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Region - Service concur: The region. - Service cvent: Your Cvent region. - Service everflow: Your Everflow region. - Service exact_online: Your Exact Online region. - Service getfeedback: Your GetFeedback region. - Service happyfox: Your HappyFox region. - Service keypay: Your KeyPay region. - Service medallia_agile_research: Your Medallia Agile region. - Service messagebird: Your MessageBird Account region. - Service mixpanel: Data Region - Service navan: Your Navan region. - Service on24: Your ON24 region. - Service pendo: The Pendo account region. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Region. - Service ringover: Your Ringover region. - Service samsara: The region of your Samsara account. For instance, if your region is EUROPE, provide eu.samsara in the Region field. If your region is not in Europe, provide samsara. - Service snyk: Your Snyk region. - Service talkdesk: Your Talkdesk region (".com",".eu","ca.com") - Service totango: Your Totango region. - Service transcend: Your Transcend region. - Service vonage_contact_center: Your Vonage Contact Center region. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: US_EAST_1. - Service workday_strategic_sourcing: Your Workday Strategic Sourcing Region. - Service zoho_books: Your Zoho Books application host region. - Service zoho_campaigns: Your Zoho Campaigns application host region. - Service zoho_desk: Your Zoho Desk domain. - Service zoho_inventory: Your Zoho Inventory application host region.
regionApiUrl String: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution API URL region.
regionAuthUrl String: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution auth URL region.
regionTokenUrl String: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution token URL region.
regionUrl String: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management region URL.
replicaId Double: Field usage depends on service value: - Service aurora: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service google_cloud_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
replicationSlot String: Field usage depends on service value: - Service aurora_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service azure_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service google_cloud_postgresql: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service heroku_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres_rds: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT".
reportConfigs List<GetConnectorConfigReportConfig>: Field usage depends on service value: - Service yahoo_dsp: Specify the reports you want to sync. This is optional.
reportConfigurationIds List<String>: Field usage depends on service value: - Service double_click_campaign_manager: You can select only one Floodlight Configuration ID per account.
reportFormatType String: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
reportGranularity String: Field usage depends on service value: - Service pinterest_ads: Granularity at which reports will be
reportKeys String: Field usage depends on service value: - Service rakutenadvertising: Your Rakuten Advertising report keys.
reportLists List<GetConnectorConfigReportList>: Field usage depends on service value: - Service spotify_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
reportServiceApiKey String: Field usage depends on service value: - Service adyen: Your Report Service API key.
reportSuites List<String>
reportTimezone String: Field usage depends on service value: - Service criteo: Report Timezone
reportType String: Field usage depends on service value: - Service adroll: The report type you want. Default value: ALL_ADS. - Service double_click_campaign_manager: Type of reporting data to sync. Default value: STANDARD. - Service google_display_and_video_360: The type of the report to create. This is a required parameter when config_method is set to CREATE_NEW. - Service youtube_analytics: The name of report of which connector will sync the data.
reportUrl String: Field usage depends on service value: - Service workday: URL for a live custom report.
reports List<GetConnectorConfigReport>: Field usage depends on service value: - Service google_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics_4: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_search_ads_360: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service google_search_console: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service workday: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
reportsLinkedinAds List<String>: Field usage depends on service value: - Service linkedin_ads: Specific analytics reports to sync. Must be populated if adAnalytics is set to 'SpecificReports'.
repositories List<String>: Field usage depends on service value: - Service github: Specific Repository IDs to sync. Must be populated if syncMode is set to SpecificRepositories.
resourceToken String: Field usage depends on service value: - Service cosmos: A token that provides access to a specific Azure Cosmos DB resource. Required for the RESOURCE_TOKEN data access method.
resourceUrl String: Field usage depends on service value: - Service dynamics_365: URL at which Dynamics 365 is accessed
restApiLimit Double: Field usage depends on service value: - Service pardot: The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
rfcLibraryPath String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service hana_sap_hva_s4_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service oracle_sap_hva_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files.
role String: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Role ID for connection. - Service snowflake_db: Snowflake Connector role name
roleArn String: Field usage depends on service value: - Service appsflyer: S3 Role ARN - Service aws_cloudtrail: The Role ARN required for authentication. - Service aws_cost: The Role ARN required for authentication. - Service aws_cost_report: The Role ARN required for authentication. - Service aws_inventory: The Role ARN required for authentication. - Service aws_lambda: The Role ARN required for authentication. - Service aws_msk: If sasl_mechanism is set to IAM, enter your Role ARN - Service cloudfront: The Role ARN required for authentication. - Service dynamodb: Role ARN - Service heap: The Role ARN required for authentication. - Service kinesis: The Role ARN required for authentication. - Service s3: The Role ARN required for authentication. Required for connector creation when syncing using private bucket. - Service segment: The Role ARN required for authentication. Must be populated if sync_type is set to S3.
rollbackWindow Double: Field usage depends on service value: - Service appsflyer: Rollback window
rollbackWindowSize Double: Field usage depends on service value: - Service bingads: A period of time in days during which a conversion is recorded.
s3Bucket String: Field usage depends on service value: - Service webhooks: The S3 bucket name. Required if bucket_service is set to S3.
s3ExportBucket String: Field usage depends on service value: - Service braze: Your S3 user export bucket. Required if AWS_S3 is the export_storage_type
s3ExportExternalId String: Field usage depends on service value: - Service braze: This is the same as your group_id, used if export_storage_type is AWS_S3
s3ExportFolder String: Field usage depends on service value: - Service braze: Your S3 user export folder name. Required if AWS_S3 is the export_storage_type
s3ExportRoleArn String: Field usage depends on service value: - Service braze: The Role ARN required for authentication required if AWS_S3 is the export_storage_type
s3RoleArn String: Field usage depends on service value: - Service adjust: Used if the export_storage_type is AWS_S3, the Role ARN required for authentication. - Service webhooks: The Role ARN required for authentication. Required if bucket_service is set to S3.
s3bucket String: Field usage depends on service value: - Service adobe_analytics_data_feed: The S3 bucket name. - Service braze: Your S3 bucket required if AWS_S3 is the cloud_storage_type - Service sailthru: Name of the bucket configured to receive sailthru connect data.
s3externalId String: Field usage depends on service value: - Service braze: 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 - Service sailthru: The external ID is a string that designates who can assume the role.
s3folder String: Field usage depends on service value: - Service braze: Your S3 folder name required if AWS_S3 is the cloud_storage_type
s3path String: Field usage depends on service value: - Service sailthru: Copy and use this to configure Sailthru Connect in your sailthru account.
s3roleArn String: Field usage depends on service value: - Service adobe_analytics_data_feed: The Role ARN required for authentication. - Service braze: The Role ARN required for authentication required if AWS_S3 is the cloud_storage_type - Service sailthru: Role ARN of the IAM role created for Fivetran.
salesAccountSyncMode String: Field usage depends on service value: - Service itunes_connect: Whether to sync all sales accounts or specific sales accounts.
salesAccounts List<String>: Field usage depends on service value: - Service itunes_connect: Specific sales account to sync. Must be populated if sales_account_sync_mode is set to SpecificSalesAccounts.
salesforceSecurityToken String: Field usage depends on service value: - Service pardot: The Pardot user's Salesforce SSO Account Security Token.
sandboxAccount String: Field usage depends on service value: - Service gocardless: Your GoCardless account type.
sapSchema String: Field usage depends on service value: - Service db2i_hva: The SAP schema. - Service db2i_sap_hva: SAP schema name. - Service sql_server_hva: SAP Schema Name. Required only for High-Volume Agent SAP ECC connector. - Service sql_server_sap_ecc_hva: SAP Schema Name.
sapSourceSchema String: Field usage depends on service value: - Service hana_sap_hva_b1: The schema name where the HANA tables reside. - Service hana_sap_hva_ecc: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_ecc_netweaver: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4_netweaver: The Hana schema name where the SAP tables reside.
sapUser String: Field usage depends on service value: - Service oracle_sap_hva: The Oracle schema name where the SAP tables reside.
saslMechanism String: Field usage depends on service value: - Service apache_kafka: SASL Mechanism - Service aws_msk: If security_protocol is set to SASL, enter the SASL Mechanism
saslPlainKey String: Field usage depends on service value: - Service apache_kafka: API Key
saslPlainSecret String: Field usage depends on service value: - Service apache_kafka: API Secret
saslScram256Key String: Field usage depends on service value: - Service apache_kafka: API Key
saslScram256Secret String: Field usage depends on service value: - Service apache_kafka: API Secret
saslScram512Key String: Field usage depends on service value: - Service apache_kafka: API Key - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
saslScram512Secret String: Field usage depends on service value: - Service apache_kafka: API Secret - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
schemaRegistryCredentialsSource String: Field usage depends on service value: - Service apache_kafka: Schema Registry Credentials source - Service aws_msk: Schema Registry Credentials source - Service confluent_cloud: Schema Registry Credentials source
schemaRegistryKey String: Field usage depends on service value: - Service apache_kafka: Schema Registry Key - Service aws_msk: Schema Registry Key - Service azure_service_bus: The key used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Key
schemaRegistrySecret String: Field usage depends on service value: - Service apache_kafka: Schema Registry Secret - Service aws_msk: Schema Registry Secret - Service azure_service_bus: The secret used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Secret
schemaRegistryUrls List<String>: Field usage depends on service value: - Service apache_kafka: Your schema registry URLs - Service aws_msk: Your schema registry URLs - Service azure_service_bus: The comma-separated list of schema registry servers in the server:port format - Service confluent_cloud: Your schema registry URLs
scope String: Field usage depends on service value: - Service ebay: Your eBay scopes.
scopes String: Field usage depends on service value: - Service cornerstone: Your Cornerstone scopes.
seats List<String>: Field usage depends on service value: - Service yahoo_dsp: Specific Seats to sync. Must be populated if sync_mode_seat is set to SPECIFIC_SEATS.
secret String: Field usage depends on service value: - Service appcues: Your Appcues Secret. - Service buildium: Your Buildium API secret. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure secret. - Service loopio: Your Loopio Secret. - Service mode: Your Mode Secret. - Service playvox_workforce_management: Your Playvox Workforce Management client secret. - Service twilio: The Twilio API secret - Service uservoice: The UserVoice API secret. - Service venminder: Your Venminder secret. - Service vts: Your VTS secret.
secretKey String: Field usage depends on service value: - Service afterpay: Your Afterpay Secret Key. - Service appsflyer: Your AWS secret key. - Service bigquery_db: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service checkr: Your Checkr secret key. - Service ezofficeinventory: Your EZOfficeInventory API secret key. - Service gcs: Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket. - Service ironsource: Your Ironsource Client ID. - Service line_ads: Your LINE Ads secret key. - Service mailjet: Your Mailjet secret key. - Service partnerstack_vendor: Your PartnerStack Vendor Secret key. - Service paypal: Client Secret of your PayPal client application. - Service paypal_sandbox: Client Secret of your PayPal client application. - Service phoenix_ads: Your Phoenix Ads Secret key. - Service retailnext: Your RetailNext secret key. - Service statsig: Your Statsig secret key. - Service yotpo: Your Yotpo Secret key
secrets String: Field usage depends on service value: - Service aws_lambda: The secrets that should be passed to the function at runtime. - Service azure_function: The secrets that should be passed to the function at runtime. - Service google_cloud_function: The secrets that should be passed to the function at runtime.
secretsLists List<GetConnectorConfigSecretsList>: Field usage depends on service value: - Service aws_lambda: List of Secrets that should be passed to the function at runtime. - Service azure_function: The list of secrets that should be passed to the function at runtime. - Service google_cloud_function: The list of secrets that should be passed to the function at runtime.
securityProtocol String: Field usage depends on service value: - Service apache_kafka: Security protocol for Kafka interaction. - Service aws_msk: The security protocol for Kafka interaction. - Service confluent_cloud: Security protocol for Confluent Cloud interaction. - Service heroku_kafka: Security protocol for Heroku Kafka interaction.
segments List<String>: Field usage depends on service value: - Service google_analytics: 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.
selectedEventTypes List<String>: Field usage depends on service value: - Service salesforce_marketing_cloud: Select the event types to be synced.
selectedExports List<String>: Field usage depends on service value: - Service anaplan: 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.
senderId String: Field usage depends on service value: - Service sage_intacct: Your Sender ID
senderPassword String: Field usage depends on service value: - Service sage_intacct: Your Sender Password
server String: Field usage depends on service value: - Service castor_edc: Your Castor EDC Server.
serverAddress String: Field usage depends on service value: - Service tableau_source: Your Tableau Source server address.
serverRegion String: Field usage depends on service value: - Service clockify: Your Clockify server region.
serverUrl String: Field usage depends on service value: - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence Instance URL. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud Instance URL.
serverVariable String: Field usage depends on service value: - Service myosh: Your myosh server variable.
servers List<String>: Field usage depends on service value: - Service apache_kafka: Comma-separated list of Kafka servers in the format server:port. - Service aws_msk: Comma-separated list of Kafka servers in the server:port format. - Service confluent_cloud: Comma-separated list of Confluent Cloud servers in the format server:port. - Service heroku_kafka: Comma-separated list of Heroku Kafka servers in the format server:port.
serviceAccount String: Field usage depends on service value: - Service google_drive: Share the folder with the email address
serviceAccountEmail String: Field usage depends on service value: - Service google_cloud_function: Provide Invoker role to this service account.
serviceAccountKey String: Field usage depends on service value: - Service firebase: The contents of your service account key file. Required for authentication.
serviceAccountSecret String: Field usage depends on service value: - Service mixpanel: Service Account Secret
serviceAccountUsername String: Field usage depends on service value: - Service mixpanel: Service Account Username
serviceAuthentication String: Field usage depends on service value: - Service dsv: A base64 encoded variant of your username:password string. Required for authentication.
serviceName String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service walmart_marketplace: Your Walmart Marketplace service name.
serviceVersion String
sftpHost String: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP host. - Service salesforce_marketing_cloud: Host
sftpIsKeyPair Boolean: Field usage depends on service value: - Service adobe_analytics_data_feed: Log in with key pair or password - Service salesforce_marketing_cloud: Set this field if you use a key pair for logging into your SFTP server. Don't set it if you use a username and password
sftpPassword String: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP password required if sftp_is_key_pair is false - Service salesforce_marketing_cloud: Password
sftpPort Double: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP port. - Service salesforce_marketing_cloud: Port
sftpPublicKey String: Field usage depends on service value: - Service adobe_analytics_data_feed: Public Key - Service salesforce_marketing_cloud: Public Key
sftpUser String: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP user. - Service salesforce_marketing_cloud: User
shareUrl String: Field usage depends on service value: - Service share_point: Your SharePoint folder URL. You can find the folder URL by following the steps mentioned here.
sheetId String: Field usage depends on service value: - Service google_sheets: 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.
shop String: Field usage depends on service value: - Service shopify: The Shopify shop name. Can be found in the URL before .myshopify.com.
shopDomain String: Field usage depends on service value: - Service triple_whale: Your Triple Whale shop domain.
shortCode String: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce eight-character string assigned to a realm for routing purposes.
shouldSyncEventsWithDeletedProfiles Boolean: Field usage depends on service value: - Service klaviyo: Sync events linked to deleted profiles
showRecordsWithNoMetrics Boolean: Field usage depends on service value: - Service apple_search_ads: Turn the toggle on if you want the reports to also return records without metrics.
sid String: Field usage depends on service value: - Service twilio: The Twilio API key SID
signerPublicKey String: Field usage depends on service value: - Service azure_blob_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service ftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service gcs: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service s3: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service sftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service wasabi_cloud_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed.
siteAddress String: Field usage depends on service value: - Service teamwork: Your Teamwork site address.
siteId String: Field usage depends on service value: - Service microsoft_lists: The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the id field in the Graph API response for sites. - Service salesforce_commerce_cloud: The name of the site from which you want to sync data.
siteName String: Field usage depends on service value: - Service microsoft_lists: The Name of the SharePoint site. The Site Name is the name field in the Graph API response for sites. - Service tableau_source: Your Tableau Source site name.
siteUrls List<String>: Field usage depends on service value: - Service google_search_console: Specific Site URLs to sync. Must be populated if sync_mode is set to SpecificSites.
skipAfter Double: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service box: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service dropbox: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service email: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service ftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service gcs: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service google_drive: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination. - Service sftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service share_point: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service wasabi_cloud_storage: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
skipBefore Double: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified before syncing data. - Service box: We will skip over the number of lines specified before syncing data. - Service dropbox: We will skip over the number of lines specified before syncing data. - Service email: We will skip over the number of lines specified before syncing data. - Service ftp: We will skip over the number of lines specified before syncing data. - Service gcs: We will skip over the number of lines specified before syncing data. - Service google_drive: We will skip over the number of lines specified before syncing data. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified before syncing data. - Service sftp: We will skip over the number of lines specified before syncing data. - Service share_point: We will skip over the number of lines specified before syncing data. - Service wasabi_cloud_storage: We will skip over the number of lines specified before syncing data.
skipEmptyReports Boolean: Field usage depends on service value: - Service google_ads: Toggles the "Skip empty reports" feature. Enabled by default
sncCertificate String
sncCertificateSource String
sncFivetranName String
sncLibraryPath String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Path to the external security product's library. - Service hana_sap_hva_s4_netweaver: Path to the external security product's library.
sncMode String
sncMyName String
sncName String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Client SNC name. - Service hana_sap_hva_s4_netweaver: Client SNC name.
sncPartnerName String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Communication partner's SNC name. - Service hana_sap_hva_s4_netweaver: Communication partner's SNC name.
sncSourceName String
soapUri String: Field usage depends on service value: - Service marketo: Marketo SOAP API Endpoint.
socialDataSyncTimeframe String: Field usage depends on service value: - Service linkedin_company_pages: The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: SIX .
source String: Field usage depends on service value: - Service adobe_analytics_data_feed: The data source.
storeHash String: Field usage depends on service value: - Service big_commerce: The BigCommerce store hash.
storeId String: Field usage depends on service value: - Service reviewsio: Your REVIEWS.io store ID
subDomain String: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS subdomain. - Service activecampaign: Your ActiveCampaign sub-domain. - Service acumatica: Your Acumatica subdomain. - Service ada: Your Ada sub-domain. - Service alchemer: Your Alchemer sub-domain. - Service atlassian_jira_align: Your Jira Align base URL. - Service azure_boards: Your Azure Boards Organization Name. - Service azure_devops: Your Azure Organization Name - Service betterworks: Your Betterworks subdomain. - Service bubble: Your Bubble subdomain. - Service buildium: Your Buildium subdomain. - Service canvas_by_instructure: Your Canvas by Instructure domain. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 subdomain. - Service chargebee_product_catalog_2: Your Chargebee subdomain. - Service checkr: Your Checkr subdomain. - Service clubspeed: Your Clubspeed subdomain. - Service collibra: Your collibra subdomain. - Service compliance_checkpoint: Your Compliance Checkpoint subdomain. - Service concord: Your Concord Sub Domain. - Service contrast_security: Your Contrast Security subdomain. - Service customerio: Your Customer.io region-specific Subdomain. - Service dbt_cloud: Your dbt Cloud API server region. - Service deputy: Your Deputy subdomain. - Service docebo: Your Docebo subdomain. - Service drata: Your Drata sub_domain. - Service eventsforce: Your Eventsforce subdomain. - Service ezofficeinventory: Your EZOfficeInventory Subdomain. - Service fountain: Your Fountain subdomain. - Service freshchat: Your Freshchat Sub Domain - Service gainsight_customer_success: The subdomain of your Gainsight account. - Service gainsight_product_experience: Your Gainsight Product Experience subdomain. - Service genesys: Your Genesys subdomain. - Service green_power_monitor: Your GreenPowerMonitor subdomain. - Service infobip: Your Infobip sub_domain. - Service insightly: Your company's Insightly subdomain name. - Service instructure: The Sub domain in which your Instructure account is hosted. - Service jamf: Your Jamf subdomain. - Service kandji: Your Kandji Subdomain. - Service khoros_care: Your Khoros Care subDomain. - Service looker_source: Your looker SubDomain name. - Service lucca: Your Lucca subdomain. - Service mailgun: Your Mailgun subdomain. - Service matomo: Your Matomo subdomain. - Service maxio_chargify: Enter Your Subdomain. - Service myosh: Your myosh subdomain. - Service namely: Your Namely subdomain. - Service nylas: Your Nylas subdomain. - Service okta: Your Okta subdomain. - Service picqer: Your Picqer subdomain. - Service pinpoint: Your Pinpoint sub domain name. - Service piwik_pro: Your Piwik PRO subdomain. - Service playvox: Your Playvox Subdomain. - Service posthog: Your PostHog data region (app or eu). - Service recurly: Your company's Recurly subdomain. - Service reltio: Your Reltio subdomain. - Service revel: Your Revel Systems subDomain. - Service rundeck: Your Rundeck subdomain. - Service sage_hr: Your Sage HR subdomain. - Service salesforce_marketing_cloud: Your Salesforce Marketing Cloud subdomain. - Service salsify: Your Salsify Organization ID. - Service sap_success_factors: Your SAP SuccessFactors Subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service starrez: Your StarRez subdomain - Service sugarcrm: Your SugarCRM subdomain. - Service tableau_source: Your Tableau Source subdomain. - Service tempo: Your Tempo subdomain. - Service testrail: Your TestRail subdomain. - Service thinkific: Your Thinkific subdomain. - Service totango: Your Totango Subdomain. - Service tymeshift: Your Tymeshift subdomain. - Service upland: Your Upland Software subDomain. - Service wordpress: Your WordPress subdomain. - Service workable: Your Workable Subdomain. - Service wrike: Your Wrike Subdomain.
subdomain String: Field usage depends on service value: - Service bamboohr: The subdomain used to access your account. If you access BambooHR at 'https://mycompany.bamboohr.com', then the subdomain is 'mycompany'. - Service datadog: Your Datadog subdomain. - Service ebay: Your eBay environment. - Service freshdesk: Your company's freshdesk subdomain (usually company.freshdesk.com). - Service freshsales: Your Freshsales domain. - Service freshservice: Your company's freshservice subdomain (usually company.freshservice.com). - Service freshsuccess: Your Freshsuccess subdomain. - Service gorgias: Your Gorgias subdomain. - Service jama_software: Your Jama Software subdomain. - Service klarna: Your Klarna subdomain. - Service learnupon: Your Learnupon subdomain. - Service maxio_saasoptics: Your Maxio SaaSOptics subdomain. - Service medallia: Medallia subdomain - Service packiyo: Your Packiyo subdomain. - Service qmatic_data_connect: Your Qmatic Data Connect subdomain. - Service sana: Your Sana subdomain. - Service skillstx: Your SkillsTX subdomain. - Service smarthr: Your SmartHR subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service toast: Your Toast domain. - Service vts: Your VTS Subdomain. - Service zendesk_chat: Your Zendesk domain.
subscriberName String: Field usage depends on service value: - Service azure_service_bus: 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
subscription String: Field usage depends on service value: - Service retailnext: Your RetailNext subscription.
subscriptionKey String: Field usage depends on service value: - Service dsv: Your DSV subscription key.
supportConnectedAccountsSync Boolean: Field usage depends on service value: - Service stripe: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts. - Service stripe_test: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.
supportNestedColumns Boolean: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
surveyIds String: Field usage depends on service value: - Service qualaroo: Array of Qualaroo Survey IDs.
swipeAttributionWindow String: Field usage depends on service value: - Service snapchat_ads: The time period to attribute conversions based on swipes. Default value: DAY_28
syncDataLocker Boolean: Field usage depends on service value: - Service appsflyer: Sync AppsFlyer Data Locker. Default value is true, set it to false to sync AppsFlyer data using only webhooks.
syncFormat String: Field usage depends on service value: - Service webhooks: The webhooks sync format. Default value: Unpacked. Unpacked messages must be valid JSON.
syncFormulaFields Boolean: Field usage depends on service value: - Service financial_force: Enable this option to sync formula fields directly (default value = false) - Service salesforce: Enable this option to sync formula fields directly (default value = false) - Service salesforce_sandbox: Enable this option to sync formula fields directly (default value = false)
syncMetadata Boolean: Field usage depends on service value: - Service facebook_ads: Parameter defining whether to enable or disable metadata synchronisation. Default value: TRUE.
syncMethod String: Field usage depends on service value: - Service aws_lambda: Sync Method
syncMode String: Field usage depends on service value: - Service adroll: Whether to sync all advertisables or specific advertisables. Default value: AllAdvertisables. - Service amazon_ads: Option to select connector should sync all profiles or specific profiles. - Service anaplan: Whether to sync all exports or specific exports. - Service apple_search_ads: Sync Mode - Service asana: Whether to sync all projects or specific projects. - Service bingads: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service double_click_campaign_manager: Whether to sync all user profiles or specific ones. Default value: AllAccounts. - Service dynamodb: Which packed mode setting to use. Default value: UsePackedModeOnly. - Service facebook: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_ad_account: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service facebook_ads: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_pages: Whether to sync all accounts or specific accounts. Default value: AllPages. - Service github: Whether to sync all repositories or specific repositories. - Service google_ads: Whether to sync all accounts or specific accounts. - Service google_analytics: Whether to sync all accounts or specific accounts. - Service google_analytics_4: Whether to sync all accounts or specific accounts. - Service google_analytics_mcf: Whether to sync all accounts or specific accounts. Default value: ALL_ACCOUNTS - Service google_search_console: Whether to sync all sites or specific sites. - Service instagram_business: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service iterable: Events Sync Mode. - Service jira: Whether to sync all projects or specific projects. - Service linkedin_ads: Whether to sync all accounts or specific accounts. Default value: AllAccounts - Service pendo: Whether to sync all App IDs or specific App IDs. Default value: AllAppIds. - Service pinterest_ads: Whether to sync all advertisers or specific advertisers. - Service reddit_ads: Whether to sync all accounts or specific accounts. - Service salesforce_marketing_cloud: Select the sync mode. - Service snapchat_ads: Whether to sync all organizations or specific organizations. Default value: AllOrganizations. - Service spotify_ads: Whether to sync all ad accounts or specific ad accounts. - Service taboola: Whether to sync all accounts or specific accounts. - Service the_trade_desk: Whether to sync all accounts or specific accounts. - Service tiktok_ads: Whether to sync all advertiser accounts or specific accounts. - Service twilio: Whether to sync all accounts or specific accounts. - Service twitter: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service twitter_ads: Whether to sync all accounts or specific accounts. - Service walmart_dsp: Whether to sync all accounts or specific accounts. - Service yahoo_gemini: Whether to sync all accounts or specific accounts. Default value: SpecificAccounts. - Service zuora: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both. - Service zuora_sandbox: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both.
syncModeAdvertiser String: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all advertisers or specific advertisers. Default value: ALL_ADVERTISERS.
syncModeSeat String: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all seats or specific seats. Default value: ALL_SEATS.
syncMultipleAccounts Boolean: Field usage depends on service value: - Service reddit_ads: 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
syncPackMode String: Field usage depends on service value: - Service cosmos: 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 Azure Cosmos DB Sync Pack Mode Options documentation. - Service documentdb: Indicates whether synced data will be packed into a single entry(column), or unpacked with one layer of nested fields.
syncPullApi Boolean: Field usage depends on service value: - Service appsflyer: These options are for Appsflyer's Pull API, and are only necessary for syncing events from Pull API.
syncType String: Field usage depends on service value: - Service apache_kafka: Kafka sync type. Unpacked messages must be valid JSON. - Service aws_msk: The sync type. Unpacked messages must be valid JSON. - Service azure_event_hub: Sync type. Unpacked messages must be valid JSON. - Service azure_service_bus: 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 - Service confluent_cloud: Kafka sync type. Unpacked messages must be valid JSON. - Service heroku_kafka: Heroku Kafka sync type. Unpacked messages must be valid JSON. - Service segment: The Segment connector sync type.
sysnr String
systemId String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
tableId String: Field usage depends on service value: - Service pigment: Your Pigment table ID.
tableName String: Field usage depends on service value: - Service airtable: Name of table in Airtable
tablesWithoutAccessUpdatedAt String: Field usage depends on service value: - Service hubspot: Timestamp to indicate when tables without access was updated
targetEntityId String: Field usage depends on service value: - Service culture_amp: Your Culture Amp Target entity ID.
targetHost String: Field usage depends on service value: - Service d2l_brightspace: Your D2L Brightspace target host.
tdeCertificate String: Field usage depends on service value: - Service sql_server_hva: Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Certificate used to protect a database encryption key
tdeCertificateName String: Field usage depends on service value: - Service sql_server_hva: Name of the Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Name of the Certificate used to protect a database encryption key
tdePassword String: Field usage depends on service value: - Service sql_server_hva: Password of the TDE private key - Service sql_server_sap_ecc_hva: Password of the TDE private key
tdePrivateKey String: Field usage depends on service value: - Service sql_server_hva: Private key associated with the TDE certificate - Service sql_server_sap_ecc_hva: Private key associated with the TDE certificate
teamId String: Field usage depends on service value: - Service asana: Team ID
technicalAccountId String: Field usage depends on service value: - Service adobe_analytics: Technical Account ID from the Service Account (JWT) credentials of your Adobe Project.
templateLabels List<String>: Field usage depends on service value: - Service mandrill: Provide the labels to filter the templates
tenant String: Field usage depends on service value: - Service microsoft_entra_id: Your Microsoft Entra ID Tenant. - Service microsoft_power_bi: Your Microsoft Power BI tenant. - Service microsoft_teams: Your Microsoft Teams Tenant. - Service unicommerce: Your uniware tenant. - Service workday: Workday tenant name - Service workday_financial_management: Workday tenant name - Service workday_hcm: Workday tenant name
tenantAppUrl String: Field usage depends on service value: - Service planful: Your Planful tenant app URL.
tenantCode String: Field usage depends on service value: - Service deposco: Your Deposco tenant code.
tenantConfigs List<GetConnectorConfigTenantConfig>: Field usage depends on service value: - Service reltio: * tenant(s)
tenantId String: Field usage depends on service value: - Service azure_sql_db: Azure AD tenant ID. - Service azure_sql_managed_db: Azure AD tenant ID. - Service business_central: Tenant ID of your Business Central application - Service crowddev: Your crowd.dev Tenant ID. - Service reltio: Your Reltio tenant ID. - Service servicetitan: Your ServiceTitan tenant ID. - Service visma: Your Visma tenant ID.
tenantName String: Field usage depends on service value: - Service mambu: Your Mambu tenant name.
tenantUrl String: Field usage depends on service value: - Service ivanti: Your Ivanti Tenant URL. - Service playvox_workforce_management: Your Playvox Workforce Management tenant URL. - Service reltio: Your Reltio tenant URL.
testTableName String: Field usage depends on service value: - Service sap_hana: testTableName - Service sap_s4hana: testTableName
timeZone String: Field usage depends on service value: - Service pardot: The time zone configured in your Pardot instance. An empty value defaults to UTC+00:00.
timeframeMonths String: Field usage depends on service value: - Service adobe_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector has been created. Default value: TWELVE . - Service adroll: 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. - Service apple_search_ads: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service bingads: 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. - Service criteo: 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. NOTE: The greater number of months means the initial sync will take more time. - Service double_click_campaign_manager: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service double_click_publishers: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service facebook: 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. - Service facebook_ads: 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. - Service google_ads: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: TWELVE. - Service google_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_4: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_mcf: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service google_display_and_video_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service google_search_ads_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service google_search_console: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service instagram_business: 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. - Service itunes_connect: Historical sync time frame in months. - Service linkedin_ads: 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. - Service outbrain: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service pinterest_ads: 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. - Service reddit_ads: 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. - Service snapchat_ads: 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. - Service spotify_ads: 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: SIX. - Service taboola: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service the_trade_desk: 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. - Service tiktok_ads: 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. - Service twitter: 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. - Service twitter_ads: Historical sync timeframe in months. - Service walmart_dsp: 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. - Service yahoo_dsp: Number of monthsworth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value:THREE. - Service yahoo_gemini: 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`.
timezone String: Field usage depends on service value: - Service rokt: Your Rokt timezone.
timezoneMode String: Field usage depends on service value: - Service apple_search_ads: Determines whether to use UTC or the users timezone from the apple account
tns String: Field usage depends on service value: - Service oracle_hva: Single-tenant database: The database's SID. Multi-tenant database: The database's TNS. - Service oracle_sap_hva: Single-tenant database: The database SID. Multi-tenant database: The database TNS.
toastId String: Field usage depends on service value: - Service toast: Your Toast Restaurant External ID.
token String: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities token. - Service matomo: Your Matomo auth token. - Service mode: Your Mode Token. - Service oracle_moat_analytics: Your Oracle Moat Analytics Token. - Service shareasale: Your ShareASale token. - Service solarwinds_service_desk: Your SolarWinds Service Desk token.
tokenAuthenticatedContainer String: Field usage depends on service value: - Service cosmos: The container name. Required for the RESOURCE_TOKEN data access method.
tokenAuthenticatedDatabase String: Field usage depends on service value: - Service cosmos: The database name. Required for the RESOURCE_TOKEN data access method.
tokenId String: Field usage depends on service value: - Service chargedesk: Your ChargeDesk token ID. - Service mux: Your Mux token ID
tokenKey String: Field usage depends on service value: - Service netsuite_suiteanalytics: Token ID - Service on24: Your ON24 token key. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Token Key.
tokenSecret String: Field usage depends on service value: - Service netsuite_suiteanalytics: Token Secret - Service on24: Your ON24 token secret.
tokenSecretKey String: Field usage depends on service value: - Service mux: Your Mux token secret key
tokenUrlRegion String: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP token URL region.
topics List<String>: Field usage depends on service value: - Service azure_service_bus: The comma-separated list of topics which should be synced. Required if you do not have manage permissions
trustStoreType String: Field usage depends on service value: - Service heroku_kafka: Trust Store Type
trustedCert String: Field usage depends on service value: - Service apache_kafka: Kafka trusted certificate. - Service heroku_kafka: Heroku Kafka trusted certificate. Required for TLS security protocol.
truststore String: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Truststore File as Base64 encoded string.
tunnelHost String: Field usage depends on service value: - Service aurora: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service aurora_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_cosmos_for_mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_managed_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service clarity: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service cockroachdb: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service db2i_hva: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service db2i_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service documentdb: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service dynamics_365_fo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service ehr: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service elastic_cloud: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service es_self_hosted: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service google_cloud_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_postgresql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_sqlserver: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_b1: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service heroku_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo_sharded: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service opendistro: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service opensearch: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service oracle: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_ebs: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rac: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_s4hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sftp: Tunnel host address, specify only to connect via SSH tunnel. - Service sql_server: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_sap_ecc_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
tunnelPort Double: Field usage depends on service value: - Service aurora: SSH port, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH port, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH port, specify only to connect via an SSH tunnel. - Service clarity: SSH port, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH port, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service documentdb: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH port, specify only to connect via an SSH tunnel. - Service ehr: SSH port, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH port, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH port, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH port, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service maria: SSH port, specify only to connect via an SSH tunnel. - Service maria_azure: SSH port, specify only to connect via an SSH tunnel. - Service maria_rds: SSH port, specify only to connect via an SSH tunnel. - Service mongo: SSH port, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH port, specify only to connect via an SSH tunnel. - Service mysql: SSH port, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH port, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service opendistro: SSH port, specify only to connect using an SSH tunnel. - Service opensearch: SSH port, specify only to connect using an SSH tunnel. - Service oracle: SSH port, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH port, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service postgres: SSH port, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH port, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH port, specify only to connect via an SSH tunnel. - Service sftp: Tunnel port, specify only to connect via SSH tunnel. - Service sql_server: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH port, specify only to connect via an SSH tunnel.
tunnelUser String: Field usage depends on service value: - Service aurora: SSH user, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH user, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH user, specify only to connect via an SSH tunnel. - Service clarity: SSH user, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH user, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service documentdb: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH user, specify only to connect via an SSH tunnel. - Service ehr: SSH user, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH user, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH user, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH user, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service maria: SSH user, specify only to connect via an SSH tunnel. - Service maria_azure: SSH user, specify only to connect via an SSH tunnel. - Service maria_rds: SSH user, specify only to connect via an SSH tunnel. - Service mongo: SSH user, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH user, specify only to connect via an SSH tunnel. - Service mysql: SSH user, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH user, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service opendistro: SSH user, specify only to connect using an SSH tunnel. - Service opensearch: SSH user, specify only to connect using an SSH tunnel. - Service oracle: SSH user, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH user, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service postgres: SSH user, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH user, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH user, specify only to connect via an SSH tunnel. - Service sftp: Tunnel user, specify only to connect via SSH tunnel. - Service sql_server: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH user, specify only to connect via an SSH tunnel.
typeName String: Field usage depends on service value: - Service akamai: Your Akamai type name. - Service bubble: Your Bubble type name.
uniqueId String
updateConfigOnEachSync Boolean: Field usage depends on service value: - Service google_display_and_video_360: 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.
updateMethod String: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service azure_postgres: 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. - Service azure_sql_db: (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. - Service azure_sql_managed_db: (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. - Service clarity: (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. - Service dynamics_365_fo: Update Method - Service ehr: (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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: (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. - Service heroku_postgres: 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. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Default value: Teleport - Service snowflake_db: Default value: Teleport - Service sql_server: (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. - Service sql_server_hva: (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. - Service sql_server_rds: (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. - Service sql_server_sap_ecc_hva: (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.
uri String: Field usage depends on service value: - Service cosmos: Cosmos resource instance address.
urlFormat String: Field usage depends on service value: - Service fountain: Your Fountain URL format.
useApiKeys Boolean: Field usage depends on service value: - Service mandrill: Whether to use multiple API keys for interaction.
useCustomerBucket Boolean: Field usage depends on service value: - Service appsflyer: Use Custom Bucket. Set it to 'true' if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket.
useOracleRac Boolean: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using a RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you're using a RAC instance.
usePgpEncryptionOptions Boolean: Field usage depends on service value: - Service azure_blob_storage: Set to true if files present in the Azure Blob Storage container are encrypted using PGP. Default value: false. - Service ftp: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service gcs: Set to true if files are encrypted using PGP in the GCS bucket. Default value: false. - Service s3: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service sftp: Set to true if files present in SFTP server are encrypted using PGP. Default value: false. - Service wasabi_cloud_storage: Set to true if files are encrypted using PGP in the Wasabi Cloud Storage bucket. Default value: false.
useServiceAccount Boolean: Field usage depends on service value: - Service bigquery_db: BigQuery use service account; default is false
useTemplateLabels Boolean: Field usage depends on service value: - Service mandrill: Use template labels to filter templates for sync
useWebhooks Boolean: Field usage depends on service value: - Service github: Set to true to capture deletes. - Service xero: Updates to few fields like sent_to_contact in Invoice table might be missed if you don't enable this.
useWorkspace Boolean: Field usage depends on service value: - Service bigquery_db: Create and drop tables in a query results dataset. Default is false - Service snowflake_db: Choose a database and schema to create temporary tables for syncs.
user String: Field usage depends on service value: - Service aurora: The user name. - Service aurora_postgres: The user name. - Service azure_cosmos_for_mongo: Username for source database access. - Service azure_postgres: The user name. - Service azure_sql_db: The user name. For Azure Databases, the format must be user@domain. - Service azure_sql_managed_db: The user name. For Azure Databases, the format must be user@domain. - Service clarity: The user name. For Azure Databases, the format must be user@domain. - Service cockroachdb: The user name. - Service db2i_hva: The user name. - Service db2i_sap_hva: The username. - Service documentdb: The user name. - Service dynamics_365_fo: The user name. The format must be user@domain. - Service ehr: The user name. For Azure Databases, the format must be user@domain. - Service elastic_cloud: The user name. - Service es_self_hosted: The user name. - Service ftp: FTP user. - Service google_cloud_mysql: The user name. - Service google_cloud_postgresql: The user name. - Service google_cloud_sqlserver: The user name. For Azure Databases, the format must be user@domain. - Service hana_sap_hva_b1: The username. - Service hana_sap_hva_ecc: The username. - Service hana_sap_hva_ecc_netweaver: The username. - Service hana_sap_hva_s4: The username. - Service hana_sap_hva_s4_netweaver: The username. - Service heroku_postgres: The user name. - Service jira: The Jira username. - Service magento_mysql: The user name. - Service magento_mysql_rds: The user name. - Service maria: The user name. - Service maria_azure: The user name. - Service maria_rds: The user name. - Service marin: The Marin username. - Service mongo: The user name. - Service mongo_sharded: The user name. - Service mysql: The user name. - Service mysql_azure: The user name. - Service mysql_rds: The user name. - Service opendistro: The user name. - Service opensearch: The user name. - Service oracle: The user name. - Service oracle_ebs: The user name. - Service oracle_hva: The user name. - Service oracle_rac: The user name. - Service oracle_rds: The user name. - Service oracle_sap_hva: The username. - Service oracle_sap_hva_netweaver: The username. - Service outbrain: The username or email of the Outbrain user. - Service postgres: The user name. - Service postgres_rds: The user name. - Service redshift_db: The Redshift username. - Service sap_hana: Your SAP HANA user name. - Service sap_s4hana: Your SAP S/4 user name. - Service sftp: SFTP user. - Service snowflake_db: The Snowflake username. - Service splunk: The Splunk username. - Service sql_server: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_hva: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_rds: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_sap_ecc_hva: The user name. For Azure Databases, the format must be user@domain.
userId String: Field usage depends on service value: - Service coassemble: Your Coassemble user ID. - Service gmail: Your Gmail user ID. - Service hibob: Your HiBob Service User Token. - Service marketo: Marketo SOAP API User Id. - Service okendo: Your Okendo user ID. - Service playvox: Your Playvox User ID. - Service sage_intacct: User ID - Service vimeo: Your Vimeo user ID.
userKey String
userName String: Field usage depends on service value: - Service workday: Workday username.
userProfiles List<String>: Field usage depends on service value: - Service double_click_campaign_manager: IDs of specific User Profiles to sync. Must be populated if sync_mode is set to SpecificAccounts.
userToken String: Field usage depends on service value: - Service hibob: Your HiBob Service User ID. - Service konnect_insights: Your Konnect Insights User Token. - Service sonarqube: Your Sonarqube user token.
username String: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS username. - Service adobe_commerce: Your Adobe Commerce username. - Service akeneo: Your Akeneo username. - Service anaplan: Your Anaplan user ID. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Username. - Service aveva_pi: Username for the user to authenticate as with the AF Server - Service ceridian_dayforce: Your Ceridian Dayforce Username. - Service churnzero: Your ChurnZero username. - Service cin7: Your Cin7 API Username. - Service collibra: Your collibra username. - Service compliance_checkpoint: Your Compliance Checkpoint account username. - Service concur: The SAP Concur username. - Service confluence: Your Confluence username. - Service contrast_security: Your Contrast Security API Username. - Service dcl_logistics: Your DCL Logistics username. - Service deposco: Your Deposco username. - Service github: Login of your GitHub profile. - Service gladly: Your Gladly Username. - Service globalmeet: Your GlobalMeet Username. - Service gorgias: Your Gorgias username. - Service green_power_monitor: Your GreenPowerMonitor username. - Service guru: Your Guru username. - Service hilti_ontrack: Your Hilti On!Track username. - Service impact: Your Impact Account SID - Service integral_ad_science: Your integral_ad_science username. - Service itunes_connect: Your Apple ID - Service jamf: Your Jamf username. - Service khoros_care: Your Khoros Care username. - Service kissmetrics: Your Kissmetrics API Username. - Service klarna: Your Klarna Username. - Service learnupon: Your Learnupon username. - Service lessonly: Your Lessonly username. - Service mailgun: Your Mailgun API username. - Service myosh: Your myosh username. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence username. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud username. - Service partnerize: Your Partnerize account's username. - Service pingdom: Your Pingdom Username. - Service podio: Your Podio account username. - Service qmatic_data_connect: Your Qmatic Data Connect username. - Service quorum: Your Quorum username . - Service revx: Your RevX Username. - Service rtb_house: Your RTB House username. - Service sap_business_by_design: The SAP Business ByDesign username. - Service scorm: Your Scorm App ID. - Service servicenow: Your ServiceNow User ID (username). - Service shiphero: Your ShipHero username. - Service shipstation: Your ShipStation username. - Service shopware: Your Shopware username. - Service splash: Your Splash username. - Service starrez: Your StarRez API username - Service stickyio: Your sticky.io username . - Service stylight: Your Stylight Username. - Service sugarcrm: Your SugarCRM username. - Service teamwork: Your Teamwork username. - Service testrail: Your TestRail username. - Service ukg_pro: Your UKG Pro username. - Service unicommerce: Your uniware login username. - Service upland: Your Upland Software Username. - Service veevavault: Your Veeva Vault username. - Service when_i_work: Your When I Work username. - Service wherefour: Your Wherefour username. - Service workday_financial_management: Workday username. - Service workday_hcm: Username of your Workday Integration System User account - Service xandr: Your Xandr username. - Service younium: Your Younium username.
version String: Field usage depends on service value: - Service criteo_retail_media: Your Criteo Retail Media version.
viewAttributionWindow String: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on views. Possible view_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'view' action. - Service snapchat_ads: The time period to attribute conversions based on views. Default value: DAY_1
viewId String: Field usage depends on service value: - Service pigment: Your Pigment view ID.
viewThroughAttributionWindowSize String: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on views. Default value: DAY_7
webServiceApiKey String: Field usage depends on service value: - Service adyen: Your Adyen Web Service API key.
webhookEndpoint String: Field usage depends on service value: - Service appsflyer: Webhook Url
webhookKey String: Field usage depends on service value: - Service xero: Webhook Key
webhookUrl String: Field usage depends on service value: - Service branch: Webhook URL - Service pipedrive: The registered URL for webhooks in your Pipedrive dashboard. - Service segment: Webhook URL. - Service xero: (ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO.
wordPressSiteIdOrWoocommerceDomainName String: Field usage depends on service value: - Service woocommerce: The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance.
workplaceId String: Field usage depends on service value: - Service moloco: Your Moloco workplace ID.
workspace String: Field usage depends on service value: - Service mode: Your Mode Workspace.
workspaceName String: Field usage depends on service value: - Service bigquery_db: Workspace Dataset Name - Service snowflake_db: The name of the database where the temporary tables will be created.
workspaceSameAsSource Boolean: Field usage depends on service value: - Service bigquery_db: Use the source dataset as the workspace dataset
workspaceSchema String: Field usage depends on service value: - Service snowflake_db: The name of the schema that belongs to the workspace database where the temporary tables will be created.
wsCertificate String: Field usage depends on service value: - Service adp_workforce_now: Web Services Certificate.
xApiKey String: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X API key.
xKey String: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research key.
xMasterKey String: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research master key.
xUserEmail String: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Email.
xUserToken String: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Token.

absConnectionMethod string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection method
absConnectionString string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection string. - Service braze: Connection String
absContainerAddress string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container address
absContainerName string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container name. - Service braze: Container Name
absHostIp string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage host IP
absHostUser string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage username
absPrefix string: Field usage depends on service value: - Service braze: Prefix
absPublicKey string: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage public key
academyId string: Field usage depends on service value: - Service workramp: Your WorkRamp academy ID.
accessId string: Field usage depends on service value: - Service planful: Your Planful access ID.
accessKey string: Field usage depends on service value: - Service gainsight_customer_success: The access key for API authentication. - Service gongio: Your Gongio Access key. - Service line_ads: Your LINE Ads access key. - Service planful: Your Planful access key. - Service retailnext: Your RetailNext access key.
accessKeyId string: Field usage depends on service value: - Service appsflyer: Your AWS access key ID. - Service aws_cost_report: Access Key ID - Service checkout: Your Checkout.com access key ID. - Service cloudtalk: Your CloudTalk Access Key ID. - Service nice: Your NICE access key ID. - Service s3: Access Key ID - Service wasabi_cloud_storage: Access Key ID
accessKeySecret string: Field usage depends on service value: - Service aws_cost_report: Access Key Secret - Service checkout: Your Checkout.com access key secret. - Service cloudtalk: Your CloudTalk Access Key Secret. - Service gongio: Your Gongio Access Key Secret. - Service nice: Your NICE access key secret. - Service s3: Access Key Secret - Service wasabi_cloud_storage: Access Key Secret
accessToken string: Field usage depends on service value: - Service 7shifts: Your 7shifts access token. - Service attio: Your Attio bearer token - Service big_commerce: API access token of your store. - Service bitly: Your Bitly access token. - Service calabrio: Your Calabrio access token. - Service coupa: Your Coupa access token fetched using client_id and client_secret - Service deputy: Your Deputy API access token. - Service getfeedback: Your GetFeedback Access token. - Service gocardless: Your GoCardless API token. - Service ironclad: Your Ironclad access token. - Service khoros_marketing: Your Khoros Marketing access token. - Service kustomer: Your Kustomer API key. - Service lattice: Your Lattice API access token. - Service launchdarkly: Your LaunchDarkly access token. - Service leap_crm: Your Leap CRM access token. - Service nylas: Your Nylas access_token. - Service planhat: Your Planhat access token. - Service rollbar: Your Rollbar Access Token. - Service samsara: Your Samsara API token. - Service slab: Your Slab API key. - Service stripe: The Stripe API Restricted Key - Service stripe_test: The Stripe API Restricted Key - Service talkwalker: Your Talkwalker access token. - Service workable: Your Workable Access Token. - Service workramp: Your WorkRamp access token.
accessType string: Field usage depends on service value: - Service share_point: Access Type
account string: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Account ID. - Service ordway: Your Ordway account type.
accountAccessToken string: Field usage depends on service value: - Service rollbar: Your Rollbar account access token.
accountId string: Field usage depends on service value: - Service appcues: Your Appcues Account ID. - Service brightcove: Your Brightcove account ID. - Service cin7core: Your Cin7 Core account ID. - Service dear: Your Dear Account ID. - Service harvest: Your Harvest Account ID. - Service optimizely: Your Optimizely account ID. - Service rokt: Your Rokt account ID. - Service udemy_business: Your Udemy Business account ID.
accountIds string[]: Field usage depends on service value: - Service taboola: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
accountKey string: Field usage depends on service value: - Service cosmos: The read-only primary or secondary account key for the database account. Required for the ACCOUNT_KEY data access method. - Service simplesat: Your Simplesat account key.
accountName string: Field usage depends on service value: - Service eventsforce: Your Eventsforce account name. - Service freshdesk_contact_center: Your Freshdesk Contact Center account name. - Service happyfox: Your HappyFox account name. - Service maxio_saasoptics: Your Maxio SaaSOptics account name. - Service talkdesk: Your Talkdesk Account Name. - Service udemy_business: Your Udemy Business account name.
accountPlan string: Field usage depends on service value: - Service tymeshift: Your Tymeshift account plan.
accountRegion string: Field usage depends on service value: - Service iterable: If your Iterable account URL starts with https://app.eu.iterable.com then provide EU else US
accountSid string: Field usage depends on service value: - Service fone_dynamics: Your Fone Dynamics account SID.
accountSyncMode string: Field usage depends on service value: - Service itunes_connect: Account Sync Mode
accountToken string: Field usage depends on service value: - Service konnect_insights: Your Konnect Insights Account Token.
accountType string: Field usage depends on service value: - Service freightview: Your Freightview Account Type.
accounts string[]: Field usage depends on service value: - Service bingads: Specific accounts to sync. Must be populated if syncMode is set to SpecificAccounts. - Service facebook: List of accounts of which connector will sync the data. - Service facebook_ad_account: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service facebook_ads: List of accounts of which connector will sync the data. - Service google_ads: The list of Account IDs to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service google_analytics: The list of specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_4: The list of specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_analytics_mcf: Specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_search_ads_360: Specific accounts to sync. Must be populated if accountsSyncMode is set to SPECIFIC_ACCOUNTS. - Service instagram_business: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service itunes_connect: Accounts - Service linkedin_ads: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service spotify_ads: The list of Ad Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service tiktok_ads: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twilio: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
accountsRedditAds GetConnectorConfigAccountsRedditAd[]: Field usage depends on service value: - Service reddit_ads: Accounts
accountsSyncMode string: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all accounts or specific.
actionBreakdowns string[]: Field usage depends on service value: - Service facebook: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
actionReportTime string: Field usage depends on service value: - Service facebook: The report time of action stats. Possible action_report time values.
adAnalytics string: Field usage depends on service value: - Service linkedin_ads: Whether to sync all analytic reports or specific. Default value: AllReports
adUnitView string: Field usage depends on service value: - Service double_click_publishers: Ad unit view for the report.
adminApiKey string: Field usage depends on service value: - Service splitio: Your Split admin api key.
adobeAnalyticsConfigurations GetConnectorConfigAdobeAnalyticsConfiguration[]: Field usage depends on service value: - Service adobe_analytics: 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.
advertisables string[]: Field usage depends on service value: - Service adroll: Specific advertisables to sync. Must be populated if sync_mode is set to SpecificAdvertisables.
advertisers string[]: Field usage depends on service value: - Service google_display_and_video_360: The list of advertisers to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service google_search_ads_360: Specific advertisers to sync. Must be populated if advertisersSyncMode is set to SPECIFIC_ADVERTISERS. - Service pinterest_ads: Specific Advertisers to sync. Must be populated if sync_mode is set to SpecificAdvertisers.
advertisersIds string[]: Field usage depends on service value: - Service yahoo_gemini: Specific Advertiser IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
advertisersSyncMode string: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all or specific advertisers.
advertisersWithSeats string[]: Field usage depends on service value: - Service yahoo_dsp: Specific Advertisers to sync. Must be populated if sync_mode_advertiser is set to SPECIFIC_ADVERTISERS. Pay attention to the format: AdvertiserId:SeatId
agentConfigMethod string
agentHost string: Field usage depends on service value: - Service db2i_hva: The agent host. - Service db2i_sap_hva: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service oracle_hva: The host of the agent. This is the same as database host, since the agent must be installed in the same machine as source database. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service sql_server_hva: The host address of the machine running the agent. Often the same as the DB host. - Service sql_server_sap_ecc_hva: The host address of the machine running the agent. Often the same as the DB host.
agentId string: Field usage depends on service value: - Service phoenix_ads: Your Phoenix Ads Agent ID.
agentOraHome string: Field usage depends on service value: - Service oracle_hva: The home directory of the Oracle database. - Service oracle_sap_hva: The home directory of the Oracle database.
agentPassword string: Field usage depends on service value: - Service db2i_hva: The agent password. - Service db2i_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_b1: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_hva: The agent user's password. It should have a minimum length of 10 characters. - Service oracle_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_sap_hva_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service sql_server_hva: The password for the agent user. - Service sql_server_sap_ecc_hva: The password for the agent user.
agentPort number: Field usage depends on service value: - Service db2i_hva: The agent port. - Service db2i_sap_hva: The port number of the agent. - Service hana_sap_hva_b1: The port number of the agent. - Service hana_sap_hva_ecc: The port number of the agent. - Service hana_sap_hva_ecc_netweaver: The port number of the agent. - Service hana_sap_hva_s4: The port number of the agent. - Service hana_sap_hva_s4_netweaver: The port number of the agent. - Service oracle_hva: The port number of the agent. - Service oracle_sap_hva: The port number of the agent. - Service oracle_sap_hva_netweaver: The port number of the agent. - Service sql_server_hva: The port that the agent has open for Fivetran's connection. Default value is 4343. - Service sql_server_sap_ecc_hva: The port that the agent has open for Fivetran's connection. Default value is 4343.
agentPublicCert string: Field usage depends on service value: - Service db2i_hva: The public certificate for the agent. - Service db2i_sap_hva: The agent public certificate. - Service hana_sap_hva_b1: The agent public certificate. - Service hana_sap_hva_ecc: The agent public certificate. - Service hana_sap_hva_ecc_netweaver: The agent public certificate. - Service hana_sap_hva_s4: The agent public certificate. - Service hana_sap_hva_s4_netweaver: The agent public certificate. - Service oracle_hva: The agent public certificate. - Service oracle_sap_hva: The agent public certificate. - Service oracle_sap_hva_netweaver: The agent public certificate. - Service sql_server_hva: The public certificate generated by the agent. - Service sql_server_sap_ecc_hva: The public certificate generated by the agent.
agentUser string: Field usage depends on service value: - Service db2i_hva: The agent user name. - Service db2i_sap_hva: The agent's user. - Service hana_sap_hva_b1: The agent's user. - Service hana_sap_hva_ecc: The agent's user. - Service hana_sap_hva_ecc_netweaver: The agent's user. - Service hana_sap_hva_s4: The agent's user. - Service hana_sap_hva_s4_netweaver: The agent's user. - Service oracle_hva: The agent's user. - Service oracle_sap_hva: The agent's user. - Service oracle_sap_hva_netweaver: The agent's user. - Service sql_server_hva: The agent's username. - Service sql_server_sap_ecc_hva: The agent's username.
aggregation string: Field usage depends on service value: - Service facebook: Options to select aggregation duration. Possible aggregation values.
agreementGrantToken string: Field usage depends on service value: - Service economic: Your E-conomic X-AgreementGrantToken goes here.
alwaysEncrypted boolean: Field usage depends on service value: - Service aurora: Require TLS through Tunnel - Service aurora_postgres: Require TLS through Tunnel - Service azure_cosmos_for_mongo: Require TLS - Service azure_postgres: Require TLS through Tunnel - Service azure_sql_db: Require TLS through Tunnel. - Service azure_sql_managed_db: Require TLS. - Service clarity: Require TLS through Tunnel. - Service cockroachdb: Require TLS - Service db2i_hva: Require TLS through Tunnel - Service db2i_sap_hva: Require TLS through Tunnel - Service documentdb: Require TLS encryption. - Service dynamics_365_fo: Require TLS through Tunnel. - Service ehr: Require TLS through Tunnel. - Service elastic_cloud: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service es_self_hosted: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service google_cloud_mysql: Require TLS through Tunnel - Service google_cloud_postgresql: Require TLS through Tunnel - Service google_cloud_sqlserver: Require TLS. - Service heroku_postgres: Require TLS through Tunnel - Service magento_mysql: Require TLS through Tunnel - Service magento_mysql_rds: Require TLS through Tunnel - Service maria: Require TLS through Tunnel - Service maria_azure: Require TLS through Tunnel - Service maria_rds: Require TLS through Tunnel - Service mongo: Require TLS - Service mongo_sharded: Require TLS through Tunnel - Service mysql: Require TLS through Tunnel - Service mysql_azure: Require TLS through Tunnel - Service mysql_rds: Require TLS through Tunnel - Service opendistro: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service opensearch: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service oracle: Require TLS through Tunnel - Service oracle_ebs: Require TLS through Tunnel - Service oracle_hva: Require TLS through Tunnel - Service oracle_rac: Require TLS through Tunnel - Service oracle_rds: Require TLS through Tunnel - Service oracle_sap_hva: Require TLS through Tunnel - Service oracle_sap_hva_netweaver: Require TLS. - Service postgres: Require TLS through Tunnel - Service postgres_rds: Require TLS through Tunnel - Service sql_server: Require TLS. - Service sql_server_hva: Require TLS. - Service sql_server_rds: Require TLS. - Service sql_server_sap_ecc_hva: Require TLS.
api string: Field usage depends on service value: - Service freshsuccess: Set this parameter to api.
apiAccessToken string: Field usage depends on service value: - Service flywheel_digital: Your Flywheel Digital API access token. - Service shopify: API access token of your custom app. - Service square: The Square API access token of your application.
apiEnvironment string: Field usage depends on service value: - Service afterpay: Your Afterpay API environment.
apiId string: Field usage depends on service value: - Service aircall: Your Aircall API ID.
apiKey string: Field usage depends on service value: - Service 15five: Your 15five API key. - Service 360learning: Your 360Learning API Key. - Service 6sense: Your 6sense API Key. - Service acculynx: Your Acculynx API key. - Service activecampaign: Your ActiveCampaign API key. - Service affinity: Your Affinity API key. - Service airtable: API key of the Airtable account. - Service algolia: Your Algolia API key. - Service anvyl: Your Anvyl API key. - Service appcues: Your Appcues API key. - Service ashby: Your Ashby API key. - Service assembled: Your Assembled API key. - Service atlassian_jira_align: Your Jira Align API key. - Service atlassian_ops_genie: Your Opsgenie API key - Service attentive: Your Attentive API key. - Service aumni: Your Aumni API key. - Service avantlink: Your AvantLink API key. - Service ballotready: Your BallotReady API token. - Service bamboohr: Your API Key. - Service bazaarvoice: Your Bazaarvoice API key. - Service betterworks: Your Betterworks API key. - Service bigmarker: Your BigMarker API key. - Service bizzabo: Your Bizzabo API key. - Service brave_ads: Your Brave Ads API key - Service braze: Your Braze API Key. - Service brevo: Your Brevo API key. - Service bubble: Your Bubble API token. - Service buildium: Your Buildium private API key. - Service callrail: Your CallRail API key. - Service campaignmonitor: Your Campaign Monitor API key. - Service canny: Your Canny API key. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 API key. - Service chargebee_product_catalog_2: Your Chargebee API key. - Service chartmogul: Your ChartMogul API key. - Service chorusai: Your Chorus API key. - Service churnkey: Your Churnkey API Key. - Service churnzero: Your ChurnZero API key. - Service cimis: Your Cimis API key. - Service circleci: Your CircleCI API Key. - Service clickup: Your ClickUp API key. - Service clockify: Your Clockify API key. - Service clockodo: Your Clockodo API key. - Service close: Your Close API key. - Service cloudbeds: Your Cloudbeds API key. - Service clubspeed: Your Clubspeed API key. - Service coassemble: Your Coassemble API key. - Service codefresh: Your Codefresh API Key. - Service column: Your Column API key. - Service concord: Your Concord API key. - Service confluent_cloud: API Key - Service contrast_security: Your Contrast Security API Key. - Service copper: Your Copper API key. - Service coupa: Your Coupa API key. - Service datadog: Your Datadog API key. - Service dbt_cloud: Your dbt Cloud service token. - Service dcl_logistics: Your DCL Logistics API key. - Service delighted: API Key for your Delighted account - Service destini: Your Destini API Key. - Service donus: Your Donus API key. - Service doorloop: Your DoorLoop API key. - Service drata: Your Drata API Key. - Service dropbox_sign: Your Dropbox Sign API key. - Service duoplane: Your Duoplane API key. - Service easypost: Your EasyPost API Key. - Service electronic_tenant_solutions: Your Electronic Tenant Solutions API key. - Service eventsforce: Your Eventsforce API secret key. - Service everflow: Your Everflow API key. - Service everhour: Your Everhour API Token. - Service expensein: Your ExpenseIn API key. - Service factorial: Your Factorial API key. - Service firehydrant: Your FireHydrant API key. - Service float: Your Float API key. - Service forj_community: Your Forj Community API key. - Service fourkites: Your FourKites API key. - Service freightview: Your Freightview API key. - Service freshdesk: Your Freshdesk API Key. - Service freshdesk_contact_center: Your Freshdesk Contact Center API key. - Service freshsales: Your Freshsales API key. - Service freshservice: Your Freshservice API Key. - Service freshsuccess: Your Freshsuccess API key. - Service freshteam: Your Freshteam API key. - Service friendbuy: Your Friendbuy API key. - Service fullstory: Your Fullstory API key. - Service gainsight_product_experience: Your Gainsight Product Experience API key. - Service gem: Your Gem API key. - Service gorgias: Your Gorgias API key. - Service greenhouse: Your Greenhouse API key. - Service grepsr: Your Grepsr API Key. - Service grin: Your Grin API key. - Service happyfox: Your HappyFox API key. - Service height: Your Height API key. - Service helpshift: Your Helpshift API Key. - Service incidentio: Your incident.io API key. - Service infobip: Your Infobip API key. - Service insightly: Your Insightly API key. - Service integrate: Your Integrate API key. - Service invoiced: Your Invoiced API key. - Service iterable: Your Iterable API key. - Service ivanti: Your Ivanti API Key. - Service jotform: Your Jotform API key. - Service justcall: Your JustCall API key. - Service katana: Your Katana API key. - Service kevel: Your Kevel API key. - Service keypay: Your KeyPay API key. - Service kisi: Your Kisi API key. - Service klaviyo: Your Klaviyo API key. - Service learnupon: Your Learnupon API key. - Service lemlist: Your Lemlist API key. - Service lever: Your Lever API key. - Service liftoff: Your Liftoff API key. - Service linear: Your Linear API key. - Service linksquares: Your LinkSquares API key. - Service lob: Your Lob API key. - Service loop: Your Loop API key. - Service lucca: Your Lucca API key. - Service luma: Your Luma API key. - Service maileon: Your Maileon API key. - Service mailgun: Your Mailgun API key. - Service mailjet: Your Mailjet API key. - Service malomo: Your Malomo API key. - Service mambu: Your Mambu API key. - Service mandrill: Your Mandrill API key. - Service maxio_chargify: Enter Your API Key. - Service messagebird: Your MessageBird API key. - Service mountain: Your MNTN API key. - Service myosh: Your myosh API key. - Service okendo: Your Okendo API key. - Service ometria: Your Ometria API Key. - Service oncehub: Your OnceHub API key. - Service ordway: Your Ordway API key. - Service ortto: Your Ortto API key. - Service pagerduty: Your PagerDuty API key. - Service pandadoc: Your PandaDoc API key. - Service papershift: Your Papershift API Key - Service partnerize: Your Partnerize user API key. - Service persona: Your Persona API key. - Service picqer: Your Picqer API key. - Service pigment: Your Pigment API key. - Service pinpoint: Your Pinpoint API key. - Service pipe17: The Pipe17 API key. - Service placerai: Your Placer.ai API key. - Service playvox: Your Playvox API Key. - Service posthog: Your PostHog API key. - Service prive: Your Prive API key. - Service prosperstack: Your ProsperStack API key. - Service qualaroo: Your Qualaroo API Key. - Service quorum: Your Quorum API key. - Service rebound_returns: Your ReBound Returns API key. - Service recurly: The Recurly API key. - Service replyio: Your Reply API key. - Service revenuecat: Your RevenueCat API key. - Service reviewsio: Your REVIEWS.io API key. - Service revops: Your RevOps bearer token. - Service ricochet360: Your Ricochet360 API key. - Service ringover: Your Ringover API key. - Service rippling: Your Rippling API key. - Service rocketlane: Your Rocketlane API key. - Service rootly: Your Rootly API key. - Service ruddr: Your Ruddr API key. - Service safebase: Your SafeBase API key. - Service sage_hr: Your Sage HR API key. - Service sailthru: The Sailthru API key. - Service salsify: Your Salsify API Key. - Service security_journey: Your Security Journey API key. - Service sendgrid: The SendGrid API key. - Service sendinblue: Your Sendinblue API key. - Service shortcut: Your Shortcut API token. - Service shortio: Your Short.io API key. - Service simplesat: Your Simplesat API key. - Service sistrix: Your SISTRIX API key. - Service skilljar: Your Skilljar API key. - Service smartwaiver: Your Smartwaiver API key. - Service snyk: Your Snyk API key. - Service sonarqube: Your Sonarqube API key. - Service sparkpost: Your SparkPost API key. - Service squarespace: Your Squarespace API key. - Service stackadapt: Your StackAdapt API key. - Service statuspage: Your Statuspage API Key. - Service stripe: Restricted API key - Service stripe_test: Restricted API key - Service subscript: Your Subscript API key. - Service survicate: Your Survicate API Key. - Service teads: Your Teads API key. - Service teamtailor: Your Teamtailor API key. - Service testrail: Your TestRail API key. - Service ticket_tailor: Your Ticket Tailor API key. - Service transcend: Your Transcend API key. - Service trello: Your TRELLO api key. - Service triple_whale: Your Triple Whale API key. - Service uppromote: Your UpPromote API key. - Service veeqo: Your Veeqo API key. - Service venminder: Your Venminder API key. - Service visit_by_ges: Your Visit by GES API key. - Service vitally: Your Vitally API key. - Service vonage: Your Vonage API Key. - Service vts: Your VTS API key. - Service webconnex: Your Webconnex API key. - Service wicked_reports: Your Wicked Reports API key. - Service workleap_officevibe: Your Workleap Officevibe API key. - Service xsolla: Your Xsolla API key. - Service yougov_sport: Your Yougov Sport API key. - Service zingtree: Your Zingtree API key. - Service zip: Your Zip API key.
apiKeyApiSecret string: Field usage depends on service value: - Service revel: Your Revel Systems API Key and API Secret.
apiKeys string[]: Field usage depends on service value: - Service mandrill: Comma-separated list of API keys. Required if use_api_keys is set to true.
apiPassword string: Field usage depends on service value: - Service duoplane: Your Duoplane API password.
apiQuota number: Field usage depends on service value: - Service marketo: Allowed number of API requests to Marketo instance per day, the default value is 10000.
apiReadAccessToken string: Field usage depends on service value: - Service the_movie_database: Your The Movie Database API read access token.
apiRequestsPerMinute number: Field usage depends on service value: - Service qualtrics: Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
apiSecret string: Field usage depends on service value: - Service confluent_cloud: API Secret - Service forj_community: Your Forj Community API secret. - Service friendbuy: Your Friendbuy API secret. - Service justcall: Your JustCall API secret. - Service liftoff: Your Liftoff API secret. - Service mixpanel: Mixpanel API Secret. - Service qualaroo: Your Qualaroo API Secret. - Service sailthru: The Sailthru API secret. - Service shareasale: Your ShareASale API secret. - Service vonage: Your Vonage API Secret.
apiSecretKey string: Field usage depends on service value: - Service alchemer: Your Alchemer API Secret key.
apiServer string: Field usage depends on service value: - Service sigma_computing_source: Your Sigma Computing api server.
apiToken string: Field usage depends on service value: - Service aha: Your Aha! API key. - Service aircall: Your Aircall API Token. - Service appsflyer: API Token for AppsFlyer's PULL API. - Service awin: Your Awin API Token. - Service backbone_plm: Your Backbone PLM API token. - Service brex: Your Brex API token - Service buildkite: Your Buildkite API token. - Service buzzsprout: Your Buzzsprout API token. - Service centra: Your Centra API token. - Service chameleon: Your Chameleon API token. - Service clari: Your Clari API token. - Service cloudflare_analytics: Your Cloudflare Analytics API token. - Service confluence: The Confluence API token. - Service dixa: Your Dixa API token. - Service drip: Your Drip API Token. - Service factbird: Your Factbird API token. - Service fone_dynamics: Your Fone Dynamics API token. - Service fountain: Your Fountain API token. - Service g2: Your G2 API token. - Service gladly: Your Gladly API Token. - Service hibob: Your Hibob API token. - Service kandji: Your Kandji API token. - Service livechat: Your Livechat Access token. - Service livechat_partner: Your Livechat Partner API Token. - Service maxio_saasoptics: Your Maxio SaaSOptics API token. - Service megaphone: Your Megaphone API token. - Service missive: Your Missive API token. - Service mixmax: Mixmax API token. - Service okta: Your Okta API token. - Service ordway: Your Ordway API token. - Service packiyo: Your Packiyo API token. - Service pipedrive: (Optional)Your Pipedrive personal API token - Service pivotal_tracker: Pivotal Tracker API token. - Service postmark: Your Postmark account API token. - Service productive: Your Productive API token. - Service qualtrics: API token of the Qualtrics account. - Service rakutenadvertising: Your Rakuten Advertising API token. - Service recharge: The Recharge API token. - Service referralhero: Your Referralhero API token. - Service resource_management_by_smartsheet: Your Resource Management by Smartsheet API token. - Service retently: Your Retently API token. - Service reviewsai: Your REVIEWS.ai API token. - Service rundeck: Your Rundeck API token. - Service safetyculture: Your SafetyCulture API token. - Service sensor_tower: Your Sensor Tower API token. - Service sentry: Your Sentry auth token. - Service simplecast: Your Simplecast API token. - Service snyk: Your Snyk API token. - Service textus: Your TextUs API token. - Service toggl_track: Your Toggl Track API token - Service trello: Your TRELLO api token. - Service trisolute: Your Trisolute API token. - Service vwo: Your VWO API token. - Service web_scraper: Your Web Scraper API token. - Service zendesk: Zendesk API tokens are auto-generated passwords in the Support admin interface. - Service zendesk_sunshine: Zendesk API tokens are auto-generated passwords in the Support admin interface.
apiType string
apiUrl string: Field usage depends on service value: - Service braze: Your Braze API URL.
apiUrlRegion string: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP API URL region.
apiUsage string: Field usage depends on service value: - Service zendesk: Maximum Zendesk Api Usage allowed
apiUserIdentifier string: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user identifier.
apiUserSecret string: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user secret.
apiUtilizationPercentage string: Field usage depends on service value: - Service kustomer: Api Utilization Percentage
apiVersion string: Field usage depends on service value: - Service pardot: API Version
appId string: Field usage depends on service value: - Service churnkey: Your Churnkey APP ID. - Service open_exchange_rates: Your Open Exchange Rates App Id. - Service rokt: Your Rokt app ID.
appIds string[]: Field usage depends on service value: - Service pendo: Specific App IDs to sync. Must be populated if sync_mode is set to SpecificAppIds.
appIdsAppsflyers GetConnectorConfigAppIdsAppsflyer[]: Field usage depends on service value: - Service appsflyer: * App ID(s)
appKey string: Field usage depends on service value: - Service loopio: Your Loopio App Key. - Service servicetitan: Your ServiceTitan app key. - Service yotpo: Your Yotpo App Key
appReference string: Field usage depends on service value: - Service brightpearl: Your Brightpearl app reference.
appSecret string: Field usage depends on service value: - Service rokt: Your Rokt app secret.
appSecretToken string
appSpecificPassword string: Field usage depends on service value: - Service itunes_connect: Your app-specific password
appSyncMode string: Field usage depends on service value: - Service itunes_connect: Whether to sync all apps or specific apps.
appendFileOption string: Field usage depends on service value: - Service aws_cost_report: If you know that the source completely overwrites the same file with new data, you can append the changes instead of upserting based on filename and line number. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
applicationId string: Field usage depends on service value: - Service algolia: Your Algolia application ID. - Service xactly: Your Xactly Application ID.
applicationKey string: Field usage depends on service value: - Service cin7core: Your Cin7 Core application key. - Service datadog: Your Datadog application key. - Service dear: Your Dear Application key. - Service partnerize: Your Partnerize user application key.
apps string[]: Field usage depends on service value: - Service itunes_connect: Specific apps to sync. Must be populated if app_sync_mode is set to SpecificApps.
archiveLogFormat string: Field usage depends on service value: - Service sql_server_hva: Format for archive log file names - Service sql_server_sap_ecc_hva: Format for archive log file names
archiveLogPath string: Field usage depends on service value: - Service sql_server_hva: Directory where archive logs are located - Service sql_server_sap_ecc_hva: Directory where archive logs are located
archivePattern string: Field usage depends on service value: - Service aws_cost_report: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service azure_blob_storage: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service box: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service dropbox: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service email: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service ftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service gcs: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service google_drive: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service kinesis: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service s3: Files inside compressed archives with filenames matching this regular expression will be synced. - Service sftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service share_point: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service wasabi_cloud_storage: Files inside compressed archives with filenames matching this regular expression will be synced.
areSoapCredentialsProvided boolean: Field usage depends on service value: - Service marketo: Marketo SOAP credentials provided.
asbIp string: Field usage depends on service value: - Service azure_service_bus: The IP address (or) the URL of ASB namespace
asmOption boolean: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using ASM on a non-RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you are using ASM on a non-RAC instance.
asmOracleHome string: Field usage depends on service value: - Service oracle_hva: ASM Oracle Home path. - Service oracle_sap_hva: The Oracle ASM home directory.
asmPassword string: Field usage depends on service value: - Service oracle_hva: ASM password. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user's password. Mandatory if use_oracle_rac or asm_option is set to true.
asmTns string: Field usage depends on service value: - Service oracle_hva: ASM TNS. - Service oracle_sap_hva: ASM TNS.
asmUser string: Field usage depends on service value: - Service oracle_hva: ASM user. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user. Mandatory if use_oracle_rac or asm_option is set to true.
attributionWindow string: Field usage depends on service value: - Service amazon_ads: Time period used to attribute conversions based on clicks.
attributionWindowSize string: Field usage depends on service value: - Service tiktok_ads: Rollback sync duration to capture conversions. Set this to your configured attribution window in TikTok Ads. The default value is 7 days.
audience string: Field usage depends on service value: - Service auth0: Your Auth0 API audience.
auth string: Field usage depends on service value: - Service databricks_db: Token-based authentication type - Service redshift_db: Password-based authentication type - Service snowflake_db: Password-based or key-based authentication type
authCode string: Field usage depends on service value: - Service happyfox: Your HappyFox auth code.
authEnvironment string: Field usage depends on service value: - Service younium: Your Younium auth environment.
authMethod string: Field usage depends on service value: - Service aurora_postgres: Database authentication method - Service azure_postgres: Database authentication method - Service azure_sql_db: Authentication Method. - Service azure_sql_managed_db: Authentication Method. - Service google_cloud_postgresql: Database authentication method - Service heroku_postgres: Database authentication method - Service postgres: Database authentication method - Service postgres_rds: Database authentication method - Service sql_server_hva: Authentication Method - Service sql_server_sap_ecc_hva: Authentication Method - Service webhooks: The authentication mechanism you want to use
authMode string: Field usage depends on service value: - Service anaplan: The Anaplan authentication method. - Service concur: The Authentication Mode used by SAP Concur. It can be PasswordGrant or CompanyLevel auth mode - Service github: Authorization type.
authToken string: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback auth token.
authType string: Field usage depends on service value: - Service airtable: Type of authentication being used by connector - Service aws_cost_report: Access approach - Service azure_service_bus: The authentication mode to access the topic - Service dynamics_365: Authentication mechanism. Either one of OAUTH2, or SERVICE_PRINCIPAL. Default value OAUTH2 - Service gcs: Authorization type. Required for storage bucket authentication. - Service google_sheets: The OAuth value must be specified for this type of authorization. - Service jira: Authorization type. - Service mixpanel: Authentication Method - Service pardot: Authenticate using OAuth or HTTP Basic - Service qualtrics: Type of authentication being used by connector - Service s3: Access approach - Service wasabi_cloud_storage: The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: ACCESS_KEY.
authUrlRegion string: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP auth grant URL region.
authenticationMethod string: Field usage depends on service value: - Service adobe_analytics: Authentication Method - Service elastic_cloud: The authentication method used to connect to your cluster. - Service es_self_hosted: The authentication method used to connect to your cluster. - Service opendistro: The authentication method used to connect to your cluster. - Service opensearch: The authentication method used to connect to your cluster. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud authentication method. - Service salesforce: (Optional) Authentication type (default value = STANDARD) - Service salesforce_sandbox: (Optional) Authentication type (default value = STANDARD)
authorizationMethod string
awsRegionCode string: Field usage depends on service value: - Service dynamodb: The AWS region code for the DynamoDB instance, e.g. us-east-1.
backintConfigurationPath string
backintExecutablePath string
backwardSyncLimit string: Field usage depends on service value: - Service zendesk: Limit of the Historical Sync Time for selected tables
baseCurrency string: Field usage depends on service value: - Service open_exchange_rates: Your Open Exchange Rates Base Currency.
baseDomain string: Field usage depends on service value: - Service freshteam: Your company's Freshteam base domain name (usually company.freshteam.com).
baseId string: Field usage depends on service value: - Service airtable: ID of base in Airtable
baseUrl string: Field usage depends on service value: - Service aha: Your Aha! subdomain. - Service akeneo: Your Akeneo base URL. - Service billing_platform: Your BillingPlatform subdomain. - Service boostr: Your Boostr base URL. - Service brex: Your Brex Base URL - Service centra: Your Centra base URL. - Service cornerstone: Your Cornerstone base URL. - Service culture_amp: Your Culture Amp base URL. - Service datadog: Your Datadog base url. - Service factbird: Your Factbird base url. - Service fillout: Your Fillout Base URL. - Service financial_force: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service freshsales: Your Freshsales product. - Service gongio: Your Gong API Base URL. - Service ironclad: Your Ironclad base url. - Service jotform: Your Jotform base URL. - Service mailgun: Your Mailgun base URL. - Service nice: Your NICE base URL. - Service ortto: Your Ortto base URL. Possible values: api, api.au, api.eu. - Service prisma_cloud: Your Prisma Cloud admin console URL. - Service salesforce: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service salesforce_sandbox: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service stickyio: Your sticky.io base URL . - Service veevavault: Your Veeva Vault base URL. - Service vitally: Your Vitally base URL.
bearerToken string: Field usage depends on service value: - Service ada: Your Ada API Access Token. - Service crowddev: Your crowd.dev Auth Token. - Service customerio: Your Customer.io App API Key. - Service freshchat: Your Freshchat API Token. - Service hopin: Your Hopin API key. - Service orbit: Your Orbit API Token. - Service productboard: Your Productboard API key. - Service smarthr: Your SmartHR access token. - Service sprout: Your Sprout Social API Access Token. - Service zenefits: Your Zenefits bearer token.
blobSasUrl string: Field usage depends on service value: - Service webhooks: The blob SAS URL of your Azure container. Required if bucket_service is set to AZURE.
blockchain string: Field usage depends on service value: - Service rarible: Your Rarible Blockchain.
brandId string: Field usage depends on service value: - Service oracle_moat_analytics: Your Oracle Moat Analytics Brand ID.
breakdowns string[]: Field usage depends on service value: - Service facebook: List of breakdowns which connector will sync. Possible breakdowns values.
bucket string: Field usage depends on service value: - Service appsflyer: Customer S3 Bucket - Service aws_cloudtrail: The AWS bucket name which is configured for AWS CloudTrail. - Service aws_cost_report: The S3 bucket name with the AWS Cost and Usage Report - Service aws_inventory: The AWS bucket name that is configured for AWS Config. - Service aws_lambda: S3 Bucket - Service cloudfront: The bucket name for CloudFront. - Service gcs: The name of the GCS bucket. - Service google_play: The Google Cloud Storage source bucket. - Service heap: The S3 bucket name. - Service kinesis: The name of the Kinesis bucket. - Service s3: The S3 bucket name. Required for connector creation. - Service segment: The name of the Segment bucket. Must be populated if sync_type is set to S3. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket name. Required for connector creation.
bucketName string: Field usage depends on service value: - Service adjust: Your AWS S3 or GCS bucket. - Service google_analytics_360: The name of the bucket. - Service google_analytics_4_export: The name of the bucket.
bucketService string: Field usage depends on service value: - Service webhooks: Whether to store the events in Fivetran's container service or your S3 bucket. Default value: Fivetran.
businessAccounts string[]: Field usage depends on service value: - Service reddit_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
businessId string: Field usage depends on service value: - Service birdeye: Your Birdeye Business ID.
businessUnit string: Field usage depends on service value: - Service deposco: Your Deposco business unit.
businessUnitId string: Field usage depends on service value: - Service pardot: Business Unit Id
catalog string: Field usage depends on service value: - Service databricks_db: catalog to sync
certificate string: Field usage depends on service value: - Service anaplan: The contents of your PEM certificate file. Must be populated if auth_mode is set to Certificate. - Service qualtrics: Your Client Certificate - Service salesforce: Provide content of the .pem certificate (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .pem certificate (only when authentication_method = ADVANCED).
clickAttributionWindow string: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on clicks. Possible click_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'click' action.
client string
clientCert string: Field usage depends on service value: - Service apache_kafka: Kafka client certificate. - Service heroku_kafka: Heroku Kafka client certificate. Required for TLS security protocol.
clientCertKey string: Field usage depends on service value: - Service apache_kafka: Kafka client certificate key. - Service heroku_kafka: Heroku Kafka client certificate key. Required for TLS security protocol.
clientHost string: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Host.
clientId string: Field usage depends on service value: - Service acumatica: Your Acumatica client ID. - Service adobe_analytics: Client ID from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client ID. - Service adp_workforce_now: Your ADP Client ID. - Service akamai: Your Akamai client ID. - Service akeneo: Your Akeneo client ID. - Service auth0: Your Auth0 client ID. - Service autodesk_bim_360: Your Autodesk BIM 360 client ID. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Id - Service billing_platform: Your BillingPlatform client ID. - Service bing_webmaster_tools: Your Bing Webmaster Tools client ID. - Service brightcove: Your Brightcove client ID. - Service brightpearl: Your Brightpearl client ID. - Service buildium: Your Buildium API client ID. - Service canvas_by_instructure: Your Canvas by Instructure client ID. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure client ID. - Service castor_edc: Your Castor EDC client Id. - Service clazar: Your Clazar client ID. - Service cloudbeds: Your Cloudbeds client ID. - Service commercetools: Your commercetools client ID. - Service concur: The SAP Concur Client ID. - Service constant_contact: Your Constant Contact client ID. - Service cornerstone: Your Cornerstone client ID. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo Client ID. - Service criteo_retail_media: Your Criteo Retail Media client ID. - Service culture_amp: Your Culture Amp client ID. - Service cvent: Your Cvent client ID. - Service d2l_brightspace: Your D2L Brightspace client ID. - Service dialpad: Your Dialpad client ID. - Service ebay: Your eBay app ID. - Service exact_online: Your Exact Online client ID. - Service fillout: Your Fillout client ID. - Service flexport: The Flexport API Key. - Service formstack: Your Formstack client ID. - Service genesys: Your Genesys client ID. - Service hana_sap_hva_ecc_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hana_sap_hva_s4_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hilti_ontrack: Your Hilti On!Track client ID. - Service ilevel: Your iLevel Client ID. - Service instructure: Your Instructure client ID. - Service integral_ad_science: Your integral_ad_science client id. - Service ironclad: Your Ironclad client ID. - Service jama_software: Your Jama Software client ID. - Service jibble: Your Jibble client ID. - Service khoros_communities: Your Khoros Communities client ID. - Service looker_source: Your Looker Client ID. - Service marketo: Marketo REST API Client Id. - Service medallia: Medallia Client ID - Service microsoft_entra_id: Your Microsoft Entra ID Client ID. - Service microsoft_power_bi: Your Microsoft Power BI client ID. - Service microsoft_teams: Your Microsoft Teams Client ID. - Service navan: Your Navan client ID. - Service nice: Your NICE client ID. - Service on24: Your ON24 client ID. - Service oracle_sap_hva_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service paychex: Your Paychex client ID. - Service paypal: Client ID of your PayPal client application. - Service paypal_sandbox: Client ID of your PayPal client application. - Service personio: Your Personio Client ID. - Service piwik_pro: Your Piwik PRO client ID. - Service podio: Your Podio client ID. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client ID. - Service prisma_cloud: Your Prisma Cloud access key ID. - Service procore: Your Procore client ID. - Service quora_ads: Your Quora Ads client ID. - Service reltio: Your Reltio client ID. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client ID. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client ID. - Service salesloft: Client ID of your Salesloft client application. - Service sana: Your Sana client ID. - Service sap_success_factors: Your SAP SuccessFactors Client ID. - Service servicenow: ServiceNow Client ID. - Service servicetitan: Your ServiceTitan client ID. - Service sharetribe: Your Sharetribe client ID. - Service shipnetwork: Your ShipNetwork client ID. - Service sigma_computing_source: Your Sigma Computing client ID. - Service skillstx: Your SkillsTX client ID. - Service skimlinks: Your Skimlinks client ID. - Service smartrecruiters: Your SmartRecruiters client ID. - Service splash: Your Splash client ID. - Service square: The Application ID of your organization. - Service standard_metrics: Your Standard Metrics Client ID. - Service sugarcrm: Your SugarCRM client ID. - Service swoogo: Your Swoogo client Id. - Service taboola: The Taboola client ID. - Service talkdesk: The Client ID of your OAuth Client - Service tive: Your Tive client ID. - Service toast: Your Toast client ID. - Service trelica: Your Trelica client ID. - Service tremendous: Your Tremendous client ID. - Service tymeshift: Your Tymeshift email. - Service udemy_business: Your Udemy Business client ID. - Service vimeo: Your Vimeo client ID. - Service visma: Your Visma client ID. - Service vonage_contact_center: Your Vonage Contact Center client ID. - Service walmart_marketplace: Your Walmart Marketplace client ID. - Service xero: your clientId - Service xray: Your Xray Client ID. - Service yougov_sport: Your Yougov Sport client ID. - Service zendesk_chat: Your Zendesk client ID. - Service zoho_books: Your Zoho Books Client ID. - Service zoho_campaigns: Your Zoho Campaigns Client ID. - Service zoho_desk: Your Zoho Desk Client Id. - Service zoho_inventory: Your Zoho Inventory client ID. - Service zuora: Zuora Client ID. - Service zuora_sandbox: Zuora Client ID.
clientKey string: Field usage depends on service value: - Service appfigures: Your Appfigures Client Key. - Service thinkific: Your Thinkific client key. - Service yougov_sport: Your Yougov Sport client key.
clientName string: Field usage depends on service value: - Service destini: Your Destini Client Name. - Service medallia: Medallia company name
clientNamespace string: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Namespace.
clientPrivateKey string: Field usage depends on service value: - Service aurora_postgres: Client Private Key in .pem format. - Service azure_postgres: Client Private Key in .pem format. - Service google_cloud_postgresql: Client Private Key in .pem format. - Service heroku_postgres: Client Private Key in .pem format. - Service postgres: Client Private Key in .pem format. - Service postgres_rds: Client Private Key in .pem format.
clientPublicCertificate string: Field usage depends on service value: - Service aurora_postgres: Client Certificate in .pem format. - Service azure_postgres: Client Certificate in .pem format. - Service google_cloud_postgresql: Client Certificate in .pem format. - Service heroku_postgres: Client Certificate in .pem format. - Service postgres: Client Certificate in .pem format. - Service postgres_rds: Client Certificate in .pem format.
clientSecret string: Field usage depends on service value: - Service acumatica: Your Acumatica client secret. - Service adobe_analytics: Client Secret from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client secret. - Service adp_workforce_now: Your ADP Client Secret. - Service akamai: Your Akamai client secret. - Service akeneo: Your Akeneo client secret. - Service auth0: Your Auth0 client secret. - Service autodesk_bim_360: Your Autodesk BIM 360 client secret. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Secret - Service billing_platform: Your BillingPlatform client secret. - Service bing_webmaster_tools: Your Bing Webmaster Tools client secret. - Service brightcove: Your Brightcove client secret. - Service brightpearl: Your Brightpearl client secret. - Service canvas_by_instructure: Your Canvas by Instructure client secret. - Service castor_edc: Your Castor EDC Client Secret. - Service clazar: Your Clazar client secret. - Service cloudbeds: Your Cloudbeds client secret. - Service commercetools: Your commercetools client secret. - Service concur: The SAP Concur Client secret. - Service constant_contact: Your Constant Contact client secret. - Service cornerstone: Your Cornerstone client secret. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo client secret key. - Service criteo_retail_media: Your Criteo Retail Media client secret. - Service culture_amp: Your Culture Amp client secret. - Service cvent: Your Cvent client secret. - Service d2l_brightspace: Your D2L Brightspace client secret. - Service dialpad: Your Dialpad client secret. - Service ebay: Your eBay cert ID. - Service exact_online: Your Exact Online client secret. - Service fillout: Your Fillout client secret - Service flexport: The Flexport API Secret. - Service formstack: Your Formstack client secret. - Service genesys: Your Genesys client secret. - Service hilti_ontrack: Your Hilti On!Track client secret. - Service ilevel: Your iLevel Client Secret. - Service instructure: Your Instructure client secret. - Service integral_ad_science: Your integral_ad_science client secret. - Service ironclad: Your Ironclad client secret. - Service jama_software: Your Jama Software client secret. - Service jibble: Your Jibble client secret. - Service looker_source: Your Looker Client Secret. - Service marketo: Marketo REST API Client Secret. - Service medallia: Medallia Client Secret key - Service microsoft_entra_id: Your Microsoft Entra ID Client Secret. - Service microsoft_power_bi: Your Microsoft Power BI client secret. - Service microsoft_teams: Your Microsoft Teams Client Secret. - Service navan: Your Navan client secret. - Service nice: Your NICE client secret. - Service paychex: Your Paychex client secret. - Service personio: Your Personio secret. - Service piwik_pro: Your Piwik PRO client secret. - Service podio: Your Podio client secret. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client Secret. - Service prisma_cloud: Your Prisma Cloud secret access Key. - Service procore: Your Procore client secret. - Service quora_ads: Your Quora Ads client secret. - Service reltio: Your Reltio client secret. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client secret. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client secret. - Service salesloft: Client Secret of your Salesloft client application. - Service sana: Your Sana client secret. - Service sap_success_factors: Your SAP SuccessFactors Client Secret that you generated through SAML Assertion. - Service servicenow: ServiceNow Client Secret. - Service servicetitan: Your ServiceTitan secret key. - Service sharetribe: Your Sharetribe client secret. - Service sigma_computing_source: Your Sigma Computing client secret. - Service skillstx: Your SkillsTX client secret. - Service skimlinks: Your Skimlinks client secret. - Service smartrecruiters: Your SmartRecruiters client secret. - Service splash: Your Splash client secret. - Service square: The Application Secret of your organization. - Service standard_metrics: Your Standard Metrics Client secret. - Service sugarcrm: Your SugarCRM client secret. - Service swoogo: Your Swoogo Client Secret. - Service taboola: The Taboola client secret. - Service talkdesk: The Client Secret of your OAuth Client - Service thinkific: Your Thinkific client secret. - Service tive: Your Tive client secret. - Service toast: Your Toast client secret. - Service trelica: Your Trelica client secret. - Service tremendous: Your Tremendous client secret. - Service tymeshift: Your Tymeshift password. - Service udemy_business: Your Udemy Business client secret. - Service vimeo: Your Vimeo client secret. - Service visma: Your Visma client secret. - Service vonage_contact_center: Your Vonage Contact Center client secret. - Service walmart_marketplace: Your Walmart Marketplace client secret. - Service xero: your clientSecret - Service xray: Your Xray Client Secret. - Service zendesk_chat: Your Zendesk client secret. - Service zoho_books: Your Zoho Books Client Secret. - Service zoho_campaigns: Your Zoho Campaigns Client Secret. - Service zoho_desk: Your Zoho Desk Client secret. - Service zoho_inventory: Your Zoho Inventory client secret. - Service zuora: Zuora Client Secret. - Service zuora_sandbox: Zuora Client Secret.
cloudStorageType string: Field usage depends on service value: - Service braze: Cloud storage type Braze Current is connected to.
collectionAddress string: Field usage depends on service value: - Service rarible: Your Rarible Collection Address.
columns string[]: Field usage depends on service value: - Service double_click_publishers: Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.
communityDomain string: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community domain.
communityId string: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community ID.
companies string[]: Field usage depends on service value: - Service business_central: List of companies to sync
company string: Field usage depends on service value: - Service ordway: Your Ordway company name.
companyId string: Field usage depends on service value: - Service 360learning: Your 360Learning Company ID. - Service sage_intacct: Company ID - Service sap_success_factors: Your SAP SuccessFactors Company ID.
companyIds string: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail company IDs.
companyKey string: Field usage depends on service value: - Service khoros_care: Your Khoros Care companyKey. - Service upland: Your Upland Software Company Key.
companyName string: Field usage depends on service value: - Service clockodo: Your Clockodo company name.
companyRequestToken string: Field usage depends on service value: - Service concur: The SAP Concur Company Request Token
companyUuid string: Field usage depends on service value: - Service concur: The SAP Concur Company UUID
compression string: Field usage depends on service value: - Service aws_cost_report: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service azure_blob_storage: The secrets that should be passed to the function at runtime. - Service box: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service dropbox: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service email: The secrets that should be passed to the function at runtime. - Service ftp: The secrets that should be passed to the function at runtime. - Service gcs: The secrets that should be passed to the function at runtime. - Service google_drive: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service kinesis: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service s3: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service sftp: The secrets that should be passed to the function at runtime. - Service share_point: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service wasabi_cloud_storage: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
configMethod string: Field usage depends on service value: - Service google_display_and_video_360: The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is CREATE_NEW.
configRepositoryUrl string: Field usage depends on service value: - Service snowplow: Public repository URL containing JSON configuration files.
configType string: Field usage depends on service value: - Service facebook: Option to select Prebuilt Reports or Custom Reports. Possible config_type values. - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports.
connectPassword string: Field usage depends on service value: - Service xactly: Your Xactly Connect password.
connectUsername string: Field usage depends on service value: - Service xactly: Your Xactly Connect username.
connectingUser string
connectingUserEmail string
connectionMethod string: Field usage depends on service value: - Service aws_msk: How Fivetran connects to your message brokers in the cluster - Service azure_blob_storage: Connection Method. Possible values: 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. - Service azure_function: Connection Method. Possible values: DIRECT: Fivetran will connect directly to your function, PRIVATE_LINK: Fivetran will connect to your storage container using PrivateLink. - Service azure_service_bus: The connection method - Service sftp: The connection method used to connect to SFTP Server.
connectionName string: Field usage depends on service value: - Service appsflyer: Your Data Locker Connection Name. Default value: `data-locker-hourly/
connectionString string: Field usage depends on service value: - Service azure_blob_storage: The blob storage container connection string. - Service azure_event_hub: Connection string of the Event Hub Namespace you want to sync. - Service azure_service_bus: The connection string used for authentication. Required if the authentication type is ConnectionString - Service microsoft_dynamics_365_fno: The blob storage container's connection string. - Service microsoft_dynamics_365_fo: The blob storage container connection string.
connectionType string: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service aws_cost_report: Connection method. Default value: Directly. - Service aws_lambda: Connection method. Default value: Directly. - Service azure_blob_storage: Connection method. Default value: Directly. - Service azure_cosmos_for_mongo: Possible values:Directly, PrivateLink. Directly is the default value - Service azure_postgres: 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. - Service azure_sql_db: 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. - Service azure_sql_managed_db: 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. - Service bigquery_db: Direct or PrivateLink connection - Service clarity: 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. - Service cockroachdb: Possible values:Directly, 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. - Service db2i_hva: Possible values:SshTunnel. SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service db2i_sap_hva: 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. - Service documentdb: Possible values:SshTunnel, PrivateLink . SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service dynamics_365_fo: 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. - Service ehr: 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. - Service elastic_cloud: Possible values:Directly, 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. - Service email: Connection method. Default value: Directly. - Service es_self_hosted: Possible values:Directly, 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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service heroku_postgres: 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. - Service kinesis: Connection method. Default value: Directly. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mongo: 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. - Service mongo_sharded: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service opendistro: Possible values:Directly, 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. - Service opensearch: Possible values:Directly, 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Directly or Private Link - Service s3: Connection method. Default value: Directly. - Service sap_hana: 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. - Service sap_s4hana: Connection Method - Service snowflake_db: Directly or Private Link - Service sql_server: 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. - Service sql_server_hva: 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. - Service sql_server_rds: 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. - Service sql_server_sap_ecc_hva: 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.
consoleUrl string: Field usage depends on service value: - Service prisma_cloud: Your Prisma Cloud console URL.
consumerGroup string: Field usage depends on service value: - Service apache_kafka: Kafka consumer group name. - Service aws_msk: The name of consumer group created for Fivetran. - Service azure_event_hub: Name of consumer group created for Fivetran. - Service confluent_cloud: Confluent Cloud consumer group name. - Service heroku_kafka: Heroku Kafka consumer group name.
consumerKey string: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Key - Service twitter: API Key of your app - Service twitter_ads: The Twitter App consumer key. - Service woocommerce: Your WooCommerce Consumer key.
consumerName string: Field usage depends on service value: - Service xactly: Your Xactly Connect consumer name.
consumerSecret string: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Secret - Service twitter: API Secret of your app - Service twitter_ads: The Twitter App consumer secret. - Service woocommerce: Your WooCommerce Consumer secret.
containerAddress string: Field usage depends on service value: - Service azure_blob_storage: IP address of the Azure Storage Container which is accessible from host machine.
containerName string: Field usage depends on service value: - Service azure_blob_storage: The name of the blob container. - Service microsoft_dynamics_365_fno: The name of the blob container. - Service microsoft_dynamics_365_fo: The name of the blob container.
contentOwnerId string: Field usage depends on service value: - Service youtube_analytics: Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.
contractVersion string: Field usage depends on service value: - Service acumatica: Your Acumatica contract version.
conversationWebhookUrl string: Field usage depends on service value: - Service helpscout: Your conversation webhook URL
conversionDimensions string[]: Field usage depends on service value: - Service double_click_campaign_manager: Conversion Dimensions.
conversionReportTime string: Field usage depends on service value: - Service pinterest_ads: The date that the user interacted with the ad OR completed a conversion event.
conversionWindowSize number: Field usage depends on service value: - Service google_ads: A period of time in days during which a conversion is recorded.
convertDatsTypeToDate boolean
csvDefinition string: Field usage depends on service value: - Service adjust: CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition).
currency string: Field usage depends on service value: - Service criteo: Currency - Service rokt: Your Rokt currency.
customBaseUrl string: Field usage depends on service value: - Service datadog: Your Datadog custom base url. - Service deposco: Your Deposco custom base URL.
customEventSyncMode string: Field usage depends on service value: - Service iterable: Custom Events Sync Mode.
customEvents string[]: Field usage depends on service value: - Service iterable: List of custom events to sync. Should be specified when custom_event_sync_mode is SelectedEvents
customFieldIds string[]: Field usage depends on service value: - Service double_click_publishers: The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.
customFloodlightVariables string[]: Field usage depends on service value: - Service double_click_campaign_manager: Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.
customPayloads GetConnectorConfigCustomPayload[]: Field usage depends on service value: - Service aws_lambda: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service azure_function: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service google_cloud_function: The list of key-value pairs that can be used to specify custom information to the function at runtime.
customReports GetConnectorConfigCustomReport[]: Field usage depends on service value: - Service reddit_ads: The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data. - Service snapchat_ads: Custom reports for Snapchat Ads connector. - Service tiktok_ads: Title of Custom Report
customTables GetConnectorConfigCustomTable[]: Field usage depends on service value: - Service facebook_ads: List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data.
customUrl string: Field usage depends on service value: - Service dbt_cloud: Your dbt Cloud access url. - Service factbird: Your Factbird custom base url. - Service jotform: Your Jotform custom base URL.
customerApiKey string: Field usage depends on service value: - Service ukg_pro: Your UKG Pro Customer API key.
customerId string: Field usage depends on service value: - Service google_ads: ID of the customer, can be retrieved from your AdWords dashboard.
customerListId string: Field usage depends on service value: - Service salesforce_commerce_cloud: The parameter to retrieve customer details.
dailyApiCallLimit number
dataAccessMethod string: Field usage depends on service value: - Service cosmos: The source data access method. Supported values:ACCOUNT_KEY- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.RESOURCE_TOKEN- Fine-grained permission model based on native Azure Cosmos DB users and permissions. Learn more in our Azure Cosmos DB Data Access Methods documentation.
dataCenter string: Field usage depends on service value: - Service brightpearl: Your Brightpearl data center. - Service qualtrics: 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.) - Service zoho_crm: Data Center, depending on the Domain name
dataCenterId string: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback data center ID.
dataSetName string: Field usage depends on service value: - Service bigquery_db: Data set name
database string: Field usage depends on service value: - Service aurora: The database name. - Service aurora_postgres: The database name. - Service azure_cosmos_for_mongo: Authentication database for the source. Usually 'admin'. - Service azure_postgres: The database name. - Service azure_sql_db: The database name. - Service azure_sql_managed_db: The database name. - Service clarity: The database name. - Service cockroachdb: The database name. - Service db2i_hva: The database name. - Service db2i_sap_hva: The database name. - Service dynamics_365_fo: The database name. - Service ehr: The database name. - Service google_cloud_mysql: The database name. - Service google_cloud_postgresql: The database name. - Service google_cloud_sqlserver: The database name. - Service hana_sap_hva_b1: The Hana database name. - Service hana_sap_hva_ecc: The Hana database name. - Service hana_sap_hva_ecc_netweaver: The Hana database name. - Service hana_sap_hva_s4: The Hana database name. - Service hana_sap_hva_s4_netweaver: The Hana database name. - Service heroku_postgres: The database name. - Service magento_mysql: The database name. - Service magento_mysql_rds: The database name. - Service maria: The database name. - Service maria_azure: The database name. - Service maria_rds: The database name. - Service mysql: The database name. - Service mysql_azure: The database name. - Service mysql_rds: The database name. - Service oracle: The database name. - Service oracle_ebs: The database name. - Service oracle_hva: The database name. - Service oracle_rac: The database name. - Service oracle_rds: The database name. - Service oracle_sap_hva: The database name. - Service postgres: The database name. - Service postgres_rds: The database name. - Service redshift_db: The database name: Redshift - Service sap_hana: The database name. - Service sap_s4hana: The database name. - Service snowflake_db: The database name: Snowflake - Service sql_server: The database name. - Service sql_server_hva: The database name. - Service sql_server_rds: The database name. - Service sql_server_sap_ecc_hva: The database name.
databaseName string: Field usage depends on service value: - Service firebase: Database Name
datasetId string: Field usage depends on service value: - Service google_analytics_360: The dataset ID. - Service google_analytics_4_export: The Dataset ID.
datasource string: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite data source value: NetSuite.com.
dateGranularity string: Field usage depends on service value: - Service adobe_analytics: The aggregation duration you want. Default value: HOUR .
db string: Field usage depends on service value: - Service myosh: Your Myosh Server variables/db .
delimiter string: Field usage depends on service value: - Service aws_cost_report: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service azure_blob_storage: 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. - Service box: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service dropbox: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service kinesis: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service s3: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service sftp: 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. - Service share_point: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service wasabi_cloud_storage: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
developerReference string: Field usage depends on service value: - Service brightpearl: Your Brightpearl dev reference.
dimensionAttributes string[]: Field usage depends on service value: - Service double_click_publishers: Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions.
dimensions string[]: Field usage depends on service value: - Service adroll: The dimenstions that you want to sync. - Service double_click_campaign_manager: 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 - Service double_click_publishers: Report dimensions to include in the sync. The date dimension is mandatory for all the report types. - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_display_and_video_360: 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.
directCaptureMethod string: Field usage depends on service value: - Service oracle_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY - Service oracle_sap_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY
distributedConnectorClusterSize number: Field usage depends on service value: - Service cosmos: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel. - Service dynamodb: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel.
domain string: Field usage depends on service value: - Service auth0: Your Auth0 domain. - Service bubble: Your Bubble app name or domain name. - Service confluence: Your Confluence domain. - Service kustomer: Domain is the beginning of your kustomer URL going before .kustomerapp.com, e.g. for yourcompany.kustomerapp.com the domain name is yourcompany - Service okta: Your Okta domain. - Service pipedrive: Your Pipedrive domain. - Service shopware: Your Shopware domain. - Service sistrix: Your SISTRIX domain. - Service solarwinds_service_desk: Your SolarWinds Service Desk domain. - Service uservoice: Domain of your UserVoice site. If it ends with ".uservoice.com", you can specify just the subdomain ("mydomain.uservoice.com" - "mydomain") - Service zendesk: Zendesk domain. - Service zendesk_sunshine: Zendesk domain.
domainHostName string: Field usage depends on service value: - Service workday: Workday host name. - Service workday_financial_management: Workday host name. - Service workday_hcm: Workday host name.
domainName string: Field usage depends on service value: - Service calabrio: Your Calabrio domain name - Service dynamics_365: The custom domain name associated with Dynamics 365. - Service helpshift: Your Helpshift domain name.
domainType string: Field usage depends on service value: - Service medallia: Domain type of your Medallia URL
dsvServiceAuth string
dsvSubscriptionKey string
ecommerceStores string[]: Field usage depends on service value: - Service mailchimp: List of IDs of the Mailchimp E-Commerce Stores to Sync
edition string
elements string[]
email string: Field usage depends on service value: - Service appcues: Your Appcues Email. - Service boostr: Your Boostr email. - Service copper: Your Copper email address. - Service email: Send your emails to this address. - Service moloco: Your Moloco account email. - Service netsuite_suiteanalytics: The NetSuite user's email address. - Service pardot: The email of the Pardot user. - Service skuvault: Your SkuVault email. - Service smadex: Your Smadex account's email ID. - Service zendesk: Zendesk email. - Service zendesk_sunshine: Zendesk email.
emailAddress string: Field usage depends on service value: - Service clockodo: Your Clockodo email address.
emailId string: Field usage depends on service value: - Service ordway: Your Ordway user email ID. - Service planful: Your Planful email ID.
emptyHeader boolean: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service azure_blob_storage: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service box: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service dropbox: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service email: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service ftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service gcs: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service google_drive: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service kinesis: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service s3: 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. - Service sftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service share_point: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service wasabi_cloud_storage: 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.
enableAllDimensionCombinations boolean: Field usage depends on service value: - Service double_click_campaign_manager: Whether to enable all reach dimension combinations in the report. Default value: false
enableArchiveLogOnly boolean: Field usage depends on service value: - Service sql_server_hva: Use archive log only mode - Service sql_server_sap_ecc_hva: Use archive log only mode
enableDataExtensionsSyncing boolean
enableDistributedConnectorMode boolean: Field usage depends on service value: - Service cosmos: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors. - Service dynamodb: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors.
enableEnrichments boolean: Field usage depends on service value: - Service snowplow: Enable Enrichments
enableExports boolean: Field usage depends on service value: - Service braze: Enable User Profile Exports
enableTde boolean: Field usage depends on service value: - Service sql_server_hva: Using Transparent Data Encryption (TDE) - Service sql_server_sap_ecc_hva: Using Transparent Data Encryption (TDE)
encodedPublicKey string: Field usage depends on service value: - Service apple_search_ads: Use the public key to grant Fivetran access to Apple Search Ads api.
encryptionKey string: Field usage depends on service value: - Service marketo: Marketo SOAP API Encryption Key.
endpoint string: Field usage depends on service value: - Service branch: Webhook Endpoint - Service iterable: Register the following URL for webhooks on your Iterable dashboard. - Service marketo: Marketo REST API endpoint. - Service snowplow: Connection-specific collector endpoint. The collector endpoint will have the webhooks.fivetran.com/snowplow/endpoint_ID format. You will need it to configure Snowplow to connect with Fivetran. - Service webhooks: You can send your events to https://webhooks.fivetran.com/webhooks/{endpoint}
engagementAttributionWindow string: Field usage depends on service value: - Service pinterest_ads: The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action.
enrichedExport string: Field usage depends on service value: - Service optimizely: Enriched Events S3 bucket
entityId string: Field usage depends on service value: - Service checkout: Your Checkout.com entity ID. - Service zuora: If is_multi_entity_feature_enabled is true, then it's EntityId. - Service zuora_sandbox: If is_multi_entity_feature_enabled is true, then it's EntityId.
environment string: Field usage depends on service value: - Service bazaarvoice: Your Bazaarvoice environment. - Service buildium: Your Buildium environment. - Service checkout: Your Checkout.com environment. - Service concord: Your Concord environment. - Service deposco: Your Deposco environment. - Service dialpad: Your Dialpad environment. - Service invoiced: Your Invoiced environment. - Service jibble: Your Jibble environment. - Service lucca: Your Lucca environment. - Service procore: Your Procore account environment. - Service reltio: Your Reltio environment. - Service servicetitan: Your ServiceTitan environment. - Service smarthr: Your SmartHR environment. - Service trelica: Your Trelica environment. - Service tremendous: Your Tremendous environment. - Service vts: Your VTS environment. - Service xactly: Your Xactly environment. - Service younium: Your Younium API environment. - Service zuora: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox. - Service zuora_sandbox: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
environmentHost string: Field usage depends on service value: - Service xactly: Your Xactly environment host.
environmentName string: Field usage depends on service value: - Service business_central: Name of the environment
escapeChar string: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service azure_blob_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service box: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service dropbox: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service email: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service ftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service gcs: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service google_drive: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service kinesis: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service s3: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service sftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service share_point: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service wasabi_cloud_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
escapeCharOptions string: Field usage depends on service value: - Service gcs: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true. - Service s3: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true.
euRegion boolean: Field usage depends on service value: - Service kustomer: Turn it on if your app is on EU region - Service survey_monkey: The SurveyMonkey account region. Specify true, if your account is hosted in the EU region. Default value is false.
events string[]: Field usage depends on service value: - Service iterable: List of events to sync. Should be specified when sync_mode is SelectedEvents
exportStorageType string: Field usage depends on service value: - Service adjust: Your cloud storage. - Service braze: Export Storage. Required if enable_exports is true
externalId string: Field usage depends on service value: - Service appsflyer: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_cloudtrail: This is the same as your group_id, used for authentication along with the role_arn. - Service aws_cost_report: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_lambda: The external ID is a string that designates who can assume the role. - Service aws_msk: This is the same as your group_id. This is required when sasl_mechanism is set to IAM. - Service azure_function: External ID. - Service cloudfront: This is the same as your group_id, used for authentication along with the role_arn. - Service dynamodb: This is the same as your group_id, used for authentication along with the role_arn. - Service kinesis: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service s3: Used for authentication along with the role_arn. If not provided, it uses connector's group_id. Use the List All Groups endpoint to find the group_id. - Service segment: The external ID is a string that designates who can assume the role. For more information, see a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"Amazon's AWS Identity and Access Management User Guide/a.
facilityCodes string: Field usage depends on service value: - Service unicommerce: Your uniware facility codes.
fields string[]: Field usage depends on service value: - Service facebook: List of fields which connector will sync. Possible field values.
fileType string: Field usage depends on service value: - Service aws_cost_report: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service azure_blob_storage: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service box: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service dropbox: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service email: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service ftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service gcs: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service google_drive: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service kinesis: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service s3: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service sftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service share_point: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service wasabi_cloud_storage: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
filter string: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
financeAccountSyncMode string: Field usage depends on service value: - Service itunes_connect: Whether to sync all finance accounts or specific finance accounts.
financeAccounts string[]: Field usage depends on service value: - Service itunes_connect: Specific finance accounts to sync. Must be populated if finance_account_sync_mode is set to SpecificFinanceAccounts.
folder string: Field usage depends on service value: - Service dropbox: Your Dropbox Folder URL.
folderId string: Field usage depends on service value: - Service box: Folder URL - Service google_drive: Folder URL
folderPath string: Field usage depends on service value: - Service adobe_analytics_data_feed: Folder Path - Service one_drive: Your OneDrive folder URL - Service oracle_business_intelligence_publisher: The folder path to save data models and reports.
forecastId string: Field usage depends on service value: - Service clari: Your Clari Forecast id .
ftpHost string: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP host.
ftpPassword string: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP password.
ftpPort number: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP port.
ftpUser string: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP user.
function string: Field usage depends on service value: - Service aws_lambda: The name of your AWS Lambda Function.
functionApp string: Field usage depends on service value: - Service azure_function: Function app name in Azure portal.
functionKey string: Field usage depends on service value: - Service azure_function: Function key used for authorization.
functionName string: Field usage depends on service value: - Service azure_function: Name of the function to be triggered.
functionTrigger string: Field usage depends on service value: - Service google_cloud_function: The trigger URL of the cloud function.
gcsBucket string: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the cloud_storage_type - Service webhooks: The GCS bucket name. Required if bucket_service is set to GCS.
gcsExportBucket string: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the export_storage_type
gcsExportFolder string: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the export_storage_type
gcsFolder string: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the cloud_storage_type
generateFivetranPk boolean: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
groupId string: Field usage depends on service value: - Service line_ads: Your LINE Ads group ID(s).
groupName string: Field usage depends on service value: - Service fivetran_log: (Optional) The group name of the target_group_id.
hanaBackupPassword string
hanaMode string: Field usage depends on service value: - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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.
hasManagePermissions boolean: Field usage depends on service value: - Service azure_service_bus: The boolean value specifying whether the connection string has manage permissions
historicSyncTimeFrame string: Field usage depends on service value: - Service braze: Range of data in history you would like to include in the initial sync. - Service iterable: The time range for which historical data should be synced. Default value: All Time. - Service klaviyo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service marketo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service sailthru: Range of historical data you would like to include in the initial sync. Default value: ALL_TIME. - Service salesforce_marketing_cloud: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME.
historicalSyncLimit string: Field usage depends on service value: - Service concur: Historical Sync Limit for the Sync - Service eloqua: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service pardot: The time range for which historical data should be synced. Default value: All Time.
historicalSyncTimeFrame string: Field usage depends on service value: - Service rokt: Your Rokt historical sync time frame. - Service skimlinks: Your Skimlinks Historical sync time frame. - Service vimeo: Your Vimeo Historical sync time frame. - Service zendesk: Used to configure Historical sync timeframe for selected tables
homeFolder string: Field usage depends on service value: - Service appsflyer: Your S3 home folder path of the Data Locker.
host string: Field usage depends on service value: - Service aurora: DB instance host or IP address. - Service aurora_postgres: DB instance host or IP address. - Service azure_postgres: DB instance host or IP address. - Service azure_sql_db: DB instance host or IP address. - Service azure_sql_managed_db: DB instance host or IP address. - Service clarity: DB instance host or IP address. - Service cockroachdb: DB instance host or IP address. - Service commercetools: Your commercetools host. - Service databricks_db: The host URL for your Databricks account. - Service db2i_hva: A host address of the primary node. It should be a DB instance host/IP address with a port number. - Service db2i_sap_hva: DB instance host or IP address. - Service documentdb: Host IP address of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: DB instance host or IP address. - Service ehr: DB instance host or IP address. - Service elastic_cloud: DB instance host or IP address. - Service es_self_hosted: DB instance host or IP address. - Service ftp: FTP host address. - Service google_cloud_mysql: DB instance host or IP address. - Service google_cloud_postgresql: DB instance host or IP address. - Service google_cloud_sqlserver: DB instance host or IP address. - Service hana_sap_hva_b1: DB instance host or IP address. - Service hana_sap_hva_ecc: DB instance host or IP address. - Service hana_sap_hva_ecc_netweaver: DB instance host or IP address. - Service hana_sap_hva_s4: DB instance host or IP address. - Service hana_sap_hva_s4_netweaver: DB instance host or IP address. - Service heroku_postgres: DB instance host or IP address. - Service jira: The Jira service host address. - Service magento_mysql: DB instance host or IP address. - Service magento_mysql_rds: DB instance host or IP address. - Service maria: DB instance host or IP address. - Service maria_azure: DB instance host or IP address. - Service maria_rds: DB instance host or IP address. - Service marin: The Marin host address. - Service mysql: DB instance host or IP address. - Service mysql_azure: DB instance host or IP address. - Service mysql_rds: DB instance host or IP address. - Service netsuite_suiteanalytics: The NetSuite service host address. - Service opendistro: DB instance host or IP address. - Service opensearch: DB instance host or IP address. - Service oracle: DB instance host or IP address. - Service oracle_ebs: DB instance host or IP address. - Service oracle_hva: DB instance host or IP address. - Service oracle_rac: DB instance host or IP address. - Service oracle_rds: DB instance host or IP address. - Service oracle_sap_hva: DB instance host or IP address. - Service oracle_sap_hva_netweaver: DB instance host or IP address. - Service postgres: DB instance host or IP address. - Service postgres_rds: DB instance host or IP address. - Service redshift_db: Host name - Service sap_hana: The SAP HANA host or IP address. - Service sap_s4hana: The SAP S/4 host or IP address. - Service sftp: SFTP host address. - Service snowflake_db: Host name - Service splunk: The Splunk service host address. - Service sql_server: DB instance host or IP address. - Service sql_server_hva: DB instance host or IP address. - Service sql_server_rds: DB instance host or IP address. - Service sql_server_sap_ecc_hva: DB instance host or IP address.
hostIp string: Field usage depends on service value: - Service azure_blob_storage: IP address of host tunnel machine which is used to connect to the Storage container. - Service azure_service_bus: The IP address of the host machine which we use to connect to ASB via ssh
hostName string: Field usage depends on service value: - Service coassemble: Your Coassemble Hostname. - Service datadog: Your Datadog host name.
hostUrl string: Field usage depends on service value: - Service adobe_commerce: Your Adobe Commerce host url. - Service sparkpost: Your SparkPost host URL.
hostUser string: Field usage depends on service value: - Service azure_blob_storage: Username in the host machine. - Service azure_service_bus: The username on the host machine which we use to connect to ASB via ssh
hostname string: Field usage depends on service value: - Service akamai: Your Akamai hostname. - Service ukg_pro: Your UKG Pro hostname.
hosts string[]: Field usage depends on service value: - Service azure_cosmos_for_mongo: A list of host addresses for Azure Cosmos DB for Mongo DB. - Service mongo: 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. - Service mongo_sharded: 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.
httpPath string: Field usage depends on service value: - Service databricks_db: http path
identifier string: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management client identifier. - Service statistics_netherlands_cbs: Your Statistics Netherlands CBS catalog identifier.
identity string: Field usage depends on service value: - Service marketo: Marketo REST API identity url.
includeOcapiEndpoints boolean: Field usage depends on service value: - Service salesforce_commerce_cloud: Whether to sync data through OCAPI endpoints.
instance string: Field usage depends on service value: - Service acumatica: Your Acumatica instance name. - Service coupa: The instance name of your Coupa account in the URL. - Service flywheel_digital: Your Flywheel Digital instance. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud instance ID - Service servicenow: ServiceNow Instance ID.
instanceNumber string: Field usage depends on service value: - Service hana_sap_hva_b1: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service oracle_sap_hva_netweaver: Two-digit number (00-97) of the SAP instance within its host.
instanceUrl string: Field usage depends on service value: - Service sap_business_by_design: The SAP Business ByDesign instance URL.
integrationKey string: Field usage depends on service value: - Service pendo: The integration key of the Pendo account.
ipAddress string: Field usage depends on service value: - Service aveva_pi: IP address of the AF Server
isAccountLevelConnector boolean: Field usage depends on service value: - Service fivetran_log: (Optional) Retrieve account-level logs.
isAuth2Enabled boolean: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Default value: false
isCustomApiCredentials boolean: Field usage depends on service value: - Service twitter_ads: Custom API credentials
isExternalActivitiesEndpointSelected boolean: Field usage depends on service value: - Service pardot: Whether the EXTERNAL_ACTIVITY table must be synced or not.
isFtps boolean: Field usage depends on service value: - Service adobe_analytics_data_feed: Use Secure FTP (FTPS).
isKeypair boolean: Field usage depends on service value: - Service sftp: Whether to use a key pair for authentication. When true, do not use password.
isMultiEntityFeatureEnabled boolean: Field usage depends on service value: - Service zuora: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false. - Service zuora_sandbox: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false.
isNewPackage boolean: Field usage depends on service value: - Service salesforce_marketing_cloud: Indicates that that your installed package uses OAuth 2.0. Default value: false
isPrivateKeyEncrypted boolean: Field usage depends on service value: - Service snowflake_db: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
isPrivateLinkRequired boolean: Field usage depends on service value: - Service aws_lambda: We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our PrivateLink documentation. - Service s3: Set to true if you want to connect to S3 bucket over PrivateLink. Default value: false.
isPublic boolean: Field usage depends on service value: - Service aws_cost_report: Whether you are syncing from a public bucket. Default value: false. - Service kinesis: Is the bucket public? (you don't need an AWS account for syncing public buckets!) - Service s3: Whether you are syncing from a public bucket. Default value: false.
isSailthruConnectEnabled boolean: Field usage depends on service value: - Service sailthru: Enable this if you want to sync Sailthru Connect
isSecure boolean: Field usage depends on service value: - Service ftp: Whether the server supports FTPS.
isSftpCredsAvailable boolean: Field usage depends on service value: - Service salesforce_marketing_cloud: Provide SFTP credentials
isSingleTableMode boolean: Field usage depends on service value: - Service box: Allows the creation of connector using Merge Mode strategy. - Service dropbox: Allows the creation of connector using Merge Mode strategy. - Service google_drive: Allows the creation of connector using Merge Mode strategy. - Service sftp: Allows the creation of connector using the specified Sync strategy. - Service share_point: Allows the creation of connector using Merge Mode strategy.
isTestAccount boolean: Field usage depends on service value: - Service adyen: Whether or not your Adyen Account is a Test Account. Default value: false.
isVendor boolean: Field usage depends on service value: - Service amazon_selling_partner: Whether or not you have a Vendor Account. Default value: false.
issuer string: Field usage depends on service value: - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud issuer name.
jsonDeliveryMode string: Field usage depends on service value: - Service aws_cost_report: Control how your JSON data is delivered into your destination - Service azure_blob_storage: Control how your JSON data is delivered into your destination - Service box: Control how your JSON data is delivered into your destination - Service dropbox: Control how your JSON data is delivered into your destination - Service email: Control how your JSON data is delivered into your destination - Service ftp: Control how your JSON data is delivered into your destination - Service gcs: Control how your JSON data is delivered into your destination - Service google_drive: Control how your JSON data is delivered into your destination - Service kinesis: Control how your JSON data is delivered into your destination - Service s3: Control how your JSON data is delivered into your destination - Service sftp: Control how your JSON data is delivered into your destination - Service share_point: Control how your JSON data is delivered into your destination - Service wasabi_cloud_storage: Specifies how Fivetran should handle your JSON data. Default value: Packed.
key string: Field usage depends on service value: - Service uservoice: The UserVoice API key.
keyPassword string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Key Password.
keyStoreType string: Field usage depends on service value: - Service heroku_kafka: Key Store Type
keystore string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Keystore File as Base64 encoded string.
keystorePassword string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Keystore Password.
lastSyncedChangesUtc_ string
latestVersion string
legalEntityId string: Field usage depends on service value: - Service younium: Your Younium legal entity ID.
limitForApiCallsToExternalActivitiesEndpoint number: Field usage depends on service value: - Service pardot: API limit for the external activities endpoint.
lineSeparator string: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
listId string: Field usage depends on service value: - Service pigment: Your Pigment list ID.
listOfCompanyIds string: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail list of company IDs.
listStrategy string: Field usage depends on service value: - Service aws_cost_report: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service kinesis: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service s3: The listing strategy you want to use. Default value: complete_listing.
listSyncMode string: Field usage depends on service value: - Service google_analytics_4_export: The Sync Mode
logJournal string: Field usage depends on service value: - Service db2i_hva: The log journal name. - Service db2i_sap_hva: The log journal name.
logJournalSchema string: Field usage depends on service value: - Service db2i_hva: The log journal schema. - Service db2i_sap_hva: The log journal schema.
logOnGroup string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional. - Service hana_sap_hva_s4_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional.
login string: Field usage depends on service value: - Service rebound_returns: Your ReBound Returns login. - Service the_trade_desk: The Trade Desk email. It is a part of the login credentials. - Service walmart_dsp: Walmart DSP email. It is a part of the login credentials.
loginPassword string: Field usage depends on service value: - Service concur: The SAP Concur password. - Service sage_intacct: The login password. It is a part of the login credentials.
managerAccounts string[]: Field usage depends on service value: - Service google_ads: The list of the Manager Account IDs whose clients will be synced. Must be populated if sync_mode is set to ManagerAccounts.
maxApiRequestsPerDay number: Field usage depends on service value: - Service reltio: Maximum API requests per day
merchantId string: Field usage depends on service value: - Service afterpay: Your Afterpay Merchant ID. - Service amazon_selling_partner: The Merchant ID or Vendor Code. - Service avantlink: Your AvantLink Merchant ID. - Service braintree: Your Braintree merchant ID. - Service braintree_sandbox: Your Braintree merchant ID. - Service shareasale: Your ShareASale merchant ID. - Service xsolla: Your Xsolla Merchant ID.
messageType string: Field usage depends on service value: - Service apache_kafka: Kafka message type. - Service aws_msk: The Message type. - Service azure_event_hub: Message type. - Service azure_service_bus: The format of messages in the topic - Service confluent_cloud: Confluent Cloud message type. - Service heroku_kafka: Heroku Kafka message type.
metricId string: Field usage depends on service value: - Service pigment: Your Pigment metric ID.
metrics string[]: Field usage depends on service value: - Service adroll: The metrics that you want to sync. - Service criteo: Metrics - Service double_click_campaign_manager: Report metrics to include into a sync. - Service google_analytics: The report metrics to include into a sync. - Service google_display_and_video_360: 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.
namedRange string: Field usage depends on service value: - Service google_sheets: The name of the named data range on the sheet that contains the data to be synced.
namespace string: Field usage depends on service value: - Service azure_service_bus: The ASB namespace which we have to sync. Required for AzureActiveDirectory authentication.
networkCode number: Field usage depends on service value: - Service double_click_publishers: Network code is a unique, numeric identifier for your Ad Manager network.
nonStandardEscapeChar boolean: Field usage depends on service value: - Service gcs: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false. - Service s3: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false.
nullSequence string: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service azure_blob_storage: If your CSVs use a special value indicating null, you can specify it here. - Service box: If your CSVs use a special value indicating null, you can specify it here. - Service dropbox: If your CSVs use a special value indicating null, you can specify it here. - Service email: If your CSVs use a special value indicating null, you can specify it here. - Service ftp: If your CSVs use a special value indicating null, you can specify it here. - Service gcs: If your CSVs use a special value indicating null, you can specify it here. - Service google_drive: If your CSVs use a special value indicating null, you can specify it here. - Service kinesis: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service s3: If your CSVs use a special value indicating null, you can specify it here. - Service sftp: If your CSVs use a special value indicating null, you can specify it here. - Service share_point: If your CSVs use a special value indicating null, you can specify it here. - Service wasabi_cloud_storage: If your CSVs use a special value indicating null, you can specify it here.
oauthToken string
oauthTokenSecret string
ocapiClientId string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client ID.
ocapiClientSecret string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client secret.
ocapiCustomObjectTypes string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI custom object types.
ocapiHostname string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI hostname.
odbcDriverManagerLibraryPath string: Field usage depends on service value: - Service hana_sap_hva_b1: ODBC manager library path - Service hana_sap_hva_ecc: ODBC manager library path - Service hana_sap_hva_s4: ODBC manager library path
odbcSysIniPath string: Field usage depends on service value: - Service hana_sap_hva_b1: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_ecc: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_s4: odbc.ini and odbcsinst.ini location
onError string: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
onPremise boolean: Field usage depends on service value: - Service jira: Whether the Jira instance is local or in cloud.
organization string: Field usage depends on service value: - Service gladly: Your Gladly Organization Name. - Service statuspage: Your Statuspage Organization ID.
organizationDomain string: Field usage depends on service value: - Service adobe_workfront: Your Adobe Workfront organization domain.
organizationId string: Field usage depends on service value: - Service adobe_analytics: Organization ID from the Service Account (JWT) credentials of your Adobe Project. - Service integrate: Your Integrate organization ID. - Service megaphone: Your Megaphone organization ID. - Service productive: Your Productive Organization ID. - Service salesforce_commerce_cloud: The organization ID from Salesforce Commerce Cloud account. - Service sentry: Your Sentry organization ID. - Service zoho_books: Your Zoho Books Organization ID. - Service zoho_inventory: Your Zoho Inventory organization ID.
organizationName string: Field usage depends on service value: - Service brightpearl: Your Brightpearl organization name. - Service confluence: Your Confluence organization name.
organizations string[]: Field usage depends on service value: - Service apple_search_ads: Organizations - Service snapchat_ads: Specific organizations IDs to sync. Must be populated if syncMode is set to SpecificOrganizations.
packedModeTables string[]: Field usage depends on service value: - Service azure_cosmos_for_mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service dynamodb: List of tables to be synced in packed mode. - Service firebase: Specific tables to sync. Must be populated if packing_mode is set to SelectTablesForPackedMode. - Service mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service mongo_sharded: List of tables to be synced in packed mode; format:db.table(case-sensitive).
packingMode string: Field usage depends on service value: - Service azure_cosmos_for_mongo: Indicates the desired sync pack mode. Accepted values are UsePackedModeOnly and UseUnpackedModeOnly. SelectTablesForPackedMode is deprecated. - Service firebase: Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service klaviyo: Packing mode for EVENT and PERSON tables. - Service mongo: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service mongo_sharded: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service optimizely: Packing mode for conversion and decision tables. - Service sailthru: Packing mode for LIST_STATE and USER tables.
pages string[]: Field usage depends on service value: - Service facebook_pages: Specific pages to sync. Must be populated if sync_mode is set to SpecificPages.
partnerCode string: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission partner code.
partnerUserId string: Field usage depends on service value: - Service expensify: Your Expensify partnerUserID.
partnerUserSecret string: Field usage depends on service value: - Service expensify: Your Expensify partnerUserSecret.
partners string[]: Field usage depends on service value: - Service google_display_and_video_360: The list of partners to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service the_trade_desk: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service walmart_dsp: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
passPhrase string: Field usage depends on service value: - Service qualtrics: Pass Phrase
passphrase string: Field usage depends on service value: - Service snowflake_db: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
password string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS password. - Service adobe_commerce: Your Adobe Commerce password. - Service akeneo: Your Akeneo password. - Service anaplan: Your Anaplan password. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Password. - Service aurora: The user's password. - Service aurora_postgres: The user's password. - Service azure_cosmos_for_mongo: Password used for source database authentication. - Service azure_postgres: The user's password. - Service azure_sql_db: The user's password. - Service azure_sql_managed_db: The user's password. - Service boostr: Your Boostr password. - Service ceridian_dayforce: Your Ceridian Dayforce Password. - Service cin7: Your Cin7 API Key. - Service clarity: The user's password. - Service cockroachdb: The user's password. - Service collibra: Your collibra password. - Service compliance_checkpoint: Your Compliance Checkpoint account password. - Service contrast_security: Your Contrast Security API Password. - Service db2i_hva: The user's password. - Service db2i_sap_hva: The user's password. - Service deposco: Your Deposco password. - Service documentdb: The user's password. - Service dynamics_365_fo: The user's password. - Service ehr: The user's password. - Service elastic_cloud: The user's password. - Service es_self_hosted: The user's password. - Service ftp: FTP password. - Service globalmeet: Your GlobalMeet Password. - Service google_cloud_mysql: The user's password. - Service google_cloud_postgresql: The user's password. - Service google_cloud_sqlserver: The user's password. - Service green_power_monitor: Your GreenPowerMonitor password. - Service guru: Your Guru password. - Service hana_sap_hva_b1: The user's password. - Service hana_sap_hva_ecc: The user's password. - Service hana_sap_hva_ecc_netweaver: The user's password. - Service hana_sap_hva_s4: The user's password. - Service hana_sap_hva_s4_netweaver: The user's password. - Service heroku_postgres: The user's password. - Service hilti_ontrack: Your Hilti On!Track password. - Service impact: Your Impact Account Token - Service integral_ad_science: Your integral_ad_science password. - Service itunes_connect: Your password - Service jamf: Your Jamf password. - Service jira: The Jira user's password. - Service khoros_care: Your Khoros Care password. - Service kissmetrics: Your Kissmetrics API Password. - Service klarna: Your Klarna Password. - Service lessonly: Your Lessonly password. - Service magento_mysql: The user's password. - Service magento_mysql_rds: The user's password. - Service maria: The user's password. - Service maria_azure: The user's password. - Service maria_rds: The user's password. - Service marin: The Marin user's password. - Service moloco: Your Moloco account password. - Service mongo: The user's password. - Service mongo_sharded: The user's password. - Service myosh: Your myosh password. - Service mysql: The user's password. - Service mysql_azure: The user's password. - Service mysql_rds: The user's password. - Service netsuite_suiteanalytics: The NetSuite user's password. - Service opendistro: The user's password. - Service opensearch: The user's password. - Service oracle: The user's password. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence user password. - Service oracle_ebs: The user's password. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud user password. - Service oracle_hva: The user's password. - Service oracle_rac: The user's password. - Service oracle_rds: The user's password. - Service oracle_sap_hva: The user's password. - Service oracle_sap_hva_netweaver: The user's password. - Service outbrain: The Outbrain user's password. - Service pardot: The Pardot user's password. - Service partnerize: Your Partnerize account's password. - Service podio: Your Podio account password. - Service postgres: The user's password. - Service postgres_rds: The user's password. - Service qmatic_data_connect: Your Qmatic Data Connect password. - Service redshift_db: The Redshift user's password. - Service revx: Your RevX Password. - Service rtb_house: Your RTB House password. - Service sap_business_by_design: The SAP Business ByDesign password. - Service sap_hana: Your SAP HANA password. - Service sap_s4hana: Your SAP S/4 password. - Service scorm: Your Scorm Secret Key. - Service servicenow: Your account password. - Service sftp: SFTP password. - Service shiphero: Your ShipHero password. - Service shipstation: Your ShipStation password. - Service shopware: Your Shopware password. - Service skuvault: Your SkuVault password. - Service smadex: Your Smadex Password. - Service snowflake_db: The Snowflake user's password. - Service splash: Your Splash password. - Service splunk: The Splunk user's password. - Service sql_server: The user's password. - Service sql_server_hva: The user's password. - Service sql_server_rds: The user's password. - Service sql_server_sap_ecc_hva: The user's password. - Service starrez: Your StarRez API password - Service stickyio: Your sticky.io password. - Service stylight: Your Stylight Password. - Service sugarcrm: Your SugarCRM password. - Service teamwork: Your Teamwork password. - Service the_trade_desk: The Trade Desk password. It is a part of the login credentials. - Service toggl_track: Your Toggl Track Password - Service ukg_pro: Your UKG Pro password. - Service unicommerce: Your uniware login password. - Service upland: Your Upland Software Password. - Service veevavault: Your Veeva Vault password. - Service walmart_dsp: Walmart DSP password. It is a part of the login credentials. - Service when_i_work: Your When I Work password. - Service wherefour: Your Wherefour password. - Service workday: Workday password. - Service workday_financial_management: Workday password. - Service workday_hcm: Workday password. - Service xandr: Your Xandr password. - Service younium: Your Younium password.
pat string: Field usage depends on service value: - Service github: The Personal Access Token generated in Github.
patName string: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Name.
patSecret string: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Secret.
path string: Field usage depends on service value: - Service jira: A URL subdirectory where the Jira instance is working.
pats string[]: Field usage depends on service value: - Service github: The Personal Access Tokens.
pattern string: Field usage depends on service value: - Service aws_cost_report: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service azure_blob_storage: All files in your search path matching this regular expression will be synced. - Service box: All files in your search path matching this regular expression will be synced. - Service dropbox: All files in your search path matching this regular expression will be synced. - Service email: All files in your search path matching this regular expression will be synced. - Service ftp: All files in your search path matching this regular expression will be synced. - Service gcs: All files in your search path matching this regular expression will be synced. - Service google_drive: All files in your search path matching this regular expression will be synced. - Service kinesis: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service s3: All files in your search path matching this regular expression will be synced. - Service sftp: All files in your search path matching this regular expression will be synced. - Service share_point: All files in your search path matching this regular expression will be synced. - Service wasabi_cloud_storage: All files in your search path matching this regular expression will be synced.
pdbName string: Field usage depends on service value: - Service oracle: Optional: Required only for containerized database. - Service oracle_ebs: Optional: Required only for containerized database. - Service oracle_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases. - Service oracle_rac: Optional: Required only for containerized database. - Service oracle_rds: Optional: Required only for containerized database. - Service oracle_sap_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
pemCertificate string: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Must be populated if is_auth2_enabled is set to false.
pemPrivateKey string: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM secret key file. Must be populated if is_auth2_enabled is set to true.
perInteractionDimensions string[]: Field usage depends on service value: - Service double_click_campaign_manager: Per Interaction Dimensions.
personalAccessToken string: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail personal access token. - Service databricks_db: Access Token - Service harvest: Your Harvest Personal Access Token. - Service productive: Your Productive personal access token. - Service totango: Your Totango personal access token.
personalApiToken string: Field usage depends on service value: - Service circleci: Your CircleCI Personal API token. - Service monday: Your Monday.com Personal API Token.
pgpPassPhrase string: Field usage depends on service value: - Service azure_blob_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true.
pgpSecretKey string: Field usage depends on service value: - Service azure_blob_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true.
phoneNumber string: Field usage depends on service value: - Service itunes_connect: Register the number on AppleId Account Page for 2FA
planType string: Field usage depends on service value: - Service justcall: Your JustCall Plan Type.
port number: Field usage depends on service value: - Service aurora: The port number. - Service aurora_postgres: The port number. - Service aveva_pi: Port number at which the AF Server is running - Service azure_postgres: The port number. - Service azure_sql_db: The port number. - Service azure_sql_managed_db: The port number. - Service clarity: The port number. - Service cockroachdb: The port number. - Service databricks_db: The port of your SQL warehouse. - Service db2i_hva: The port number. - Service db2i_sap_hva: The port number. - Service documentdb: Port of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: The port number. - Service ehr: The port number. - Service elastic_cloud: The port number. - Service es_self_hosted: The port number. - Service ftp: FTP port. - Service google_cloud_mysql: The port number. - Service google_cloud_postgresql: The port number. - Service google_cloud_sqlserver: The port number. - Service hana_sap_hva_b1: The port number. - Service hana_sap_hva_ecc: The port number. - Service hana_sap_hva_ecc_netweaver: The port number. - Service hana_sap_hva_s4: The port number. - Service hana_sap_hva_s4_netweaver: The port number. - Service heroku_postgres: The port number. - Service jira: The Jira service host port. - Service magento_mysql: The port number. - Service magento_mysql_rds: The port number. - Service maria: The port number. - Service maria_azure: The port number. - Service maria_rds: The port number. - Service mysql: The port number. - Service mysql_azure: The port number. - Service mysql_rds: The port number. - Service netsuite_suiteanalytics: The NetSuite service host port. - Service opendistro: The port number. - Service opensearch: The port number. - Service oracle: The port number. - Service oracle_ebs: The port number. - Service oracle_hva: The port number. - Service oracle_rac: The port number. - Service oracle_rds: The port number. - Service oracle_sap_hva: The port number. - Service postgres: The port number. - Service postgres_rds: The port number. - Service redshift_db: Port number - Service sap_hana: The SAP HANA port number. - Service sap_s4hana: The SAP S/4 port number. - Service sftp: SFTP port. - Service snowflake_db: The Snowflake optional port number. - Service splunk: The Splunk service host port. - Service sql_server: The port number. - Service sql_server_hva: The port number. - Service sql_server_rds: The port number. - Service sql_server_sap_ecc_hva: The port number.
postClickAttributionWindowSize string: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on clicks. Default value: DAY_30
prebuiltReport string: Field usage depends on service value: - Service facebook: The name of report of which connector will sync the data. Possible prebuilt_report values. - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data.
prefix string: Field usage depends on service value: - Service aws_cloudtrail: If prefix is present when configuring the bucket. - Service aws_cost_report: Folder path to the aws_cost_report files within the bucket. - Service aws_inventory: The prefix if you used one when configuring the bucket. - Service azure_blob_storage: All files and folders under this folder path will be searched for files to sync. - Service box: All files and folders under this folder path will be searched for files to sync. - Service cloudfront: The name of the CloudFront folder in the bucket. - Service dropbox: All files and folders under this folder path will be searched for files to sync. - Service ftp: All files and folders under this folder path will be searched for files to sync. - Service gcs: All files and folders under this folder path will be searched for files to sync. - Service google_drive: 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 - Service kinesis: Folder path to the Kinesis files within the bucket. - Service marin: Folder path to the Marin manifest file. - Service microsoft_dynamics_365_fo: Folder name in which the exported dynamics 365 data resides. - Service s3: All files and folders under this folder path will be searched for files to sync. - Service segment: Folder path to the Segment files within the bucket. Must be populated if sync_type is set to S3. - Service sftp: All files and folders under this folder path will be searched for files to sync. - Service share_point: All files and folders under this folder path link will be searched for files to sync. This can be any shared folder link. - Service wasabi_cloud_storage: All files and folders under this folder path will be searched for files to sync.
primaryKey string: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission primary key.
primaryKeys string[]: Field usage depends on service value: - Service workday: Primary Keys
privateKey string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS REST API private key. - Service adobe_analytics: The complete contents of your private key file including the start and end tags (----BEGIN PRIVATE KEY---- to ----END PRIVATE KEY----). - Service adp_workforce_now: Private Key. - Service anaplan: The contents of your private key file. Must be populated if auth_mode is set to Certificate. - Service apple_search_ads: The contents of your secret key file. Must be populated if is_auth2_enabled is set to false. - Service braintree: The contents of your secret key file. - Service braintree_sandbox: The contents of your secret key file. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud private key. - Service qualtrics: Your private key - Service salesforce: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service snowflake_db: Private access key. The field should be specified if authentication type is KEY_PAIR.
privateToken string: Field usage depends on service value: - Service eventbrite: Your Eventbrite private token.
product string: Field usage depends on service value: - Service webconnex: Your Webconnex product.
profiles string[]: Field usage depends on service value: - Service amazon_ads: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SpecificProfiles. - Service google_analytics: Specific User Profile IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_mcf: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
profilesAmazonDsp string: Field usage depends on service value: - Service amazon_dsp: Comma-separated list of your Amazon DSP profiles.
projectAccessToken string: Field usage depends on service value: - Service rollbar: Your Rollbar project access token.
projectCredentials GetConnectorConfigProjectCredential[]: Field usage depends on service value: - Service amplitude: * Project(s)
projectId string: Field usage depends on service value: - Service bigquery_db: BigQuery project ID - Service google_analytics_360: The project ID. - Service google_analytics_4_export: The Project ID. - Service mixpanel: Project ID
projectIds string: Field usage depends on service value: - Service sentry: Your Sentry project IDs.
projectKey string: Field usage depends on service value: - Service commercetools: Your commercetools project key.
projects string[]: Field usage depends on service value: - Service asana: Specific Project IDs to sync. Must be populated if syncMode is set to SpecificProjects. - Service jira: Specific projects to sync. Must be populated if syncMode is set to CUSTOM.
properties string[]: Field usage depends on service value: - Service google_analytics_4: The array of strings in the properties/{id} format where id is a Google Analytics 4 property identifier. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
propertyId string: Field usage depends on service value: - Service cloudbeds: Your Cloudbeds property IDs.
publicKey string: Field usage depends on service value: - Service aurora: Public Key - Service aurora_postgres: Public Key - Service azure_blob_storage: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_cosmos_for_mongo: Public Key - Service azure_postgres: Public Key - Service azure_service_bus: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_sql_db: Public Key. - Service azure_sql_managed_db: Public Key. - Service braintree: The contents of your PEM certificate file. - Service braintree_sandbox: The contents of your PEM certificate file. - Service clarity: Public Key. - Service cockroachdb: Public Key - Service db2i_hva: Public Key - Service db2i_sap_hva: Public Key - Service documentdb: Public Key - Service dynamics_365_fo: Public Key. - Service ehr: Public Key. - Service elastic_cloud: Public Key - Service es_self_hosted: Public Key - Service google_cloud_mysql: Public Key - Service google_cloud_postgresql: Public Key - Service google_cloud_sqlserver: Public Key. - Service hana_sap_hva_b1: Public Key - Service hana_sap_hva_ecc: Public Key - Service hana_sap_hva_ecc_netweaver: Public Key - Service hana_sap_hva_s4: Public Key - Service hana_sap_hva_s4_netweaver: Public Key - Service heroku_postgres: Public Key - Service magento_mysql: Public Key - Service magento_mysql_rds: Public Key - Service maria: Public Key - Service maria_azure: Public Key - Service maria_rds: Public Key - Service mongo: Public Key - Service mongo_sharded: Public Key - Service mysql: Public Key - Service mysql_azure: Public Key - Service mysql_rds: Public Key - Service opendistro: Public Key - Service opensearch: Public Key - Service oracle: Public Key - Service oracle_ebs: Public Key - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud public key. - Service oracle_hva: Public Key - Service oracle_rac: Public Key - Service oracle_rds: Public Key - Service oracle_sap_hva: Public Key - Service partnerstack_vendor: Your PartnerStack Vendor Public key. - Service postgres: Public Key - Service postgres_rds: Public Key - Service sap_hana: Public Key - Service sap_s4hana: Public Key - Service sftp: Public Key - Service sql_server: Public Key. - Service sql_server_hva: Public Key. - Service sql_server_rds: Public Key. - Service sql_server_sap_ecc_hva: Public Key.
publicationName string: Field usage depends on service value: - Service aurora_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service azure_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service google_cloud_postgresql: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service heroku_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres_rds: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT".
publisherId string: Field usage depends on service value: - Service skimlinks: Your Skimlinks publisher ID.
pullArchivedCampaigns boolean: Field usage depends on service value: - Service outbrain: Include or ignore results from archived campaigns
pythonVersion string
queryId string: Field usage depends on service value: - Service google_display_and_video_360: The ID of the query whose configuration you want to reuse. This is a required parameter when config_method is set to REUSE_EXISTING.
queryParamValue string: Field usage depends on service value: - Service alchemer: Your Alchemer API key. - Service birdeye: Your Birdeye query-param-value.
quotaProjectId string: Field usage depends on service value: - Service bigquery_db: Specify a different project ID to account for quota and billing of Fivetran query workload
quoteChar string: Field usage depends on service value: - Service azure_blob_storage: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service gcs: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service google_drive: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service s3: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service sftp: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service share_point: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
quoteCharacterEnabled boolean: Field usage depends on service value: - Service azure_blob_storage: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service gcs: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service google_drive: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service s3: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service sftp: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service share_point: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
rateLimitPlan string: Field usage depends on service value: - Service vimeo: Your Vimeo rate limit plan.
refreshToken string: Field usage depends on service value: - Service ironsource: Your Ironsource Client Secret.
refreshTokenExpiresAt string: Field usage depends on service value: - Service pinterest_ads: The expiration date of the refresh token. Unix timestamp in seconds
region string: Field usage depends on service value: - Service algolia: Your Algolia analytics region. - Service amazon_ads: The region used by the Amazon Ads profile. - Service amazon_selling_partner: The region used by the Amazon Selling Partner profile. - Service anaplan: Your Anaplan account region - Service atlassian_ops_genie: Your company's Osgenie region (usually company.opsgenie.com) - Service awin: Your Awin Region. - Service aws_lambda: The AWS region code for the DynamoDB instance. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Region - Service concur: The region. - Service cvent: Your Cvent region. - Service everflow: Your Everflow region. - Service exact_online: Your Exact Online region. - Service getfeedback: Your GetFeedback region. - Service happyfox: Your HappyFox region. - Service keypay: Your KeyPay region. - Service medallia_agile_research: Your Medallia Agile region. - Service messagebird: Your MessageBird Account region. - Service mixpanel: Data Region - Service navan: Your Navan region. - Service on24: Your ON24 region. - Service pendo: The Pendo account region. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Region. - Service ringover: Your Ringover region. - Service samsara: The region of your Samsara account. For instance, if your region is EUROPE, provide eu.samsara in the Region field. If your region is not in Europe, provide samsara. - Service snyk: Your Snyk region. - Service talkdesk: Your Talkdesk region (".com",".eu","ca.com") - Service totango: Your Totango region. - Service transcend: Your Transcend region. - Service vonage_contact_center: Your Vonage Contact Center region. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: US_EAST_1. - Service workday_strategic_sourcing: Your Workday Strategic Sourcing Region. - Service zoho_books: Your Zoho Books application host region. - Service zoho_campaigns: Your Zoho Campaigns application host region. - Service zoho_desk: Your Zoho Desk domain. - Service zoho_inventory: Your Zoho Inventory application host region.
regionApiUrl string: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution API URL region.
regionAuthUrl string: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution auth URL region.
regionTokenUrl string: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution token URL region.
regionUrl string: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management region URL.
replicaId number: Field usage depends on service value: - Service aurora: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service google_cloud_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
replicationSlot string: Field usage depends on service value: - Service aurora_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service azure_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service google_cloud_postgresql: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service heroku_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres_rds: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT".
reportConfigs GetConnectorConfigReportConfig[]: Field usage depends on service value: - Service yahoo_dsp: Specify the reports you want to sync. This is optional.
reportConfigurationIds string[]: Field usage depends on service value: - Service double_click_campaign_manager: You can select only one Floodlight Configuration ID per account.
reportFormatType string: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
reportGranularity string: Field usage depends on service value: - Service pinterest_ads: Granularity at which reports will be
reportKeys string: Field usage depends on service value: - Service rakutenadvertising: Your Rakuten Advertising report keys.
reportLists GetConnectorConfigReportList[]: Field usage depends on service value: - Service spotify_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
reportServiceApiKey string: Field usage depends on service value: - Service adyen: Your Report Service API key.
reportSuites string[]
reportTimezone string: Field usage depends on service value: - Service criteo: Report Timezone
reportType string: Field usage depends on service value: - Service adroll: The report type you want. Default value: ALL_ADS. - Service double_click_campaign_manager: Type of reporting data to sync. Default value: STANDARD. - Service google_display_and_video_360: The type of the report to create. This is a required parameter when config_method is set to CREATE_NEW. - Service youtube_analytics: The name of report of which connector will sync the data.
reportUrl string: Field usage depends on service value: - Service workday: URL for a live custom report.
reports GetConnectorConfigReport[]: Field usage depends on service value: - Service google_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics_4: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_search_ads_360: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service google_search_console: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service workday: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
reportsLinkedinAds string[]: Field usage depends on service value: - Service linkedin_ads: Specific analytics reports to sync. Must be populated if adAnalytics is set to 'SpecificReports'.
repositories string[]: Field usage depends on service value: - Service github: Specific Repository IDs to sync. Must be populated if syncMode is set to SpecificRepositories.
resourceToken string: Field usage depends on service value: - Service cosmos: A token that provides access to a specific Azure Cosmos DB resource. Required for the RESOURCE_TOKEN data access method.
resourceUrl string: Field usage depends on service value: - Service dynamics_365: URL at which Dynamics 365 is accessed
restApiLimit number: Field usage depends on service value: - Service pardot: The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
rfcLibraryPath string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service hana_sap_hva_s4_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service oracle_sap_hva_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files.
role string: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Role ID for connection. - Service snowflake_db: Snowflake Connector role name
roleArn string: Field usage depends on service value: - Service appsflyer: S3 Role ARN - Service aws_cloudtrail: The Role ARN required for authentication. - Service aws_cost: The Role ARN required for authentication. - Service aws_cost_report: The Role ARN required for authentication. - Service aws_inventory: The Role ARN required for authentication. - Service aws_lambda: The Role ARN required for authentication. - Service aws_msk: If sasl_mechanism is set to IAM, enter your Role ARN - Service cloudfront: The Role ARN required for authentication. - Service dynamodb: Role ARN - Service heap: The Role ARN required for authentication. - Service kinesis: The Role ARN required for authentication. - Service s3: The Role ARN required for authentication. Required for connector creation when syncing using private bucket. - Service segment: The Role ARN required for authentication. Must be populated if sync_type is set to S3.
rollbackWindow number: Field usage depends on service value: - Service appsflyer: Rollback window
rollbackWindowSize number: Field usage depends on service value: - Service bingads: A period of time in days during which a conversion is recorded.
s3Bucket string: Field usage depends on service value: - Service webhooks: The S3 bucket name. Required if bucket_service is set to S3.
s3ExportBucket string: Field usage depends on service value: - Service braze: Your S3 user export bucket. Required if AWS_S3 is the export_storage_type
s3ExportExternalId string: Field usage depends on service value: - Service braze: This is the same as your group_id, used if export_storage_type is AWS_S3
s3ExportFolder string: Field usage depends on service value: - Service braze: Your S3 user export folder name. Required if AWS_S3 is the export_storage_type
s3ExportRoleArn string: Field usage depends on service value: - Service braze: The Role ARN required for authentication required if AWS_S3 is the export_storage_type
s3RoleArn string: Field usage depends on service value: - Service adjust: Used if the export_storage_type is AWS_S3, the Role ARN required for authentication. - Service webhooks: The Role ARN required for authentication. Required if bucket_service is set to S3.
s3bucket string: Field usage depends on service value: - Service adobe_analytics_data_feed: The S3 bucket name. - Service braze: Your S3 bucket required if AWS_S3 is the cloud_storage_type - Service sailthru: Name of the bucket configured to receive sailthru connect data.
s3externalId string: Field usage depends on service value: - Service braze: 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 - Service sailthru: The external ID is a string that designates who can assume the role.
s3folder string: Field usage depends on service value: - Service braze: Your S3 folder name required if AWS_S3 is the cloud_storage_type
s3path string: Field usage depends on service value: - Service sailthru: Copy and use this to configure Sailthru Connect in your sailthru account.
s3roleArn string: Field usage depends on service value: - Service adobe_analytics_data_feed: The Role ARN required for authentication. - Service braze: The Role ARN required for authentication required if AWS_S3 is the cloud_storage_type - Service sailthru: Role ARN of the IAM role created for Fivetran.
salesAccountSyncMode string: Field usage depends on service value: - Service itunes_connect: Whether to sync all sales accounts or specific sales accounts.
salesAccounts string[]: Field usage depends on service value: - Service itunes_connect: Specific sales account to sync. Must be populated if sales_account_sync_mode is set to SpecificSalesAccounts.
salesforceSecurityToken string: Field usage depends on service value: - Service pardot: The Pardot user's Salesforce SSO Account Security Token.
sandboxAccount string: Field usage depends on service value: - Service gocardless: Your GoCardless account type.
sapSchema string: Field usage depends on service value: - Service db2i_hva: The SAP schema. - Service db2i_sap_hva: SAP schema name. - Service sql_server_hva: SAP Schema Name. Required only for High-Volume Agent SAP ECC connector. - Service sql_server_sap_ecc_hva: SAP Schema Name.
sapSourceSchema string: Field usage depends on service value: - Service hana_sap_hva_b1: The schema name where the HANA tables reside. - Service hana_sap_hva_ecc: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_ecc_netweaver: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4_netweaver: The Hana schema name where the SAP tables reside.
sapUser string: Field usage depends on service value: - Service oracle_sap_hva: The Oracle schema name where the SAP tables reside.
saslMechanism string: Field usage depends on service value: - Service apache_kafka: SASL Mechanism - Service aws_msk: If security_protocol is set to SASL, enter the SASL Mechanism
saslPlainKey string: Field usage depends on service value: - Service apache_kafka: API Key
saslPlainSecret string: Field usage depends on service value: - Service apache_kafka: API Secret
saslScram256Key string: Field usage depends on service value: - Service apache_kafka: API Key
saslScram256Secret string: Field usage depends on service value: - Service apache_kafka: API Secret
saslScram512Key string: Field usage depends on service value: - Service apache_kafka: API Key - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
saslScram512Secret string: Field usage depends on service value: - Service apache_kafka: API Secret - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
schemaRegistryCredentialsSource string: Field usage depends on service value: - Service apache_kafka: Schema Registry Credentials source - Service aws_msk: Schema Registry Credentials source - Service confluent_cloud: Schema Registry Credentials source
schemaRegistryKey string: Field usage depends on service value: - Service apache_kafka: Schema Registry Key - Service aws_msk: Schema Registry Key - Service azure_service_bus: The key used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Key
schemaRegistrySecret string: Field usage depends on service value: - Service apache_kafka: Schema Registry Secret - Service aws_msk: Schema Registry Secret - Service azure_service_bus: The secret used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Secret
schemaRegistryUrls string[]: Field usage depends on service value: - Service apache_kafka: Your schema registry URLs - Service aws_msk: Your schema registry URLs - Service azure_service_bus: The comma-separated list of schema registry servers in the server:port format - Service confluent_cloud: Your schema registry URLs
scope string: Field usage depends on service value: - Service ebay: Your eBay scopes.
scopes string: Field usage depends on service value: - Service cornerstone: Your Cornerstone scopes.
seats string[]: Field usage depends on service value: - Service yahoo_dsp: Specific Seats to sync. Must be populated if sync_mode_seat is set to SPECIFIC_SEATS.
secret string: Field usage depends on service value: - Service appcues: Your Appcues Secret. - Service buildium: Your Buildium API secret. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure secret. - Service loopio: Your Loopio Secret. - Service mode: Your Mode Secret. - Service playvox_workforce_management: Your Playvox Workforce Management client secret. - Service twilio: The Twilio API secret - Service uservoice: The UserVoice API secret. - Service venminder: Your Venminder secret. - Service vts: Your VTS secret.
secretKey string: Field usage depends on service value: - Service afterpay: Your Afterpay Secret Key. - Service appsflyer: Your AWS secret key. - Service bigquery_db: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service checkr: Your Checkr secret key. - Service ezofficeinventory: Your EZOfficeInventory API secret key. - Service gcs: Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket. - Service ironsource: Your Ironsource Client ID. - Service line_ads: Your LINE Ads secret key. - Service mailjet: Your Mailjet secret key. - Service partnerstack_vendor: Your PartnerStack Vendor Secret key. - Service paypal: Client Secret of your PayPal client application. - Service paypal_sandbox: Client Secret of your PayPal client application. - Service phoenix_ads: Your Phoenix Ads Secret key. - Service retailnext: Your RetailNext secret key. - Service statsig: Your Statsig secret key. - Service yotpo: Your Yotpo Secret key
secrets string: Field usage depends on service value: - Service aws_lambda: The secrets that should be passed to the function at runtime. - Service azure_function: The secrets that should be passed to the function at runtime. - Service google_cloud_function: The secrets that should be passed to the function at runtime.
secretsLists GetConnectorConfigSecretsList[]: Field usage depends on service value: - Service aws_lambda: List of Secrets that should be passed to the function at runtime. - Service azure_function: The list of secrets that should be passed to the function at runtime. - Service google_cloud_function: The list of secrets that should be passed to the function at runtime.
securityProtocol string: Field usage depends on service value: - Service apache_kafka: Security protocol for Kafka interaction. - Service aws_msk: The security protocol for Kafka interaction. - Service confluent_cloud: Security protocol for Confluent Cloud interaction. - Service heroku_kafka: Security protocol for Heroku Kafka interaction.
segments string[]: Field usage depends on service value: - Service google_analytics: 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.
selectedEventTypes string[]: Field usage depends on service value: - Service salesforce_marketing_cloud: Select the event types to be synced.
selectedExports string[]: Field usage depends on service value: - Service anaplan: 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.
senderId string: Field usage depends on service value: - Service sage_intacct: Your Sender ID
senderPassword string: Field usage depends on service value: - Service sage_intacct: Your Sender Password
server string: Field usage depends on service value: - Service castor_edc: Your Castor EDC Server.
serverAddress string: Field usage depends on service value: - Service tableau_source: Your Tableau Source server address.
serverRegion string: Field usage depends on service value: - Service clockify: Your Clockify server region.
serverUrl string: Field usage depends on service value: - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence Instance URL. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud Instance URL.
serverVariable string: Field usage depends on service value: - Service myosh: Your myosh server variable.
servers string[]: Field usage depends on service value: - Service apache_kafka: Comma-separated list of Kafka servers in the format server:port. - Service aws_msk: Comma-separated list of Kafka servers in the server:port format. - Service confluent_cloud: Comma-separated list of Confluent Cloud servers in the format server:port. - Service heroku_kafka: Comma-separated list of Heroku Kafka servers in the format server:port.
serviceAccount string: Field usage depends on service value: - Service google_drive: Share the folder with the email address
serviceAccountEmail string: Field usage depends on service value: - Service google_cloud_function: Provide Invoker role to this service account.
serviceAccountKey string: Field usage depends on service value: - Service firebase: The contents of your service account key file. Required for authentication.
serviceAccountSecret string: Field usage depends on service value: - Service mixpanel: Service Account Secret
serviceAccountUsername string: Field usage depends on service value: - Service mixpanel: Service Account Username
serviceAuthentication string: Field usage depends on service value: - Service dsv: A base64 encoded variant of your username:password string. Required for authentication.
serviceName string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service walmart_marketplace: Your Walmart Marketplace service name.
serviceVersion string
sftpHost string: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP host. - Service salesforce_marketing_cloud: Host
sftpIsKeyPair boolean: Field usage depends on service value: - Service adobe_analytics_data_feed: Log in with key pair or password - Service salesforce_marketing_cloud: Set this field if you use a key pair for logging into your SFTP server. Don't set it if you use a username and password
sftpPassword string: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP password required if sftp_is_key_pair is false - Service salesforce_marketing_cloud: Password
sftpPort number: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP port. - Service salesforce_marketing_cloud: Port
sftpPublicKey string: Field usage depends on service value: - Service adobe_analytics_data_feed: Public Key - Service salesforce_marketing_cloud: Public Key
sftpUser string: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP user. - Service salesforce_marketing_cloud: User
shareUrl string: Field usage depends on service value: - Service share_point: Your SharePoint folder URL. You can find the folder URL by following the steps mentioned here.
sheetId string: Field usage depends on service value: - Service google_sheets: 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.
shop string: Field usage depends on service value: - Service shopify: The Shopify shop name. Can be found in the URL before .myshopify.com.
shopDomain string: Field usage depends on service value: - Service triple_whale: Your Triple Whale shop domain.
shortCode string: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce eight-character string assigned to a realm for routing purposes.
shouldSyncEventsWithDeletedProfiles boolean: Field usage depends on service value: - Service klaviyo: Sync events linked to deleted profiles
showRecordsWithNoMetrics boolean: Field usage depends on service value: - Service apple_search_ads: Turn the toggle on if you want the reports to also return records without metrics.
sid string: Field usage depends on service value: - Service twilio: The Twilio API key SID
signerPublicKey string: Field usage depends on service value: - Service azure_blob_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service ftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service gcs: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service s3: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service sftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service wasabi_cloud_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed.
siteAddress string: Field usage depends on service value: - Service teamwork: Your Teamwork site address.
siteId string: Field usage depends on service value: - Service microsoft_lists: The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the id field in the Graph API response for sites. - Service salesforce_commerce_cloud: The name of the site from which you want to sync data.
siteName string: Field usage depends on service value: - Service microsoft_lists: The Name of the SharePoint site. The Site Name is the name field in the Graph API response for sites. - Service tableau_source: Your Tableau Source site name.
siteUrls string[]: Field usage depends on service value: - Service google_search_console: Specific Site URLs to sync. Must be populated if sync_mode is set to SpecificSites.
skipAfter number: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service box: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service dropbox: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service email: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service ftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service gcs: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service google_drive: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination. - Service sftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service share_point: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service wasabi_cloud_storage: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
skipBefore number: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified before syncing data. - Service box: We will skip over the number of lines specified before syncing data. - Service dropbox: We will skip over the number of lines specified before syncing data. - Service email: We will skip over the number of lines specified before syncing data. - Service ftp: We will skip over the number of lines specified before syncing data. - Service gcs: We will skip over the number of lines specified before syncing data. - Service google_drive: We will skip over the number of lines specified before syncing data. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified before syncing data. - Service sftp: We will skip over the number of lines specified before syncing data. - Service share_point: We will skip over the number of lines specified before syncing data. - Service wasabi_cloud_storage: We will skip over the number of lines specified before syncing data.
skipEmptyReports boolean: Field usage depends on service value: - Service google_ads: Toggles the "Skip empty reports" feature. Enabled by default
sncCertificate string
sncCertificateSource string
sncFivetranName string
sncLibraryPath string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Path to the external security product's library. - Service hana_sap_hva_s4_netweaver: Path to the external security product's library.
sncMode string
sncMyName string
sncName string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Client SNC name. - Service hana_sap_hva_s4_netweaver: Client SNC name.
sncPartnerName string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Communication partner's SNC name. - Service hana_sap_hva_s4_netweaver: Communication partner's SNC name.
sncSourceName string
soapUri string: Field usage depends on service value: - Service marketo: Marketo SOAP API Endpoint.
socialDataSyncTimeframe string: Field usage depends on service value: - Service linkedin_company_pages: The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: SIX .
source string: Field usage depends on service value: - Service adobe_analytics_data_feed: The data source.
storeHash string: Field usage depends on service value: - Service big_commerce: The BigCommerce store hash.
storeId string: Field usage depends on service value: - Service reviewsio: Your REVIEWS.io store ID
subDomain string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS subdomain. - Service activecampaign: Your ActiveCampaign sub-domain. - Service acumatica: Your Acumatica subdomain. - Service ada: Your Ada sub-domain. - Service alchemer: Your Alchemer sub-domain. - Service atlassian_jira_align: Your Jira Align base URL. - Service azure_boards: Your Azure Boards Organization Name. - Service azure_devops: Your Azure Organization Name - Service betterworks: Your Betterworks subdomain. - Service bubble: Your Bubble subdomain. - Service buildium: Your Buildium subdomain. - Service canvas_by_instructure: Your Canvas by Instructure domain. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 subdomain. - Service chargebee_product_catalog_2: Your Chargebee subdomain. - Service checkr: Your Checkr subdomain. - Service clubspeed: Your Clubspeed subdomain. - Service collibra: Your collibra subdomain. - Service compliance_checkpoint: Your Compliance Checkpoint subdomain. - Service concord: Your Concord Sub Domain. - Service contrast_security: Your Contrast Security subdomain. - Service customerio: Your Customer.io region-specific Subdomain. - Service dbt_cloud: Your dbt Cloud API server region. - Service deputy: Your Deputy subdomain. - Service docebo: Your Docebo subdomain. - Service drata: Your Drata sub_domain. - Service eventsforce: Your Eventsforce subdomain. - Service ezofficeinventory: Your EZOfficeInventory Subdomain. - Service fountain: Your Fountain subdomain. - Service freshchat: Your Freshchat Sub Domain - Service gainsight_customer_success: The subdomain of your Gainsight account. - Service gainsight_product_experience: Your Gainsight Product Experience subdomain. - Service genesys: Your Genesys subdomain. - Service green_power_monitor: Your GreenPowerMonitor subdomain. - Service infobip: Your Infobip sub_domain. - Service insightly: Your company's Insightly subdomain name. - Service instructure: The Sub domain in which your Instructure account is hosted. - Service jamf: Your Jamf subdomain. - Service kandji: Your Kandji Subdomain. - Service khoros_care: Your Khoros Care subDomain. - Service looker_source: Your looker SubDomain name. - Service lucca: Your Lucca subdomain. - Service mailgun: Your Mailgun subdomain. - Service matomo: Your Matomo subdomain. - Service maxio_chargify: Enter Your Subdomain. - Service myosh: Your myosh subdomain. - Service namely: Your Namely subdomain. - Service nylas: Your Nylas subdomain. - Service okta: Your Okta subdomain. - Service picqer: Your Picqer subdomain. - Service pinpoint: Your Pinpoint sub domain name. - Service piwik_pro: Your Piwik PRO subdomain. - Service playvox: Your Playvox Subdomain. - Service posthog: Your PostHog data region (app or eu). - Service recurly: Your company's Recurly subdomain. - Service reltio: Your Reltio subdomain. - Service revel: Your Revel Systems subDomain. - Service rundeck: Your Rundeck subdomain. - Service sage_hr: Your Sage HR subdomain. - Service salesforce_marketing_cloud: Your Salesforce Marketing Cloud subdomain. - Service salsify: Your Salsify Organization ID. - Service sap_success_factors: Your SAP SuccessFactors Subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service starrez: Your StarRez subdomain - Service sugarcrm: Your SugarCRM subdomain. - Service tableau_source: Your Tableau Source subdomain. - Service tempo: Your Tempo subdomain. - Service testrail: Your TestRail subdomain. - Service thinkific: Your Thinkific subdomain. - Service totango: Your Totango Subdomain. - Service tymeshift: Your Tymeshift subdomain. - Service upland: Your Upland Software subDomain. - Service wordpress: Your WordPress subdomain. - Service workable: Your Workable Subdomain. - Service wrike: Your Wrike Subdomain.
subdomain string: Field usage depends on service value: - Service bamboohr: The subdomain used to access your account. If you access BambooHR at 'https://mycompany.bamboohr.com', then the subdomain is 'mycompany'. - Service datadog: Your Datadog subdomain. - Service ebay: Your eBay environment. - Service freshdesk: Your company's freshdesk subdomain (usually company.freshdesk.com). - Service freshsales: Your Freshsales domain. - Service freshservice: Your company's freshservice subdomain (usually company.freshservice.com). - Service freshsuccess: Your Freshsuccess subdomain. - Service gorgias: Your Gorgias subdomain. - Service jama_software: Your Jama Software subdomain. - Service klarna: Your Klarna subdomain. - Service learnupon: Your Learnupon subdomain. - Service maxio_saasoptics: Your Maxio SaaSOptics subdomain. - Service medallia: Medallia subdomain - Service packiyo: Your Packiyo subdomain. - Service qmatic_data_connect: Your Qmatic Data Connect subdomain. - Service sana: Your Sana subdomain. - Service skillstx: Your SkillsTX subdomain. - Service smarthr: Your SmartHR subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service toast: Your Toast domain. - Service vts: Your VTS Subdomain. - Service zendesk_chat: Your Zendesk domain.
subscriberName string: Field usage depends on service value: - Service azure_service_bus: 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
subscription string: Field usage depends on service value: - Service retailnext: Your RetailNext subscription.
subscriptionKey string: Field usage depends on service value: - Service dsv: Your DSV subscription key.
supportConnectedAccountsSync boolean: Field usage depends on service value: - Service stripe: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts. - Service stripe_test: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.
supportNestedColumns boolean: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
surveyIds string: Field usage depends on service value: - Service qualaroo: Array of Qualaroo Survey IDs.
swipeAttributionWindow string: Field usage depends on service value: - Service snapchat_ads: The time period to attribute conversions based on swipes. Default value: DAY_28
syncDataLocker boolean: Field usage depends on service value: - Service appsflyer: Sync AppsFlyer Data Locker. Default value is true, set it to false to sync AppsFlyer data using only webhooks.
syncFormat string: Field usage depends on service value: - Service webhooks: The webhooks sync format. Default value: Unpacked. Unpacked messages must be valid JSON.
syncFormulaFields boolean: Field usage depends on service value: - Service financial_force: Enable this option to sync formula fields directly (default value = false) - Service salesforce: Enable this option to sync formula fields directly (default value = false) - Service salesforce_sandbox: Enable this option to sync formula fields directly (default value = false)
syncMetadata boolean: Field usage depends on service value: - Service facebook_ads: Parameter defining whether to enable or disable metadata synchronisation. Default value: TRUE.
syncMethod string: Field usage depends on service value: - Service aws_lambda: Sync Method
syncMode string: Field usage depends on service value: - Service adroll: Whether to sync all advertisables or specific advertisables. Default value: AllAdvertisables. - Service amazon_ads: Option to select connector should sync all profiles or specific profiles. - Service anaplan: Whether to sync all exports or specific exports. - Service apple_search_ads: Sync Mode - Service asana: Whether to sync all projects or specific projects. - Service bingads: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service double_click_campaign_manager: Whether to sync all user profiles or specific ones. Default value: AllAccounts. - Service dynamodb: Which packed mode setting to use. Default value: UsePackedModeOnly. - Service facebook: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_ad_account: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service facebook_ads: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_pages: Whether to sync all accounts or specific accounts. Default value: AllPages. - Service github: Whether to sync all repositories or specific repositories. - Service google_ads: Whether to sync all accounts or specific accounts. - Service google_analytics: Whether to sync all accounts or specific accounts. - Service google_analytics_4: Whether to sync all accounts or specific accounts. - Service google_analytics_mcf: Whether to sync all accounts or specific accounts. Default value: ALL_ACCOUNTS - Service google_search_console: Whether to sync all sites or specific sites. - Service instagram_business: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service iterable: Events Sync Mode. - Service jira: Whether to sync all projects or specific projects. - Service linkedin_ads: Whether to sync all accounts or specific accounts. Default value: AllAccounts - Service pendo: Whether to sync all App IDs or specific App IDs. Default value: AllAppIds. - Service pinterest_ads: Whether to sync all advertisers or specific advertisers. - Service reddit_ads: Whether to sync all accounts or specific accounts. - Service salesforce_marketing_cloud: Select the sync mode. - Service snapchat_ads: Whether to sync all organizations or specific organizations. Default value: AllOrganizations. - Service spotify_ads: Whether to sync all ad accounts or specific ad accounts. - Service taboola: Whether to sync all accounts or specific accounts. - Service the_trade_desk: Whether to sync all accounts or specific accounts. - Service tiktok_ads: Whether to sync all advertiser accounts or specific accounts. - Service twilio: Whether to sync all accounts or specific accounts. - Service twitter: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service twitter_ads: Whether to sync all accounts or specific accounts. - Service walmart_dsp: Whether to sync all accounts or specific accounts. - Service yahoo_gemini: Whether to sync all accounts or specific accounts. Default value: SpecificAccounts. - Service zuora: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both. - Service zuora_sandbox: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both.
syncModeAdvertiser string: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all advertisers or specific advertisers. Default value: ALL_ADVERTISERS.
syncModeSeat string: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all seats or specific seats. Default value: ALL_SEATS.
syncMultipleAccounts boolean: Field usage depends on service value: - Service reddit_ads: 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
syncPackMode string: Field usage depends on service value: - Service cosmos: 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 Azure Cosmos DB Sync Pack Mode Options documentation. - Service documentdb: Indicates whether synced data will be packed into a single entry(column), or unpacked with one layer of nested fields.
syncPullApi boolean: Field usage depends on service value: - Service appsflyer: These options are for Appsflyer's Pull API, and are only necessary for syncing events from Pull API.
syncType string: Field usage depends on service value: - Service apache_kafka: Kafka sync type. Unpacked messages must be valid JSON. - Service aws_msk: The sync type. Unpacked messages must be valid JSON. - Service azure_event_hub: Sync type. Unpacked messages must be valid JSON. - Service azure_service_bus: 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 - Service confluent_cloud: Kafka sync type. Unpacked messages must be valid JSON. - Service heroku_kafka: Heroku Kafka sync type. Unpacked messages must be valid JSON. - Service segment: The Segment connector sync type.
sysnr string
systemId string: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
tableId string: Field usage depends on service value: - Service pigment: Your Pigment table ID.
tableName string: Field usage depends on service value: - Service airtable: Name of table in Airtable
tablesWithoutAccessUpdatedAt string: Field usage depends on service value: - Service hubspot: Timestamp to indicate when tables without access was updated
targetEntityId string: Field usage depends on service value: - Service culture_amp: Your Culture Amp Target entity ID.
targetHost string: Field usage depends on service value: - Service d2l_brightspace: Your D2L Brightspace target host.
tdeCertificate string: Field usage depends on service value: - Service sql_server_hva: Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Certificate used to protect a database encryption key
tdeCertificateName string: Field usage depends on service value: - Service sql_server_hva: Name of the Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Name of the Certificate used to protect a database encryption key
tdePassword string: Field usage depends on service value: - Service sql_server_hva: Password of the TDE private key - Service sql_server_sap_ecc_hva: Password of the TDE private key
tdePrivateKey string: Field usage depends on service value: - Service sql_server_hva: Private key associated with the TDE certificate - Service sql_server_sap_ecc_hva: Private key associated with the TDE certificate
teamId string: Field usage depends on service value: - Service asana: Team ID
technicalAccountId string: Field usage depends on service value: - Service adobe_analytics: Technical Account ID from the Service Account (JWT) credentials of your Adobe Project.
templateLabels string[]: Field usage depends on service value: - Service mandrill: Provide the labels to filter the templates
tenant string: Field usage depends on service value: - Service microsoft_entra_id: Your Microsoft Entra ID Tenant. - Service microsoft_power_bi: Your Microsoft Power BI tenant. - Service microsoft_teams: Your Microsoft Teams Tenant. - Service unicommerce: Your uniware tenant. - Service workday: Workday tenant name - Service workday_financial_management: Workday tenant name - Service workday_hcm: Workday tenant name
tenantAppUrl string: Field usage depends on service value: - Service planful: Your Planful tenant app URL.
tenantCode string: Field usage depends on service value: - Service deposco: Your Deposco tenant code.
tenantConfigs GetConnectorConfigTenantConfig[]: Field usage depends on service value: - Service reltio: * tenant(s)
tenantId string: Field usage depends on service value: - Service azure_sql_db: Azure AD tenant ID. - Service azure_sql_managed_db: Azure AD tenant ID. - Service business_central: Tenant ID of your Business Central application - Service crowddev: Your crowd.dev Tenant ID. - Service reltio: Your Reltio tenant ID. - Service servicetitan: Your ServiceTitan tenant ID. - Service visma: Your Visma tenant ID.
tenantName string: Field usage depends on service value: - Service mambu: Your Mambu tenant name.
tenantUrl string: Field usage depends on service value: - Service ivanti: Your Ivanti Tenant URL. - Service playvox_workforce_management: Your Playvox Workforce Management tenant URL. - Service reltio: Your Reltio tenant URL.
testTableName string: Field usage depends on service value: - Service sap_hana: testTableName - Service sap_s4hana: testTableName
timeZone string: Field usage depends on service value: - Service pardot: The time zone configured in your Pardot instance. An empty value defaults to UTC+00:00.
timeframeMonths string: Field usage depends on service value: - Service adobe_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector has been created. Default value: TWELVE . - Service adroll: 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. - Service apple_search_ads: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service bingads: 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. - Service criteo: 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. NOTE: The greater number of months means the initial sync will take more time. - Service double_click_campaign_manager: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service double_click_publishers: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service facebook: 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. - Service facebook_ads: 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. - Service google_ads: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: TWELVE. - Service google_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_4: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_mcf: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service google_display_and_video_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service google_search_ads_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service google_search_console: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service instagram_business: 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. - Service itunes_connect: Historical sync time frame in months. - Service linkedin_ads: 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. - Service outbrain: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service pinterest_ads: 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. - Service reddit_ads: 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. - Service snapchat_ads: 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. - Service spotify_ads: 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: SIX. - Service taboola: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service the_trade_desk: 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. - Service tiktok_ads: 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. - Service twitter: 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. - Service twitter_ads: Historical sync timeframe in months. - Service walmart_dsp: 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. - Service yahoo_dsp: Number of monthsworth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value:THREE. - Service yahoo_gemini: 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`.
timezone string: Field usage depends on service value: - Service rokt: Your Rokt timezone.
timezoneMode string: Field usage depends on service value: - Service apple_search_ads: Determines whether to use UTC or the users timezone from the apple account
tns string: Field usage depends on service value: - Service oracle_hva: Single-tenant database: The database's SID. Multi-tenant database: The database's TNS. - Service oracle_sap_hva: Single-tenant database: The database SID. Multi-tenant database: The database TNS.
toastId string: Field usage depends on service value: - Service toast: Your Toast Restaurant External ID.
token string: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities token. - Service matomo: Your Matomo auth token. - Service mode: Your Mode Token. - Service oracle_moat_analytics: Your Oracle Moat Analytics Token. - Service shareasale: Your ShareASale token. - Service solarwinds_service_desk: Your SolarWinds Service Desk token.
tokenAuthenticatedContainer string: Field usage depends on service value: - Service cosmos: The container name. Required for the RESOURCE_TOKEN data access method.
tokenAuthenticatedDatabase string: Field usage depends on service value: - Service cosmos: The database name. Required for the RESOURCE_TOKEN data access method.
tokenId string: Field usage depends on service value: - Service chargedesk: Your ChargeDesk token ID. - Service mux: Your Mux token ID
tokenKey string: Field usage depends on service value: - Service netsuite_suiteanalytics: Token ID - Service on24: Your ON24 token key. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Token Key.
tokenSecret string: Field usage depends on service value: - Service netsuite_suiteanalytics: Token Secret - Service on24: Your ON24 token secret.
tokenSecretKey string: Field usage depends on service value: - Service mux: Your Mux token secret key
tokenUrlRegion string: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP token URL region.
topics string[]: Field usage depends on service value: - Service azure_service_bus: The comma-separated list of topics which should be synced. Required if you do not have manage permissions
trustStoreType string: Field usage depends on service value: - Service heroku_kafka: Trust Store Type
trustedCert string: Field usage depends on service value: - Service apache_kafka: Kafka trusted certificate. - Service heroku_kafka: Heroku Kafka trusted certificate. Required for TLS security protocol.
truststore string: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Truststore File as Base64 encoded string.
tunnelHost string: Field usage depends on service value: - Service aurora: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service aurora_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_cosmos_for_mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_managed_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service clarity: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service cockroachdb: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service db2i_hva: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service db2i_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service documentdb: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service dynamics_365_fo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service ehr: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service elastic_cloud: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service es_self_hosted: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service google_cloud_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_postgresql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_sqlserver: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_b1: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service heroku_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo_sharded: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service opendistro: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service opensearch: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service oracle: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_ebs: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rac: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_s4hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sftp: Tunnel host address, specify only to connect via SSH tunnel. - Service sql_server: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_sap_ecc_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
tunnelPort number: Field usage depends on service value: - Service aurora: SSH port, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH port, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH port, specify only to connect via an SSH tunnel. - Service clarity: SSH port, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH port, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service documentdb: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH port, specify only to connect via an SSH tunnel. - Service ehr: SSH port, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH port, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH port, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH port, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service maria: SSH port, specify only to connect via an SSH tunnel. - Service maria_azure: SSH port, specify only to connect via an SSH tunnel. - Service maria_rds: SSH port, specify only to connect via an SSH tunnel. - Service mongo: SSH port, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH port, specify only to connect via an SSH tunnel. - Service mysql: SSH port, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH port, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service opendistro: SSH port, specify only to connect using an SSH tunnel. - Service opensearch: SSH port, specify only to connect using an SSH tunnel. - Service oracle: SSH port, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH port, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service postgres: SSH port, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH port, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH port, specify only to connect via an SSH tunnel. - Service sftp: Tunnel port, specify only to connect via SSH tunnel. - Service sql_server: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH port, specify only to connect via an SSH tunnel.
tunnelUser string: Field usage depends on service value: - Service aurora: SSH user, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH user, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH user, specify only to connect via an SSH tunnel. - Service clarity: SSH user, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH user, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service documentdb: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH user, specify only to connect via an SSH tunnel. - Service ehr: SSH user, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH user, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH user, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH user, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service maria: SSH user, specify only to connect via an SSH tunnel. - Service maria_azure: SSH user, specify only to connect via an SSH tunnel. - Service maria_rds: SSH user, specify only to connect via an SSH tunnel. - Service mongo: SSH user, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH user, specify only to connect via an SSH tunnel. - Service mysql: SSH user, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH user, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service opendistro: SSH user, specify only to connect using an SSH tunnel. - Service opensearch: SSH user, specify only to connect using an SSH tunnel. - Service oracle: SSH user, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH user, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service postgres: SSH user, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH user, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH user, specify only to connect via an SSH tunnel. - Service sftp: Tunnel user, specify only to connect via SSH tunnel. - Service sql_server: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH user, specify only to connect via an SSH tunnel.
typeName string: Field usage depends on service value: - Service akamai: Your Akamai type name. - Service bubble: Your Bubble type name.
uniqueId string
updateConfigOnEachSync boolean: Field usage depends on service value: - Service google_display_and_video_360: 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.
updateMethod string: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service azure_postgres: 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. - Service azure_sql_db: (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. - Service azure_sql_managed_db: (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. - Service clarity: (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. - Service dynamics_365_fo: Update Method - Service ehr: (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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: (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. - Service heroku_postgres: 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. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Default value: Teleport - Service snowflake_db: Default value: Teleport - Service sql_server: (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. - Service sql_server_hva: (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. - Service sql_server_rds: (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. - Service sql_server_sap_ecc_hva: (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.
uri string: Field usage depends on service value: - Service cosmos: Cosmos resource instance address.
urlFormat string: Field usage depends on service value: - Service fountain: Your Fountain URL format.
useApiKeys boolean: Field usage depends on service value: - Service mandrill: Whether to use multiple API keys for interaction.
useCustomerBucket boolean: Field usage depends on service value: - Service appsflyer: Use Custom Bucket. Set it to 'true' if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket.
useOracleRac boolean: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using a RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you're using a RAC instance.
usePgpEncryptionOptions boolean: Field usage depends on service value: - Service azure_blob_storage: Set to true if files present in the Azure Blob Storage container are encrypted using PGP. Default value: false. - Service ftp: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service gcs: Set to true if files are encrypted using PGP in the GCS bucket. Default value: false. - Service s3: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service sftp: Set to true if files present in SFTP server are encrypted using PGP. Default value: false. - Service wasabi_cloud_storage: Set to true if files are encrypted using PGP in the Wasabi Cloud Storage bucket. Default value: false.
useServiceAccount boolean: Field usage depends on service value: - Service bigquery_db: BigQuery use service account; default is false
useTemplateLabels boolean: Field usage depends on service value: - Service mandrill: Use template labels to filter templates for sync
useWebhooks boolean: Field usage depends on service value: - Service github: Set to true to capture deletes. - Service xero: Updates to few fields like sent_to_contact in Invoice table might be missed if you don't enable this.
useWorkspace boolean: Field usage depends on service value: - Service bigquery_db: Create and drop tables in a query results dataset. Default is false - Service snowflake_db: Choose a database and schema to create temporary tables for syncs.
user string: Field usage depends on service value: - Service aurora: The user name. - Service aurora_postgres: The user name. - Service azure_cosmos_for_mongo: Username for source database access. - Service azure_postgres: The user name. - Service azure_sql_db: The user name. For Azure Databases, the format must be user@domain. - Service azure_sql_managed_db: The user name. For Azure Databases, the format must be user@domain. - Service clarity: The user name. For Azure Databases, the format must be user@domain. - Service cockroachdb: The user name. - Service db2i_hva: The user name. - Service db2i_sap_hva: The username. - Service documentdb: The user name. - Service dynamics_365_fo: The user name. The format must be user@domain. - Service ehr: The user name. For Azure Databases, the format must be user@domain. - Service elastic_cloud: The user name. - Service es_self_hosted: The user name. - Service ftp: FTP user. - Service google_cloud_mysql: The user name. - Service google_cloud_postgresql: The user name. - Service google_cloud_sqlserver: The user name. For Azure Databases, the format must be user@domain. - Service hana_sap_hva_b1: The username. - Service hana_sap_hva_ecc: The username. - Service hana_sap_hva_ecc_netweaver: The username. - Service hana_sap_hva_s4: The username. - Service hana_sap_hva_s4_netweaver: The username. - Service heroku_postgres: The user name. - Service jira: The Jira username. - Service magento_mysql: The user name. - Service magento_mysql_rds: The user name. - Service maria: The user name. - Service maria_azure: The user name. - Service maria_rds: The user name. - Service marin: The Marin username. - Service mongo: The user name. - Service mongo_sharded: The user name. - Service mysql: The user name. - Service mysql_azure: The user name. - Service mysql_rds: The user name. - Service opendistro: The user name. - Service opensearch: The user name. - Service oracle: The user name. - Service oracle_ebs: The user name. - Service oracle_hva: The user name. - Service oracle_rac: The user name. - Service oracle_rds: The user name. - Service oracle_sap_hva: The username. - Service oracle_sap_hva_netweaver: The username. - Service outbrain: The username or email of the Outbrain user. - Service postgres: The user name. - Service postgres_rds: The user name. - Service redshift_db: The Redshift username. - Service sap_hana: Your SAP HANA user name. - Service sap_s4hana: Your SAP S/4 user name. - Service sftp: SFTP user. - Service snowflake_db: The Snowflake username. - Service splunk: The Splunk username. - Service sql_server: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_hva: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_rds: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_sap_ecc_hva: The user name. For Azure Databases, the format must be user@domain.
userId string: Field usage depends on service value: - Service coassemble: Your Coassemble user ID. - Service gmail: Your Gmail user ID. - Service hibob: Your HiBob Service User Token. - Service marketo: Marketo SOAP API User Id. - Service okendo: Your Okendo user ID. - Service playvox: Your Playvox User ID. - Service sage_intacct: User ID - Service vimeo: Your Vimeo user ID.
userKey string
userName string: Field usage depends on service value: - Service workday: Workday username.
userProfiles string[]: Field usage depends on service value: - Service double_click_campaign_manager: IDs of specific User Profiles to sync. Must be populated if sync_mode is set to SpecificAccounts.
userToken string: Field usage depends on service value: - Service hibob: Your HiBob Service User ID. - Service konnect_insights: Your Konnect Insights User Token. - Service sonarqube: Your Sonarqube user token.
username string: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS username. - Service adobe_commerce: Your Adobe Commerce username. - Service akeneo: Your Akeneo username. - Service anaplan: Your Anaplan user ID. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Username. - Service aveva_pi: Username for the user to authenticate as with the AF Server - Service ceridian_dayforce: Your Ceridian Dayforce Username. - Service churnzero: Your ChurnZero username. - Service cin7: Your Cin7 API Username. - Service collibra: Your collibra username. - Service compliance_checkpoint: Your Compliance Checkpoint account username. - Service concur: The SAP Concur username. - Service confluence: Your Confluence username. - Service contrast_security: Your Contrast Security API Username. - Service dcl_logistics: Your DCL Logistics username. - Service deposco: Your Deposco username. - Service github: Login of your GitHub profile. - Service gladly: Your Gladly Username. - Service globalmeet: Your GlobalMeet Username. - Service gorgias: Your Gorgias username. - Service green_power_monitor: Your GreenPowerMonitor username. - Service guru: Your Guru username. - Service hilti_ontrack: Your Hilti On!Track username. - Service impact: Your Impact Account SID - Service integral_ad_science: Your integral_ad_science username. - Service itunes_connect: Your Apple ID - Service jamf: Your Jamf username. - Service khoros_care: Your Khoros Care username. - Service kissmetrics: Your Kissmetrics API Username. - Service klarna: Your Klarna Username. - Service learnupon: Your Learnupon username. - Service lessonly: Your Lessonly username. - Service mailgun: Your Mailgun API username. - Service myosh: Your myosh username. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence username. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud username. - Service partnerize: Your Partnerize account's username. - Service pingdom: Your Pingdom Username. - Service podio: Your Podio account username. - Service qmatic_data_connect: Your Qmatic Data Connect username. - Service quorum: Your Quorum username . - Service revx: Your RevX Username. - Service rtb_house: Your RTB House username. - Service sap_business_by_design: The SAP Business ByDesign username. - Service scorm: Your Scorm App ID. - Service servicenow: Your ServiceNow User ID (username). - Service shiphero: Your ShipHero username. - Service shipstation: Your ShipStation username. - Service shopware: Your Shopware username. - Service splash: Your Splash username. - Service starrez: Your StarRez API username - Service stickyio: Your sticky.io username . - Service stylight: Your Stylight Username. - Service sugarcrm: Your SugarCRM username. - Service teamwork: Your Teamwork username. - Service testrail: Your TestRail username. - Service ukg_pro: Your UKG Pro username. - Service unicommerce: Your uniware login username. - Service upland: Your Upland Software Username. - Service veevavault: Your Veeva Vault username. - Service when_i_work: Your When I Work username. - Service wherefour: Your Wherefour username. - Service workday_financial_management: Workday username. - Service workday_hcm: Username of your Workday Integration System User account - Service xandr: Your Xandr username. - Service younium: Your Younium username.
version string: Field usage depends on service value: - Service criteo_retail_media: Your Criteo Retail Media version.
viewAttributionWindow string: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on views. Possible view_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'view' action. - Service snapchat_ads: The time period to attribute conversions based on views. Default value: DAY_1
viewId string: Field usage depends on service value: - Service pigment: Your Pigment view ID.
viewThroughAttributionWindowSize string: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on views. Default value: DAY_7
webServiceApiKey string: Field usage depends on service value: - Service adyen: Your Adyen Web Service API key.
webhookEndpoint string: Field usage depends on service value: - Service appsflyer: Webhook Url
webhookKey string: Field usage depends on service value: - Service xero: Webhook Key
webhookUrl string: Field usage depends on service value: - Service branch: Webhook URL - Service pipedrive: The registered URL for webhooks in your Pipedrive dashboard. - Service segment: Webhook URL. - Service xero: (ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO.
wordPressSiteIdOrWoocommerceDomainName string: Field usage depends on service value: - Service woocommerce: The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance.
workplaceId string: Field usage depends on service value: - Service moloco: Your Moloco workplace ID.
workspace string: Field usage depends on service value: - Service mode: Your Mode Workspace.
workspaceName string: Field usage depends on service value: - Service bigquery_db: Workspace Dataset Name - Service snowflake_db: The name of the database where the temporary tables will be created.
workspaceSameAsSource boolean: Field usage depends on service value: - Service bigquery_db: Use the source dataset as the workspace dataset
workspaceSchema string: Field usage depends on service value: - Service snowflake_db: The name of the schema that belongs to the workspace database where the temporary tables will be created.
wsCertificate string: Field usage depends on service value: - Service adp_workforce_now: Web Services Certificate.
xApiKey string: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X API key.
xKey string: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research key.
xMasterKey string: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research master key.
xUserEmail string: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Email.
xUserToken string: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Token.

abs_connection_method str: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection method
abs_connection_string str: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection string. - Service braze: Connection String
abs_container_address str: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container address
abs_container_name str: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container name. - Service braze: Container Name
abs_host_ip str: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage host IP
abs_host_user str: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage username
abs_prefix str: Field usage depends on service value: - Service braze: Prefix
abs_public_key str: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage public key
academy_id str: Field usage depends on service value: - Service workramp: Your WorkRamp academy ID.
access_id str: Field usage depends on service value: - Service planful: Your Planful access ID.
access_key str: Field usage depends on service value: - Service gainsight_customer_success: The access key for API authentication. - Service gongio: Your Gongio Access key. - Service line_ads: Your LINE Ads access key. - Service planful: Your Planful access key. - Service retailnext: Your RetailNext access key.
access_key_id str: Field usage depends on service value: - Service appsflyer: Your AWS access key ID. - Service aws_cost_report: Access Key ID - Service checkout: Your Checkout.com access key ID. - Service cloudtalk: Your CloudTalk Access Key ID. - Service nice: Your NICE access key ID. - Service s3: Access Key ID - Service wasabi_cloud_storage: Access Key ID
access_key_secret str: Field usage depends on service value: - Service aws_cost_report: Access Key Secret - Service checkout: Your Checkout.com access key secret. - Service cloudtalk: Your CloudTalk Access Key Secret. - Service gongio: Your Gongio Access Key Secret. - Service nice: Your NICE access key secret. - Service s3: Access Key Secret - Service wasabi_cloud_storage: Access Key Secret
access_token str: Field usage depends on service value: - Service 7shifts: Your 7shifts access token. - Service attio: Your Attio bearer token - Service big_commerce: API access token of your store. - Service bitly: Your Bitly access token. - Service calabrio: Your Calabrio access token. - Service coupa: Your Coupa access token fetched using client_id and client_secret - Service deputy: Your Deputy API access token. - Service getfeedback: Your GetFeedback Access token. - Service gocardless: Your GoCardless API token. - Service ironclad: Your Ironclad access token. - Service khoros_marketing: Your Khoros Marketing access token. - Service kustomer: Your Kustomer API key. - Service lattice: Your Lattice API access token. - Service launchdarkly: Your LaunchDarkly access token. - Service leap_crm: Your Leap CRM access token. - Service nylas: Your Nylas access_token. - Service planhat: Your Planhat access token. - Service rollbar: Your Rollbar Access Token. - Service samsara: Your Samsara API token. - Service slab: Your Slab API key. - Service stripe: The Stripe API Restricted Key - Service stripe_test: The Stripe API Restricted Key - Service talkwalker: Your Talkwalker access token. - Service workable: Your Workable Access Token. - Service workramp: Your WorkRamp access token.
access_type str: Field usage depends on service value: - Service share_point: Access Type
account str: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Account ID. - Service ordway: Your Ordway account type.
account_access_token str: Field usage depends on service value: - Service rollbar: Your Rollbar account access token.
account_id str: Field usage depends on service value: - Service appcues: Your Appcues Account ID. - Service brightcove: Your Brightcove account ID. - Service cin7core: Your Cin7 Core account ID. - Service dear: Your Dear Account ID. - Service harvest: Your Harvest Account ID. - Service optimizely: Your Optimizely account ID. - Service rokt: Your Rokt account ID. - Service udemy_business: Your Udemy Business account ID.
account_ids Sequence[str]: Field usage depends on service value: - Service taboola: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
account_key str: Field usage depends on service value: - Service cosmos: The read-only primary or secondary account key for the database account. Required for the ACCOUNT_KEY data access method. - Service simplesat: Your Simplesat account key.
account_name str: Field usage depends on service value: - Service eventsforce: Your Eventsforce account name. - Service freshdesk_contact_center: Your Freshdesk Contact Center account name. - Service happyfox: Your HappyFox account name. - Service maxio_saasoptics: Your Maxio SaaSOptics account name. - Service talkdesk: Your Talkdesk Account Name. - Service udemy_business: Your Udemy Business account name.
account_plan str: Field usage depends on service value: - Service tymeshift: Your Tymeshift account plan.
account_region str: Field usage depends on service value: - Service iterable: If your Iterable account URL starts with https://app.eu.iterable.com then provide EU else US
account_sid str: Field usage depends on service value: - Service fone_dynamics: Your Fone Dynamics account SID.
account_sync_mode str: Field usage depends on service value: - Service itunes_connect: Account Sync Mode
account_token str: Field usage depends on service value: - Service konnect_insights: Your Konnect Insights Account Token.
account_type str: Field usage depends on service value: - Service freightview: Your Freightview Account Type.
accounts Sequence[str]: Field usage depends on service value: - Service bingads: Specific accounts to sync. Must be populated if syncMode is set to SpecificAccounts. - Service facebook: List of accounts of which connector will sync the data. - Service facebook_ad_account: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service facebook_ads: List of accounts of which connector will sync the data. - Service google_ads: The list of Account IDs to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service google_analytics: The list of specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_4: The list of specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_analytics_mcf: Specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_search_ads_360: Specific accounts to sync. Must be populated if accountsSyncMode is set to SPECIFIC_ACCOUNTS. - Service instagram_business: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service itunes_connect: Accounts - Service linkedin_ads: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service spotify_ads: The list of Ad Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service tiktok_ads: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twilio: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
accounts_reddit_ads Sequence[GetConnectorConfigAccountsRedditAd]: Field usage depends on service value: - Service reddit_ads: Accounts
accounts_sync_mode str: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all accounts or specific.
action_breakdowns Sequence[str]: Field usage depends on service value: - Service facebook: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
action_report_time str: Field usage depends on service value: - Service facebook: The report time of action stats. Possible action_report time values.
ad_analytics str: Field usage depends on service value: - Service linkedin_ads: Whether to sync all analytic reports or specific. Default value: AllReports
ad_unit_view str: Field usage depends on service value: - Service double_click_publishers: Ad unit view for the report.
admin_api_key str: Field usage depends on service value: - Service splitio: Your Split admin api key.
adobe_analytics_configurations Sequence[GetConnectorConfigAdobeAnalyticsConfiguration]: Field usage depends on service value: - Service adobe_analytics: 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.
advertisables Sequence[str]: Field usage depends on service value: - Service adroll: Specific advertisables to sync. Must be populated if sync_mode is set to SpecificAdvertisables.
advertisers Sequence[str]: Field usage depends on service value: - Service google_display_and_video_360: The list of advertisers to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service google_search_ads_360: Specific advertisers to sync. Must be populated if advertisersSyncMode is set to SPECIFIC_ADVERTISERS. - Service pinterest_ads: Specific Advertisers to sync. Must be populated if sync_mode is set to SpecificAdvertisers.
advertisers_ids Sequence[str]: Field usage depends on service value: - Service yahoo_gemini: Specific Advertiser IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
advertisers_sync_mode str: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all or specific advertisers.
advertisers_with_seats Sequence[str]: Field usage depends on service value: - Service yahoo_dsp: Specific Advertisers to sync. Must be populated if sync_mode_advertiser is set to SPECIFIC_ADVERTISERS. Pay attention to the format: AdvertiserId:SeatId
agent_config_method str
agent_host str: Field usage depends on service value: - Service db2i_hva: The agent host. - Service db2i_sap_hva: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service oracle_hva: The host of the agent. This is the same as database host, since the agent must be installed in the same machine as source database. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service sql_server_hva: The host address of the machine running the agent. Often the same as the DB host. - Service sql_server_sap_ecc_hva: The host address of the machine running the agent. Often the same as the DB host.
agent_id str: Field usage depends on service value: - Service phoenix_ads: Your Phoenix Ads Agent ID.
agent_ora_home str: Field usage depends on service value: - Service oracle_hva: The home directory of the Oracle database. - Service oracle_sap_hva: The home directory of the Oracle database.
agent_password str: Field usage depends on service value: - Service db2i_hva: The agent password. - Service db2i_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_b1: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_hva: The agent user's password. It should have a minimum length of 10 characters. - Service oracle_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_sap_hva_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service sql_server_hva: The password for the agent user. - Service sql_server_sap_ecc_hva: The password for the agent user.
agent_port float: Field usage depends on service value: - Service db2i_hva: The agent port. - Service db2i_sap_hva: The port number of the agent. - Service hana_sap_hva_b1: The port number of the agent. - Service hana_sap_hva_ecc: The port number of the agent. - Service hana_sap_hva_ecc_netweaver: The port number of the agent. - Service hana_sap_hva_s4: The port number of the agent. - Service hana_sap_hva_s4_netweaver: The port number of the agent. - Service oracle_hva: The port number of the agent. - Service oracle_sap_hva: The port number of the agent. - Service oracle_sap_hva_netweaver: The port number of the agent. - Service sql_server_hva: The port that the agent has open for Fivetran's connection. Default value is 4343. - Service sql_server_sap_ecc_hva: The port that the agent has open for Fivetran's connection. Default value is 4343.
agent_public_cert str: Field usage depends on service value: - Service db2i_hva: The public certificate for the agent. - Service db2i_sap_hva: The agent public certificate. - Service hana_sap_hva_b1: The agent public certificate. - Service hana_sap_hva_ecc: The agent public certificate. - Service hana_sap_hva_ecc_netweaver: The agent public certificate. - Service hana_sap_hva_s4: The agent public certificate. - Service hana_sap_hva_s4_netweaver: The agent public certificate. - Service oracle_hva: The agent public certificate. - Service oracle_sap_hva: The agent public certificate. - Service oracle_sap_hva_netweaver: The agent public certificate. - Service sql_server_hva: The public certificate generated by the agent. - Service sql_server_sap_ecc_hva: The public certificate generated by the agent.
agent_user str: Field usage depends on service value: - Service db2i_hva: The agent user name. - Service db2i_sap_hva: The agent's user. - Service hana_sap_hva_b1: The agent's user. - Service hana_sap_hva_ecc: The agent's user. - Service hana_sap_hva_ecc_netweaver: The agent's user. - Service hana_sap_hva_s4: The agent's user. - Service hana_sap_hva_s4_netweaver: The agent's user. - Service oracle_hva: The agent's user. - Service oracle_sap_hva: The agent's user. - Service oracle_sap_hva_netweaver: The agent's user. - Service sql_server_hva: The agent's username. - Service sql_server_sap_ecc_hva: The agent's username.
aggregation str: Field usage depends on service value: - Service facebook: Options to select aggregation duration. Possible aggregation values.
agreement_grant_token str: Field usage depends on service value: - Service economic: Your E-conomic X-AgreementGrantToken goes here.
always_encrypted bool: Field usage depends on service value: - Service aurora: Require TLS through Tunnel - Service aurora_postgres: Require TLS through Tunnel - Service azure_cosmos_for_mongo: Require TLS - Service azure_postgres: Require TLS through Tunnel - Service azure_sql_db: Require TLS through Tunnel. - Service azure_sql_managed_db: Require TLS. - Service clarity: Require TLS through Tunnel. - Service cockroachdb: Require TLS - Service db2i_hva: Require TLS through Tunnel - Service db2i_sap_hva: Require TLS through Tunnel - Service documentdb: Require TLS encryption. - Service dynamics_365_fo: Require TLS through Tunnel. - Service ehr: Require TLS through Tunnel. - Service elastic_cloud: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service es_self_hosted: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service google_cloud_mysql: Require TLS through Tunnel - Service google_cloud_postgresql: Require TLS through Tunnel - Service google_cloud_sqlserver: Require TLS. - Service heroku_postgres: Require TLS through Tunnel - Service magento_mysql: Require TLS through Tunnel - Service magento_mysql_rds: Require TLS through Tunnel - Service maria: Require TLS through Tunnel - Service maria_azure: Require TLS through Tunnel - Service maria_rds: Require TLS through Tunnel - Service mongo: Require TLS - Service mongo_sharded: Require TLS through Tunnel - Service mysql: Require TLS through Tunnel - Service mysql_azure: Require TLS through Tunnel - Service mysql_rds: Require TLS through Tunnel - Service opendistro: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service opensearch: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service oracle: Require TLS through Tunnel - Service oracle_ebs: Require TLS through Tunnel - Service oracle_hva: Require TLS through Tunnel - Service oracle_rac: Require TLS through Tunnel - Service oracle_rds: Require TLS through Tunnel - Service oracle_sap_hva: Require TLS through Tunnel - Service oracle_sap_hva_netweaver: Require TLS. - Service postgres: Require TLS through Tunnel - Service postgres_rds: Require TLS through Tunnel - Service sql_server: Require TLS. - Service sql_server_hva: Require TLS. - Service sql_server_rds: Require TLS. - Service sql_server_sap_ecc_hva: Require TLS.
api str: Field usage depends on service value: - Service freshsuccess: Set this parameter to api.
api_access_token str: Field usage depends on service value: - Service flywheel_digital: Your Flywheel Digital API access token. - Service shopify: API access token of your custom app. - Service square: The Square API access token of your application.
api_environment str: Field usage depends on service value: - Service afterpay: Your Afterpay API environment.
api_id str: Field usage depends on service value: - Service aircall: Your Aircall API ID.
api_key str: Field usage depends on service value: - Service 15five: Your 15five API key. - Service 360learning: Your 360Learning API Key. - Service 6sense: Your 6sense API Key. - Service acculynx: Your Acculynx API key. - Service activecampaign: Your ActiveCampaign API key. - Service affinity: Your Affinity API key. - Service airtable: API key of the Airtable account. - Service algolia: Your Algolia API key. - Service anvyl: Your Anvyl API key. - Service appcues: Your Appcues API key. - Service ashby: Your Ashby API key. - Service assembled: Your Assembled API key. - Service atlassian_jira_align: Your Jira Align API key. - Service atlassian_ops_genie: Your Opsgenie API key - Service attentive: Your Attentive API key. - Service aumni: Your Aumni API key. - Service avantlink: Your AvantLink API key. - Service ballotready: Your BallotReady API token. - Service bamboohr: Your API Key. - Service bazaarvoice: Your Bazaarvoice API key. - Service betterworks: Your Betterworks API key. - Service bigmarker: Your BigMarker API key. - Service bizzabo: Your Bizzabo API key. - Service brave_ads: Your Brave Ads API key - Service braze: Your Braze API Key. - Service brevo: Your Brevo API key. - Service bubble: Your Bubble API token. - Service buildium: Your Buildium private API key. - Service callrail: Your CallRail API key. - Service campaignmonitor: Your Campaign Monitor API key. - Service canny: Your Canny API key. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 API key. - Service chargebee_product_catalog_2: Your Chargebee API key. - Service chartmogul: Your ChartMogul API key. - Service chorusai: Your Chorus API key. - Service churnkey: Your Churnkey API Key. - Service churnzero: Your ChurnZero API key. - Service cimis: Your Cimis API key. - Service circleci: Your CircleCI API Key. - Service clickup: Your ClickUp API key. - Service clockify: Your Clockify API key. - Service clockodo: Your Clockodo API key. - Service close: Your Close API key. - Service cloudbeds: Your Cloudbeds API key. - Service clubspeed: Your Clubspeed API key. - Service coassemble: Your Coassemble API key. - Service codefresh: Your Codefresh API Key. - Service column: Your Column API key. - Service concord: Your Concord API key. - Service confluent_cloud: API Key - Service contrast_security: Your Contrast Security API Key. - Service copper: Your Copper API key. - Service coupa: Your Coupa API key. - Service datadog: Your Datadog API key. - Service dbt_cloud: Your dbt Cloud service token. - Service dcl_logistics: Your DCL Logistics API key. - Service delighted: API Key for your Delighted account - Service destini: Your Destini API Key. - Service donus: Your Donus API key. - Service doorloop: Your DoorLoop API key. - Service drata: Your Drata API Key. - Service dropbox_sign: Your Dropbox Sign API key. - Service duoplane: Your Duoplane API key. - Service easypost: Your EasyPost API Key. - Service electronic_tenant_solutions: Your Electronic Tenant Solutions API key. - Service eventsforce: Your Eventsforce API secret key. - Service everflow: Your Everflow API key. - Service everhour: Your Everhour API Token. - Service expensein: Your ExpenseIn API key. - Service factorial: Your Factorial API key. - Service firehydrant: Your FireHydrant API key. - Service float: Your Float API key. - Service forj_community: Your Forj Community API key. - Service fourkites: Your FourKites API key. - Service freightview: Your Freightview API key. - Service freshdesk: Your Freshdesk API Key. - Service freshdesk_contact_center: Your Freshdesk Contact Center API key. - Service freshsales: Your Freshsales API key. - Service freshservice: Your Freshservice API Key. - Service freshsuccess: Your Freshsuccess API key. - Service freshteam: Your Freshteam API key. - Service friendbuy: Your Friendbuy API key. - Service fullstory: Your Fullstory API key. - Service gainsight_product_experience: Your Gainsight Product Experience API key. - Service gem: Your Gem API key. - Service gorgias: Your Gorgias API key. - Service greenhouse: Your Greenhouse API key. - Service grepsr: Your Grepsr API Key. - Service grin: Your Grin API key. - Service happyfox: Your HappyFox API key. - Service height: Your Height API key. - Service helpshift: Your Helpshift API Key. - Service incidentio: Your incident.io API key. - Service infobip: Your Infobip API key. - Service insightly: Your Insightly API key. - Service integrate: Your Integrate API key. - Service invoiced: Your Invoiced API key. - Service iterable: Your Iterable API key. - Service ivanti: Your Ivanti API Key. - Service jotform: Your Jotform API key. - Service justcall: Your JustCall API key. - Service katana: Your Katana API key. - Service kevel: Your Kevel API key. - Service keypay: Your KeyPay API key. - Service kisi: Your Kisi API key. - Service klaviyo: Your Klaviyo API key. - Service learnupon: Your Learnupon API key. - Service lemlist: Your Lemlist API key. - Service lever: Your Lever API key. - Service liftoff: Your Liftoff API key. - Service linear: Your Linear API key. - Service linksquares: Your LinkSquares API key. - Service lob: Your Lob API key. - Service loop: Your Loop API key. - Service lucca: Your Lucca API key. - Service luma: Your Luma API key. - Service maileon: Your Maileon API key. - Service mailgun: Your Mailgun API key. - Service mailjet: Your Mailjet API key. - Service malomo: Your Malomo API key. - Service mambu: Your Mambu API key. - Service mandrill: Your Mandrill API key. - Service maxio_chargify: Enter Your API Key. - Service messagebird: Your MessageBird API key. - Service mountain: Your MNTN API key. - Service myosh: Your myosh API key. - Service okendo: Your Okendo API key. - Service ometria: Your Ometria API Key. - Service oncehub: Your OnceHub API key. - Service ordway: Your Ordway API key. - Service ortto: Your Ortto API key. - Service pagerduty: Your PagerDuty API key. - Service pandadoc: Your PandaDoc API key. - Service papershift: Your Papershift API Key - Service partnerize: Your Partnerize user API key. - Service persona: Your Persona API key. - Service picqer: Your Picqer API key. - Service pigment: Your Pigment API key. - Service pinpoint: Your Pinpoint API key. - Service pipe17: The Pipe17 API key. - Service placerai: Your Placer.ai API key. - Service playvox: Your Playvox API Key. - Service posthog: Your PostHog API key. - Service prive: Your Prive API key. - Service prosperstack: Your ProsperStack API key. - Service qualaroo: Your Qualaroo API Key. - Service quorum: Your Quorum API key. - Service rebound_returns: Your ReBound Returns API key. - Service recurly: The Recurly API key. - Service replyio: Your Reply API key. - Service revenuecat: Your RevenueCat API key. - Service reviewsio: Your REVIEWS.io API key. - Service revops: Your RevOps bearer token. - Service ricochet360: Your Ricochet360 API key. - Service ringover: Your Ringover API key. - Service rippling: Your Rippling API key. - Service rocketlane: Your Rocketlane API key. - Service rootly: Your Rootly API key. - Service ruddr: Your Ruddr API key. - Service safebase: Your SafeBase API key. - Service sage_hr: Your Sage HR API key. - Service sailthru: The Sailthru API key. - Service salsify: Your Salsify API Key. - Service security_journey: Your Security Journey API key. - Service sendgrid: The SendGrid API key. - Service sendinblue: Your Sendinblue API key. - Service shortcut: Your Shortcut API token. - Service shortio: Your Short.io API key. - Service simplesat: Your Simplesat API key. - Service sistrix: Your SISTRIX API key. - Service skilljar: Your Skilljar API key. - Service smartwaiver: Your Smartwaiver API key. - Service snyk: Your Snyk API key. - Service sonarqube: Your Sonarqube API key. - Service sparkpost: Your SparkPost API key. - Service squarespace: Your Squarespace API key. - Service stackadapt: Your StackAdapt API key. - Service statuspage: Your Statuspage API Key. - Service stripe: Restricted API key - Service stripe_test: Restricted API key - Service subscript: Your Subscript API key. - Service survicate: Your Survicate API Key. - Service teads: Your Teads API key. - Service teamtailor: Your Teamtailor API key. - Service testrail: Your TestRail API key. - Service ticket_tailor: Your Ticket Tailor API key. - Service transcend: Your Transcend API key. - Service trello: Your TRELLO api key. - Service triple_whale: Your Triple Whale API key. - Service uppromote: Your UpPromote API key. - Service veeqo: Your Veeqo API key. - Service venminder: Your Venminder API key. - Service visit_by_ges: Your Visit by GES API key. - Service vitally: Your Vitally API key. - Service vonage: Your Vonage API Key. - Service vts: Your VTS API key. - Service webconnex: Your Webconnex API key. - Service wicked_reports: Your Wicked Reports API key. - Service workleap_officevibe: Your Workleap Officevibe API key. - Service xsolla: Your Xsolla API key. - Service yougov_sport: Your Yougov Sport API key. - Service zingtree: Your Zingtree API key. - Service zip: Your Zip API key.
api_key_api_secret str: Field usage depends on service value: - Service revel: Your Revel Systems API Key and API Secret.
api_keys Sequence[str]: Field usage depends on service value: - Service mandrill: Comma-separated list of API keys. Required if use_api_keys is set to true.
api_password str: Field usage depends on service value: - Service duoplane: Your Duoplane API password.
api_quota float: Field usage depends on service value: - Service marketo: Allowed number of API requests to Marketo instance per day, the default value is 10000.
api_read_access_token str: Field usage depends on service value: - Service the_movie_database: Your The Movie Database API read access token.
api_requests_per_minute float: Field usage depends on service value: - Service qualtrics: Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
api_secret str: Field usage depends on service value: - Service confluent_cloud: API Secret - Service forj_community: Your Forj Community API secret. - Service friendbuy: Your Friendbuy API secret. - Service justcall: Your JustCall API secret. - Service liftoff: Your Liftoff API secret. - Service mixpanel: Mixpanel API Secret. - Service qualaroo: Your Qualaroo API Secret. - Service sailthru: The Sailthru API secret. - Service shareasale: Your ShareASale API secret. - Service vonage: Your Vonage API Secret.
api_secret_key str: Field usage depends on service value: - Service alchemer: Your Alchemer API Secret key.
api_server str: Field usage depends on service value: - Service sigma_computing_source: Your Sigma Computing api server.
api_token str: Field usage depends on service value: - Service aha: Your Aha! API key. - Service aircall: Your Aircall API Token. - Service appsflyer: API Token for AppsFlyer's PULL API. - Service awin: Your Awin API Token. - Service backbone_plm: Your Backbone PLM API token. - Service brex: Your Brex API token - Service buildkite: Your Buildkite API token. - Service buzzsprout: Your Buzzsprout API token. - Service centra: Your Centra API token. - Service chameleon: Your Chameleon API token. - Service clari: Your Clari API token. - Service cloudflare_analytics: Your Cloudflare Analytics API token. - Service confluence: The Confluence API token. - Service dixa: Your Dixa API token. - Service drip: Your Drip API Token. - Service factbird: Your Factbird API token. - Service fone_dynamics: Your Fone Dynamics API token. - Service fountain: Your Fountain API token. - Service g2: Your G2 API token. - Service gladly: Your Gladly API Token. - Service hibob: Your Hibob API token. - Service kandji: Your Kandji API token. - Service livechat: Your Livechat Access token. - Service livechat_partner: Your Livechat Partner API Token. - Service maxio_saasoptics: Your Maxio SaaSOptics API token. - Service megaphone: Your Megaphone API token. - Service missive: Your Missive API token. - Service mixmax: Mixmax API token. - Service okta: Your Okta API token. - Service ordway: Your Ordway API token. - Service packiyo: Your Packiyo API token. - Service pipedrive: (Optional)Your Pipedrive personal API token - Service pivotal_tracker: Pivotal Tracker API token. - Service postmark: Your Postmark account API token. - Service productive: Your Productive API token. - Service qualtrics: API token of the Qualtrics account. - Service rakutenadvertising: Your Rakuten Advertising API token. - Service recharge: The Recharge API token. - Service referralhero: Your Referralhero API token. - Service resource_management_by_smartsheet: Your Resource Management by Smartsheet API token. - Service retently: Your Retently API token. - Service reviewsai: Your REVIEWS.ai API token. - Service rundeck: Your Rundeck API token. - Service safetyculture: Your SafetyCulture API token. - Service sensor_tower: Your Sensor Tower API token. - Service sentry: Your Sentry auth token. - Service simplecast: Your Simplecast API token. - Service snyk: Your Snyk API token. - Service textus: Your TextUs API token. - Service toggl_track: Your Toggl Track API token - Service trello: Your TRELLO api token. - Service trisolute: Your Trisolute API token. - Service vwo: Your VWO API token. - Service web_scraper: Your Web Scraper API token. - Service zendesk: Zendesk API tokens are auto-generated passwords in the Support admin interface. - Service zendesk_sunshine: Zendesk API tokens are auto-generated passwords in the Support admin interface.
api_type str
api_url str: Field usage depends on service value: - Service braze: Your Braze API URL.
api_url_region str: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP API URL region.
api_usage str: Field usage depends on service value: - Service zendesk: Maximum Zendesk Api Usage allowed
api_user_identifier str: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user identifier.
api_user_secret str: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user secret.
api_utilization_percentage str: Field usage depends on service value: - Service kustomer: Api Utilization Percentage
api_version str: Field usage depends on service value: - Service pardot: API Version
app_id str: Field usage depends on service value: - Service churnkey: Your Churnkey APP ID. - Service open_exchange_rates: Your Open Exchange Rates App Id. - Service rokt: Your Rokt app ID.
app_ids Sequence[str]: Field usage depends on service value: - Service pendo: Specific App IDs to sync. Must be populated if sync_mode is set to SpecificAppIds.
app_ids_appsflyers Sequence[GetConnectorConfigAppIdsAppsflyer]: Field usage depends on service value: - Service appsflyer: * App ID(s)
app_key str: Field usage depends on service value: - Service loopio: Your Loopio App Key. - Service servicetitan: Your ServiceTitan app key. - Service yotpo: Your Yotpo App Key
app_reference str: Field usage depends on service value: - Service brightpearl: Your Brightpearl app reference.
app_secret str: Field usage depends on service value: - Service rokt: Your Rokt app secret.
app_secret_token str
app_specific_password str: Field usage depends on service value: - Service itunes_connect: Your app-specific password
app_sync_mode str: Field usage depends on service value: - Service itunes_connect: Whether to sync all apps or specific apps.
append_file_option str: Field usage depends on service value: - Service aws_cost_report: If you know that the source completely overwrites the same file with new data, you can append the changes instead of upserting based on filename and line number. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
application_id str: Field usage depends on service value: - Service algolia: Your Algolia application ID. - Service xactly: Your Xactly Application ID.
application_key str: Field usage depends on service value: - Service cin7core: Your Cin7 Core application key. - Service datadog: Your Datadog application key. - Service dear: Your Dear Application key. - Service partnerize: Your Partnerize user application key.
apps Sequence[str]: Field usage depends on service value: - Service itunes_connect: Specific apps to sync. Must be populated if app_sync_mode is set to SpecificApps.
archive_log_format str: Field usage depends on service value: - Service sql_server_hva: Format for archive log file names - Service sql_server_sap_ecc_hva: Format for archive log file names
archive_log_path str: Field usage depends on service value: - Service sql_server_hva: Directory where archive logs are located - Service sql_server_sap_ecc_hva: Directory where archive logs are located
archive_pattern str: Field usage depends on service value: - Service aws_cost_report: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service azure_blob_storage: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service box: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service dropbox: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service email: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service ftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service gcs: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service google_drive: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service kinesis: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service s3: Files inside compressed archives with filenames matching this regular expression will be synced. - Service sftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service share_point: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service wasabi_cloud_storage: Files inside compressed archives with filenames matching this regular expression will be synced.
are_soap_credentials_provided bool: Field usage depends on service value: - Service marketo: Marketo SOAP credentials provided.
asb_ip str: Field usage depends on service value: - Service azure_service_bus: The IP address (or) the URL of ASB namespace
asm_option bool: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using ASM on a non-RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you are using ASM on a non-RAC instance.
asm_oracle_home str: Field usage depends on service value: - Service oracle_hva: ASM Oracle Home path. - Service oracle_sap_hva: The Oracle ASM home directory.
asm_password str: Field usage depends on service value: - Service oracle_hva: ASM password. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user's password. Mandatory if use_oracle_rac or asm_option is set to true.
asm_tns str: Field usage depends on service value: - Service oracle_hva: ASM TNS. - Service oracle_sap_hva: ASM TNS.
asm_user str: Field usage depends on service value: - Service oracle_hva: ASM user. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user. Mandatory if use_oracle_rac or asm_option is set to true.
attribution_window str: Field usage depends on service value: - Service amazon_ads: Time period used to attribute conversions based on clicks.
attribution_window_size str: Field usage depends on service value: - Service tiktok_ads: Rollback sync duration to capture conversions. Set this to your configured attribution window in TikTok Ads. The default value is 7 days.
audience str: Field usage depends on service value: - Service auth0: Your Auth0 API audience.
auth str: Field usage depends on service value: - Service databricks_db: Token-based authentication type - Service redshift_db: Password-based authentication type - Service snowflake_db: Password-based or key-based authentication type
auth_code str: Field usage depends on service value: - Service happyfox: Your HappyFox auth code.
auth_environment str: Field usage depends on service value: - Service younium: Your Younium auth environment.
auth_method str: Field usage depends on service value: - Service aurora_postgres: Database authentication method - Service azure_postgres: Database authentication method - Service azure_sql_db: Authentication Method. - Service azure_sql_managed_db: Authentication Method. - Service google_cloud_postgresql: Database authentication method - Service heroku_postgres: Database authentication method - Service postgres: Database authentication method - Service postgres_rds: Database authentication method - Service sql_server_hva: Authentication Method - Service sql_server_sap_ecc_hva: Authentication Method - Service webhooks: The authentication mechanism you want to use
auth_mode str: Field usage depends on service value: - Service anaplan: The Anaplan authentication method. - Service concur: The Authentication Mode used by SAP Concur. It can be PasswordGrant or CompanyLevel auth mode - Service github: Authorization type.
auth_token str: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback auth token.
auth_type str: Field usage depends on service value: - Service airtable: Type of authentication being used by connector - Service aws_cost_report: Access approach - Service azure_service_bus: The authentication mode to access the topic - Service dynamics_365: Authentication mechanism. Either one of OAUTH2, or SERVICE_PRINCIPAL. Default value OAUTH2 - Service gcs: Authorization type. Required for storage bucket authentication. - Service google_sheets: The OAuth value must be specified for this type of authorization. - Service jira: Authorization type. - Service mixpanel: Authentication Method - Service pardot: Authenticate using OAuth or HTTP Basic - Service qualtrics: Type of authentication being used by connector - Service s3: Access approach - Service wasabi_cloud_storage: The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: ACCESS_KEY.
auth_url_region str: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP auth grant URL region.
authentication_method str: Field usage depends on service value: - Service adobe_analytics: Authentication Method - Service elastic_cloud: The authentication method used to connect to your cluster. - Service es_self_hosted: The authentication method used to connect to your cluster. - Service opendistro: The authentication method used to connect to your cluster. - Service opensearch: The authentication method used to connect to your cluster. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud authentication method. - Service salesforce: (Optional) Authentication type (default value = STANDARD) - Service salesforce_sandbox: (Optional) Authentication type (default value = STANDARD)
authorization_method str
aws_region_code str: Field usage depends on service value: - Service dynamodb: The AWS region code for the DynamoDB instance, e.g. us-east-1.
backint_configuration_path str
backint_executable_path str
backward_sync_limit str: Field usage depends on service value: - Service zendesk: Limit of the Historical Sync Time for selected tables
base_currency str: Field usage depends on service value: - Service open_exchange_rates: Your Open Exchange Rates Base Currency.
base_domain str: Field usage depends on service value: - Service freshteam: Your company's Freshteam base domain name (usually company.freshteam.com).
base_id str: Field usage depends on service value: - Service airtable: ID of base in Airtable
base_url str: Field usage depends on service value: - Service aha: Your Aha! subdomain. - Service akeneo: Your Akeneo base URL. - Service billing_platform: Your BillingPlatform subdomain. - Service boostr: Your Boostr base URL. - Service brex: Your Brex Base URL - Service centra: Your Centra base URL. - Service cornerstone: Your Cornerstone base URL. - Service culture_amp: Your Culture Amp base URL. - Service datadog: Your Datadog base url. - Service factbird: Your Factbird base url. - Service fillout: Your Fillout Base URL. - Service financial_force: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service freshsales: Your Freshsales product. - Service gongio: Your Gong API Base URL. - Service ironclad: Your Ironclad base url. - Service jotform: Your Jotform base URL. - Service mailgun: Your Mailgun base URL. - Service nice: Your NICE base URL. - Service ortto: Your Ortto base URL. Possible values: api, api.au, api.eu. - Service prisma_cloud: Your Prisma Cloud admin console URL. - Service salesforce: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service salesforce_sandbox: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service stickyio: Your sticky.io base URL . - Service veevavault: Your Veeva Vault base URL. - Service vitally: Your Vitally base URL.
bearer_token str: Field usage depends on service value: - Service ada: Your Ada API Access Token. - Service crowddev: Your crowd.dev Auth Token. - Service customerio: Your Customer.io App API Key. - Service freshchat: Your Freshchat API Token. - Service hopin: Your Hopin API key. - Service orbit: Your Orbit API Token. - Service productboard: Your Productboard API key. - Service smarthr: Your SmartHR access token. - Service sprout: Your Sprout Social API Access Token. - Service zenefits: Your Zenefits bearer token.
blob_sas_url str: Field usage depends on service value: - Service webhooks: The blob SAS URL of your Azure container. Required if bucket_service is set to AZURE.
blockchain str: Field usage depends on service value: - Service rarible: Your Rarible Blockchain.
brand_id str: Field usage depends on service value: - Service oracle_moat_analytics: Your Oracle Moat Analytics Brand ID.
breakdowns Sequence[str]: Field usage depends on service value: - Service facebook: List of breakdowns which connector will sync. Possible breakdowns values.
bucket str: Field usage depends on service value: - Service appsflyer: Customer S3 Bucket - Service aws_cloudtrail: The AWS bucket name which is configured for AWS CloudTrail. - Service aws_cost_report: The S3 bucket name with the AWS Cost and Usage Report - Service aws_inventory: The AWS bucket name that is configured for AWS Config. - Service aws_lambda: S3 Bucket - Service cloudfront: The bucket name for CloudFront. - Service gcs: The name of the GCS bucket. - Service google_play: The Google Cloud Storage source bucket. - Service heap: The S3 bucket name. - Service kinesis: The name of the Kinesis bucket. - Service s3: The S3 bucket name. Required for connector creation. - Service segment: The name of the Segment bucket. Must be populated if sync_type is set to S3. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket name. Required for connector creation.
bucket_name str: Field usage depends on service value: - Service adjust: Your AWS S3 or GCS bucket. - Service google_analytics_360: The name of the bucket. - Service google_analytics_4_export: The name of the bucket.
bucket_service str: Field usage depends on service value: - Service webhooks: Whether to store the events in Fivetran's container service or your S3 bucket. Default value: Fivetran.
business_accounts Sequence[str]: Field usage depends on service value: - Service reddit_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
business_id str: Field usage depends on service value: - Service birdeye: Your Birdeye Business ID.
business_unit str: Field usage depends on service value: - Service deposco: Your Deposco business unit.
business_unit_id str: Field usage depends on service value: - Service pardot: Business Unit Id
catalog str: Field usage depends on service value: - Service databricks_db: catalog to sync
certificate str: Field usage depends on service value: - Service anaplan: The contents of your PEM certificate file. Must be populated if auth_mode is set to Certificate. - Service qualtrics: Your Client Certificate - Service salesforce: Provide content of the .pem certificate (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .pem certificate (only when authentication_method = ADVANCED).
click_attribution_window str: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on clicks. Possible click_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'click' action.
client str
client_cert str: Field usage depends on service value: - Service apache_kafka: Kafka client certificate. - Service heroku_kafka: Heroku Kafka client certificate. Required for TLS security protocol.
client_cert_key str: Field usage depends on service value: - Service apache_kafka: Kafka client certificate key. - Service heroku_kafka: Heroku Kafka client certificate key. Required for TLS security protocol.
client_host str: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Host.
client_id str: Field usage depends on service value: - Service acumatica: Your Acumatica client ID. - Service adobe_analytics: Client ID from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client ID. - Service adp_workforce_now: Your ADP Client ID. - Service akamai: Your Akamai client ID. - Service akeneo: Your Akeneo client ID. - Service auth0: Your Auth0 client ID. - Service autodesk_bim_360: Your Autodesk BIM 360 client ID. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Id - Service billing_platform: Your BillingPlatform client ID. - Service bing_webmaster_tools: Your Bing Webmaster Tools client ID. - Service brightcove: Your Brightcove client ID. - Service brightpearl: Your Brightpearl client ID. - Service buildium: Your Buildium API client ID. - Service canvas_by_instructure: Your Canvas by Instructure client ID. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure client ID. - Service castor_edc: Your Castor EDC client Id. - Service clazar: Your Clazar client ID. - Service cloudbeds: Your Cloudbeds client ID. - Service commercetools: Your commercetools client ID. - Service concur: The SAP Concur Client ID. - Service constant_contact: Your Constant Contact client ID. - Service cornerstone: Your Cornerstone client ID. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo Client ID. - Service criteo_retail_media: Your Criteo Retail Media client ID. - Service culture_amp: Your Culture Amp client ID. - Service cvent: Your Cvent client ID. - Service d2l_brightspace: Your D2L Brightspace client ID. - Service dialpad: Your Dialpad client ID. - Service ebay: Your eBay app ID. - Service exact_online: Your Exact Online client ID. - Service fillout: Your Fillout client ID. - Service flexport: The Flexport API Key. - Service formstack: Your Formstack client ID. - Service genesys: Your Genesys client ID. - Service hana_sap_hva_ecc_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hana_sap_hva_s4_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hilti_ontrack: Your Hilti On!Track client ID. - Service ilevel: Your iLevel Client ID. - Service instructure: Your Instructure client ID. - Service integral_ad_science: Your integral_ad_science client id. - Service ironclad: Your Ironclad client ID. - Service jama_software: Your Jama Software client ID. - Service jibble: Your Jibble client ID. - Service khoros_communities: Your Khoros Communities client ID. - Service looker_source: Your Looker Client ID. - Service marketo: Marketo REST API Client Id. - Service medallia: Medallia Client ID - Service microsoft_entra_id: Your Microsoft Entra ID Client ID. - Service microsoft_power_bi: Your Microsoft Power BI client ID. - Service microsoft_teams: Your Microsoft Teams Client ID. - Service navan: Your Navan client ID. - Service nice: Your NICE client ID. - Service on24: Your ON24 client ID. - Service oracle_sap_hva_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service paychex: Your Paychex client ID. - Service paypal: Client ID of your PayPal client application. - Service paypal_sandbox: Client ID of your PayPal client application. - Service personio: Your Personio Client ID. - Service piwik_pro: Your Piwik PRO client ID. - Service podio: Your Podio client ID. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client ID. - Service prisma_cloud: Your Prisma Cloud access key ID. - Service procore: Your Procore client ID. - Service quora_ads: Your Quora Ads client ID. - Service reltio: Your Reltio client ID. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client ID. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client ID. - Service salesloft: Client ID of your Salesloft client application. - Service sana: Your Sana client ID. - Service sap_success_factors: Your SAP SuccessFactors Client ID. - Service servicenow: ServiceNow Client ID. - Service servicetitan: Your ServiceTitan client ID. - Service sharetribe: Your Sharetribe client ID. - Service shipnetwork: Your ShipNetwork client ID. - Service sigma_computing_source: Your Sigma Computing client ID. - Service skillstx: Your SkillsTX client ID. - Service skimlinks: Your Skimlinks client ID. - Service smartrecruiters: Your SmartRecruiters client ID. - Service splash: Your Splash client ID. - Service square: The Application ID of your organization. - Service standard_metrics: Your Standard Metrics Client ID. - Service sugarcrm: Your SugarCRM client ID. - Service swoogo: Your Swoogo client Id. - Service taboola: The Taboola client ID. - Service talkdesk: The Client ID of your OAuth Client - Service tive: Your Tive client ID. - Service toast: Your Toast client ID. - Service trelica: Your Trelica client ID. - Service tremendous: Your Tremendous client ID. - Service tymeshift: Your Tymeshift email. - Service udemy_business: Your Udemy Business client ID. - Service vimeo: Your Vimeo client ID. - Service visma: Your Visma client ID. - Service vonage_contact_center: Your Vonage Contact Center client ID. - Service walmart_marketplace: Your Walmart Marketplace client ID. - Service xero: your clientId - Service xray: Your Xray Client ID. - Service yougov_sport: Your Yougov Sport client ID. - Service zendesk_chat: Your Zendesk client ID. - Service zoho_books: Your Zoho Books Client ID. - Service zoho_campaigns: Your Zoho Campaigns Client ID. - Service zoho_desk: Your Zoho Desk Client Id. - Service zoho_inventory: Your Zoho Inventory client ID. - Service zuora: Zuora Client ID. - Service zuora_sandbox: Zuora Client ID.
client_key str: Field usage depends on service value: - Service appfigures: Your Appfigures Client Key. - Service thinkific: Your Thinkific client key. - Service yougov_sport: Your Yougov Sport client key.
client_name str: Field usage depends on service value: - Service destini: Your Destini Client Name. - Service medallia: Medallia company name
client_namespace str: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Namespace.
client_private_key str: Field usage depends on service value: - Service aurora_postgres: Client Private Key in .pem format. - Service azure_postgres: Client Private Key in .pem format. - Service google_cloud_postgresql: Client Private Key in .pem format. - Service heroku_postgres: Client Private Key in .pem format. - Service postgres: Client Private Key in .pem format. - Service postgres_rds: Client Private Key in .pem format.
client_public_certificate str: Field usage depends on service value: - Service aurora_postgres: Client Certificate in .pem format. - Service azure_postgres: Client Certificate in .pem format. - Service google_cloud_postgresql: Client Certificate in .pem format. - Service heroku_postgres: Client Certificate in .pem format. - Service postgres: Client Certificate in .pem format. - Service postgres_rds: Client Certificate in .pem format.
client_secret str: Field usage depends on service value: - Service acumatica: Your Acumatica client secret. - Service adobe_analytics: Client Secret from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client secret. - Service adp_workforce_now: Your ADP Client Secret. - Service akamai: Your Akamai client secret. - Service akeneo: Your Akeneo client secret. - Service auth0: Your Auth0 client secret. - Service autodesk_bim_360: Your Autodesk BIM 360 client secret. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Secret - Service billing_platform: Your BillingPlatform client secret. - Service bing_webmaster_tools: Your Bing Webmaster Tools client secret. - Service brightcove: Your Brightcove client secret. - Service brightpearl: Your Brightpearl client secret. - Service canvas_by_instructure: Your Canvas by Instructure client secret. - Service castor_edc: Your Castor EDC Client Secret. - Service clazar: Your Clazar client secret. - Service cloudbeds: Your Cloudbeds client secret. - Service commercetools: Your commercetools client secret. - Service concur: The SAP Concur Client secret. - Service constant_contact: Your Constant Contact client secret. - Service cornerstone: Your Cornerstone client secret. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo client secret key. - Service criteo_retail_media: Your Criteo Retail Media client secret. - Service culture_amp: Your Culture Amp client secret. - Service cvent: Your Cvent client secret. - Service d2l_brightspace: Your D2L Brightspace client secret. - Service dialpad: Your Dialpad client secret. - Service ebay: Your eBay cert ID. - Service exact_online: Your Exact Online client secret. - Service fillout: Your Fillout client secret - Service flexport: The Flexport API Secret. - Service formstack: Your Formstack client secret. - Service genesys: Your Genesys client secret. - Service hilti_ontrack: Your Hilti On!Track client secret. - Service ilevel: Your iLevel Client Secret. - Service instructure: Your Instructure client secret. - Service integral_ad_science: Your integral_ad_science client secret. - Service ironclad: Your Ironclad client secret. - Service jama_software: Your Jama Software client secret. - Service jibble: Your Jibble client secret. - Service looker_source: Your Looker Client Secret. - Service marketo: Marketo REST API Client Secret. - Service medallia: Medallia Client Secret key - Service microsoft_entra_id: Your Microsoft Entra ID Client Secret. - Service microsoft_power_bi: Your Microsoft Power BI client secret. - Service microsoft_teams: Your Microsoft Teams Client Secret. - Service navan: Your Navan client secret. - Service nice: Your NICE client secret. - Service paychex: Your Paychex client secret. - Service personio: Your Personio secret. - Service piwik_pro: Your Piwik PRO client secret. - Service podio: Your Podio client secret. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client Secret. - Service prisma_cloud: Your Prisma Cloud secret access Key. - Service procore: Your Procore client secret. - Service quora_ads: Your Quora Ads client secret. - Service reltio: Your Reltio client secret. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client secret. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client secret. - Service salesloft: Client Secret of your Salesloft client application. - Service sana: Your Sana client secret. - Service sap_success_factors: Your SAP SuccessFactors Client Secret that you generated through SAML Assertion. - Service servicenow: ServiceNow Client Secret. - Service servicetitan: Your ServiceTitan secret key. - Service sharetribe: Your Sharetribe client secret. - Service sigma_computing_source: Your Sigma Computing client secret. - Service skillstx: Your SkillsTX client secret. - Service skimlinks: Your Skimlinks client secret. - Service smartrecruiters: Your SmartRecruiters client secret. - Service splash: Your Splash client secret. - Service square: The Application Secret of your organization. - Service standard_metrics: Your Standard Metrics Client secret. - Service sugarcrm: Your SugarCRM client secret. - Service swoogo: Your Swoogo Client Secret. - Service taboola: The Taboola client secret. - Service talkdesk: The Client Secret of your OAuth Client - Service thinkific: Your Thinkific client secret. - Service tive: Your Tive client secret. - Service toast: Your Toast client secret. - Service trelica: Your Trelica client secret. - Service tremendous: Your Tremendous client secret. - Service tymeshift: Your Tymeshift password. - Service udemy_business: Your Udemy Business client secret. - Service vimeo: Your Vimeo client secret. - Service visma: Your Visma client secret. - Service vonage_contact_center: Your Vonage Contact Center client secret. - Service walmart_marketplace: Your Walmart Marketplace client secret. - Service xero: your clientSecret - Service xray: Your Xray Client Secret. - Service zendesk_chat: Your Zendesk client secret. - Service zoho_books: Your Zoho Books Client Secret. - Service zoho_campaigns: Your Zoho Campaigns Client Secret. - Service zoho_desk: Your Zoho Desk Client secret. - Service zoho_inventory: Your Zoho Inventory client secret. - Service zuora: Zuora Client Secret. - Service zuora_sandbox: Zuora Client Secret.
cloud_storage_type str: Field usage depends on service value: - Service braze: Cloud storage type Braze Current is connected to.
collection_address str: Field usage depends on service value: - Service rarible: Your Rarible Collection Address.
columns Sequence[str]: Field usage depends on service value: - Service double_click_publishers: Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.
community_domain str: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community domain.
community_id str: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community ID.
companies Sequence[str]: Field usage depends on service value: - Service business_central: List of companies to sync
company str: Field usage depends on service value: - Service ordway: Your Ordway company name.
company_id str: Field usage depends on service value: - Service 360learning: Your 360Learning Company ID. - Service sage_intacct: Company ID - Service sap_success_factors: Your SAP SuccessFactors Company ID.
company_ids str: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail company IDs.
company_key str: Field usage depends on service value: - Service khoros_care: Your Khoros Care companyKey. - Service upland: Your Upland Software Company Key.
company_name str: Field usage depends on service value: - Service clockodo: Your Clockodo company name.
company_request_token str: Field usage depends on service value: - Service concur: The SAP Concur Company Request Token
company_uuid str: Field usage depends on service value: - Service concur: The SAP Concur Company UUID
compression str: Field usage depends on service value: - Service aws_cost_report: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service azure_blob_storage: The secrets that should be passed to the function at runtime. - Service box: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service dropbox: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service email: The secrets that should be passed to the function at runtime. - Service ftp: The secrets that should be passed to the function at runtime. - Service gcs: The secrets that should be passed to the function at runtime. - Service google_drive: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service kinesis: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service s3: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service sftp: The secrets that should be passed to the function at runtime. - Service share_point: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service wasabi_cloud_storage: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
config_method str: Field usage depends on service value: - Service google_display_and_video_360: The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is CREATE_NEW.
config_repository_url str: Field usage depends on service value: - Service snowplow: Public repository URL containing JSON configuration files.
config_type str: Field usage depends on service value: - Service facebook: Option to select Prebuilt Reports or Custom Reports. Possible config_type values. - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports.
connect_password str: Field usage depends on service value: - Service xactly: Your Xactly Connect password.
connect_username str: Field usage depends on service value: - Service xactly: Your Xactly Connect username.
connecting_user str
connecting_user_email str
connection_method str: Field usage depends on service value: - Service aws_msk: How Fivetran connects to your message brokers in the cluster - Service azure_blob_storage: Connection Method. Possible values: 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. - Service azure_function: Connection Method. Possible values: DIRECT: Fivetran will connect directly to your function, PRIVATE_LINK: Fivetran will connect to your storage container using PrivateLink. - Service azure_service_bus: The connection method - Service sftp: The connection method used to connect to SFTP Server.
connection_name str: Field usage depends on service value: - Service appsflyer: Your Data Locker Connection Name. Default value: `data-locker-hourly/
connection_string str: Field usage depends on service value: - Service azure_blob_storage: The blob storage container connection string. - Service azure_event_hub: Connection string of the Event Hub Namespace you want to sync. - Service azure_service_bus: The connection string used for authentication. Required if the authentication type is ConnectionString - Service microsoft_dynamics_365_fno: The blob storage container's connection string. - Service microsoft_dynamics_365_fo: The blob storage container connection string.
connection_type str: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service aws_cost_report: Connection method. Default value: Directly. - Service aws_lambda: Connection method. Default value: Directly. - Service azure_blob_storage: Connection method. Default value: Directly. - Service azure_cosmos_for_mongo: Possible values:Directly, PrivateLink. Directly is the default value - Service azure_postgres: 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. - Service azure_sql_db: 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. - Service azure_sql_managed_db: 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. - Service bigquery_db: Direct or PrivateLink connection - Service clarity: 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. - Service cockroachdb: Possible values:Directly, 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. - Service db2i_hva: Possible values:SshTunnel. SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service db2i_sap_hva: 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. - Service documentdb: Possible values:SshTunnel, PrivateLink . SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service dynamics_365_fo: 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. - Service ehr: 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. - Service elastic_cloud: Possible values:Directly, 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. - Service email: Connection method. Default value: Directly. - Service es_self_hosted: Possible values:Directly, 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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service heroku_postgres: 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. - Service kinesis: Connection method. Default value: Directly. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mongo: 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. - Service mongo_sharded: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service opendistro: Possible values:Directly, 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. - Service opensearch: Possible values:Directly, 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Directly or Private Link - Service s3: Connection method. Default value: Directly. - Service sap_hana: 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. - Service sap_s4hana: Connection Method - Service snowflake_db: Directly or Private Link - Service sql_server: 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. - Service sql_server_hva: 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. - Service sql_server_rds: 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. - Service sql_server_sap_ecc_hva: 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.
console_url str: Field usage depends on service value: - Service prisma_cloud: Your Prisma Cloud console URL.
consumer_group str: Field usage depends on service value: - Service apache_kafka: Kafka consumer group name. - Service aws_msk: The name of consumer group created for Fivetran. - Service azure_event_hub: Name of consumer group created for Fivetran. - Service confluent_cloud: Confluent Cloud consumer group name. - Service heroku_kafka: Heroku Kafka consumer group name.
consumer_key str: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Key - Service twitter: API Key of your app - Service twitter_ads: The Twitter App consumer key. - Service woocommerce: Your WooCommerce Consumer key.
consumer_name str: Field usage depends on service value: - Service xactly: Your Xactly Connect consumer name.
consumer_secret str: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Secret - Service twitter: API Secret of your app - Service twitter_ads: The Twitter App consumer secret. - Service woocommerce: Your WooCommerce Consumer secret.
container_address str: Field usage depends on service value: - Service azure_blob_storage: IP address of the Azure Storage Container which is accessible from host machine.
container_name str: Field usage depends on service value: - Service azure_blob_storage: The name of the blob container. - Service microsoft_dynamics_365_fno: The name of the blob container. - Service microsoft_dynamics_365_fo: The name of the blob container.
content_owner_id str: Field usage depends on service value: - Service youtube_analytics: Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.
contract_version str: Field usage depends on service value: - Service acumatica: Your Acumatica contract version.
conversation_webhook_url str: Field usage depends on service value: - Service helpscout: Your conversation webhook URL
conversion_dimensions Sequence[str]: Field usage depends on service value: - Service double_click_campaign_manager: Conversion Dimensions.
conversion_report_time str: Field usage depends on service value: - Service pinterest_ads: The date that the user interacted with the ad OR completed a conversion event.
conversion_window_size float: Field usage depends on service value: - Service google_ads: A period of time in days during which a conversion is recorded.
convert_dats_type_to_date bool
csv_definition str: Field usage depends on service value: - Service adjust: CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition).
currency str: Field usage depends on service value: - Service criteo: Currency - Service rokt: Your Rokt currency.
custom_base_url str: Field usage depends on service value: - Service datadog: Your Datadog custom base url. - Service deposco: Your Deposco custom base URL.
custom_event_sync_mode str: Field usage depends on service value: - Service iterable: Custom Events Sync Mode.
custom_events Sequence[str]: Field usage depends on service value: - Service iterable: List of custom events to sync. Should be specified when custom_event_sync_mode is SelectedEvents
custom_field_ids Sequence[str]: Field usage depends on service value: - Service double_click_publishers: The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.
custom_floodlight_variables Sequence[str]: Field usage depends on service value: - Service double_click_campaign_manager: Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.
custom_payloads Sequence[GetConnectorConfigCustomPayload]: Field usage depends on service value: - Service aws_lambda: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service azure_function: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service google_cloud_function: The list of key-value pairs that can be used to specify custom information to the function at runtime.
custom_reports Sequence[GetConnectorConfigCustomReport]: Field usage depends on service value: - Service reddit_ads: The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data. - Service snapchat_ads: Custom reports for Snapchat Ads connector. - Service tiktok_ads: Title of Custom Report
custom_tables Sequence[GetConnectorConfigCustomTable]: Field usage depends on service value: - Service facebook_ads: List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data.
custom_url str: Field usage depends on service value: - Service dbt_cloud: Your dbt Cloud access url. - Service factbird: Your Factbird custom base url. - Service jotform: Your Jotform custom base URL.
customer_api_key str: Field usage depends on service value: - Service ukg_pro: Your UKG Pro Customer API key.
customer_id str: Field usage depends on service value: - Service google_ads: ID of the customer, can be retrieved from your AdWords dashboard.
customer_list_id str: Field usage depends on service value: - Service salesforce_commerce_cloud: The parameter to retrieve customer details.
daily_api_call_limit float
data_access_method str: Field usage depends on service value: - Service cosmos: The source data access method. Supported values:ACCOUNT_KEY- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.RESOURCE_TOKEN- Fine-grained permission model based on native Azure Cosmos DB users and permissions. Learn more in our Azure Cosmos DB Data Access Methods documentation.
data_center str: Field usage depends on service value: - Service brightpearl: Your Brightpearl data center. - Service qualtrics: 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.) - Service zoho_crm: Data Center, depending on the Domain name
data_center_id str: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback data center ID.
data_set_name str: Field usage depends on service value: - Service bigquery_db: Data set name
database str: Field usage depends on service value: - Service aurora: The database name. - Service aurora_postgres: The database name. - Service azure_cosmos_for_mongo: Authentication database for the source. Usually 'admin'. - Service azure_postgres: The database name. - Service azure_sql_db: The database name. - Service azure_sql_managed_db: The database name. - Service clarity: The database name. - Service cockroachdb: The database name. - Service db2i_hva: The database name. - Service db2i_sap_hva: The database name. - Service dynamics_365_fo: The database name. - Service ehr: The database name. - Service google_cloud_mysql: The database name. - Service google_cloud_postgresql: The database name. - Service google_cloud_sqlserver: The database name. - Service hana_sap_hva_b1: The Hana database name. - Service hana_sap_hva_ecc: The Hana database name. - Service hana_sap_hva_ecc_netweaver: The Hana database name. - Service hana_sap_hva_s4: The Hana database name. - Service hana_sap_hva_s4_netweaver: The Hana database name. - Service heroku_postgres: The database name. - Service magento_mysql: The database name. - Service magento_mysql_rds: The database name. - Service maria: The database name. - Service maria_azure: The database name. - Service maria_rds: The database name. - Service mysql: The database name. - Service mysql_azure: The database name. - Service mysql_rds: The database name. - Service oracle: The database name. - Service oracle_ebs: The database name. - Service oracle_hva: The database name. - Service oracle_rac: The database name. - Service oracle_rds: The database name. - Service oracle_sap_hva: The database name. - Service postgres: The database name. - Service postgres_rds: The database name. - Service redshift_db: The database name: Redshift - Service sap_hana: The database name. - Service sap_s4hana: The database name. - Service snowflake_db: The database name: Snowflake - Service sql_server: The database name. - Service sql_server_hva: The database name. - Service sql_server_rds: The database name. - Service sql_server_sap_ecc_hva: The database name.
database_name str: Field usage depends on service value: - Service firebase: Database Name
dataset_id str: Field usage depends on service value: - Service google_analytics_360: The dataset ID. - Service google_analytics_4_export: The Dataset ID.
datasource str: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite data source value: NetSuite.com.
date_granularity str: Field usage depends on service value: - Service adobe_analytics: The aggregation duration you want. Default value: HOUR .
db str: Field usage depends on service value: - Service myosh: Your Myosh Server variables/db .
delimiter str: Field usage depends on service value: - Service aws_cost_report: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service azure_blob_storage: 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. - Service box: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service dropbox: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service kinesis: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service s3: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service sftp: 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. - Service share_point: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service wasabi_cloud_storage: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
developer_reference str: Field usage depends on service value: - Service brightpearl: Your Brightpearl dev reference.
dimension_attributes Sequence[str]: Field usage depends on service value: - Service double_click_publishers: Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions.
dimensions Sequence[str]: Field usage depends on service value: - Service adroll: The dimenstions that you want to sync. - Service double_click_campaign_manager: 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 - Service double_click_publishers: Report dimensions to include in the sync. The date dimension is mandatory for all the report types. - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_display_and_video_360: 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.
direct_capture_method str: Field usage depends on service value: - Service oracle_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY - Service oracle_sap_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY
distributed_connector_cluster_size float: Field usage depends on service value: - Service cosmos: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel. - Service dynamodb: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel.
domain str: Field usage depends on service value: - Service auth0: Your Auth0 domain. - Service bubble: Your Bubble app name or domain name. - Service confluence: Your Confluence domain. - Service kustomer: Domain is the beginning of your kustomer URL going before .kustomerapp.com, e.g. for yourcompany.kustomerapp.com the domain name is yourcompany - Service okta: Your Okta domain. - Service pipedrive: Your Pipedrive domain. - Service shopware: Your Shopware domain. - Service sistrix: Your SISTRIX domain. - Service solarwinds_service_desk: Your SolarWinds Service Desk domain. - Service uservoice: Domain of your UserVoice site. If it ends with ".uservoice.com", you can specify just the subdomain ("mydomain.uservoice.com" - "mydomain") - Service zendesk: Zendesk domain. - Service zendesk_sunshine: Zendesk domain.
domain_host_name str: Field usage depends on service value: - Service workday: Workday host name. - Service workday_financial_management: Workday host name. - Service workday_hcm: Workday host name.
domain_name str: Field usage depends on service value: - Service calabrio: Your Calabrio domain name - Service dynamics_365: The custom domain name associated with Dynamics 365. - Service helpshift: Your Helpshift domain name.
domain_type str: Field usage depends on service value: - Service medallia: Domain type of your Medallia URL
dsv_service_auth str
dsv_subscription_key str
ecommerce_stores Sequence[str]: Field usage depends on service value: - Service mailchimp: List of IDs of the Mailchimp E-Commerce Stores to Sync
edition str
elements Sequence[str]
email str: Field usage depends on service value: - Service appcues: Your Appcues Email. - Service boostr: Your Boostr email. - Service copper: Your Copper email address. - Service email: Send your emails to this address. - Service moloco: Your Moloco account email. - Service netsuite_suiteanalytics: The NetSuite user's email address. - Service pardot: The email of the Pardot user. - Service skuvault: Your SkuVault email. - Service smadex: Your Smadex account's email ID. - Service zendesk: Zendesk email. - Service zendesk_sunshine: Zendesk email.
email_address str: Field usage depends on service value: - Service clockodo: Your Clockodo email address.
email_id str: Field usage depends on service value: - Service ordway: Your Ordway user email ID. - Service planful: Your Planful email ID.
empty_header bool: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service azure_blob_storage: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service box: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service dropbox: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service email: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service ftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service gcs: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service google_drive: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service kinesis: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service s3: 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. - Service sftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service share_point: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service wasabi_cloud_storage: 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.
enable_all_dimension_combinations bool: Field usage depends on service value: - Service double_click_campaign_manager: Whether to enable all reach dimension combinations in the report. Default value: false
enable_archive_log_only bool: Field usage depends on service value: - Service sql_server_hva: Use archive log only mode - Service sql_server_sap_ecc_hva: Use archive log only mode
enable_data_extensions_syncing bool
enable_distributed_connector_mode bool: Field usage depends on service value: - Service cosmos: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors. - Service dynamodb: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors.
enable_enrichments bool: Field usage depends on service value: - Service snowplow: Enable Enrichments
enable_exports bool: Field usage depends on service value: - Service braze: Enable User Profile Exports
enable_tde bool: Field usage depends on service value: - Service sql_server_hva: Using Transparent Data Encryption (TDE) - Service sql_server_sap_ecc_hva: Using Transparent Data Encryption (TDE)
encoded_public_key str: Field usage depends on service value: - Service apple_search_ads: Use the public key to grant Fivetran access to Apple Search Ads api.
encryption_key str: Field usage depends on service value: - Service marketo: Marketo SOAP API Encryption Key.
endpoint str: Field usage depends on service value: - Service branch: Webhook Endpoint - Service iterable: Register the following URL for webhooks on your Iterable dashboard. - Service marketo: Marketo REST API endpoint. - Service snowplow: Connection-specific collector endpoint. The collector endpoint will have the webhooks.fivetran.com/snowplow/endpoint_ID format. You will need it to configure Snowplow to connect with Fivetran. - Service webhooks: You can send your events to https://webhooks.fivetran.com/webhooks/{endpoint}
engagement_attribution_window str: Field usage depends on service value: - Service pinterest_ads: The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action.
enriched_export str: Field usage depends on service value: - Service optimizely: Enriched Events S3 bucket
entity_id str: Field usage depends on service value: - Service checkout: Your Checkout.com entity ID. - Service zuora: If is_multi_entity_feature_enabled is true, then it's EntityId. - Service zuora_sandbox: If is_multi_entity_feature_enabled is true, then it's EntityId.
environment str: Field usage depends on service value: - Service bazaarvoice: Your Bazaarvoice environment. - Service buildium: Your Buildium environment. - Service checkout: Your Checkout.com environment. - Service concord: Your Concord environment. - Service deposco: Your Deposco environment. - Service dialpad: Your Dialpad environment. - Service invoiced: Your Invoiced environment. - Service jibble: Your Jibble environment. - Service lucca: Your Lucca environment. - Service procore: Your Procore account environment. - Service reltio: Your Reltio environment. - Service servicetitan: Your ServiceTitan environment. - Service smarthr: Your SmartHR environment. - Service trelica: Your Trelica environment. - Service tremendous: Your Tremendous environment. - Service vts: Your VTS environment. - Service xactly: Your Xactly environment. - Service younium: Your Younium API environment. - Service zuora: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox. - Service zuora_sandbox: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
environment_host str: Field usage depends on service value: - Service xactly: Your Xactly environment host.
environment_name str: Field usage depends on service value: - Service business_central: Name of the environment
escape_char str: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service azure_blob_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service box: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service dropbox: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service email: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service ftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service gcs: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service google_drive: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service kinesis: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service s3: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service sftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service share_point: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service wasabi_cloud_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
escape_char_options str: Field usage depends on service value: - Service gcs: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true. - Service s3: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true.
eu_region bool: Field usage depends on service value: - Service kustomer: Turn it on if your app is on EU region - Service survey_monkey: The SurveyMonkey account region. Specify true, if your account is hosted in the EU region. Default value is false.
events Sequence[str]: Field usage depends on service value: - Service iterable: List of events to sync. Should be specified when sync_mode is SelectedEvents
export_storage_type str: Field usage depends on service value: - Service adjust: Your cloud storage. - Service braze: Export Storage. Required if enable_exports is true
external_id str: Field usage depends on service value: - Service appsflyer: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_cloudtrail: This is the same as your group_id, used for authentication along with the role_arn. - Service aws_cost_report: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_lambda: The external ID is a string that designates who can assume the role. - Service aws_msk: This is the same as your group_id. This is required when sasl_mechanism is set to IAM. - Service azure_function: External ID. - Service cloudfront: This is the same as your group_id, used for authentication along with the role_arn. - Service dynamodb: This is the same as your group_id, used for authentication along with the role_arn. - Service kinesis: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service s3: Used for authentication along with the role_arn. If not provided, it uses connector's group_id. Use the List All Groups endpoint to find the group_id. - Service segment: The external ID is a string that designates who can assume the role. For more information, see a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"Amazon's AWS Identity and Access Management User Guide/a.
facility_codes str: Field usage depends on service value: - Service unicommerce: Your uniware facility codes.
fields Sequence[str]: Field usage depends on service value: - Service facebook: List of fields which connector will sync. Possible field values.
file_type str: Field usage depends on service value: - Service aws_cost_report: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service azure_blob_storage: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service box: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service dropbox: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service email: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service ftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service gcs: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service google_drive: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service kinesis: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service s3: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service sftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service share_point: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service wasabi_cloud_storage: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
filter str: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
finance_account_sync_mode str: Field usage depends on service value: - Service itunes_connect: Whether to sync all finance accounts or specific finance accounts.
finance_accounts Sequence[str]: Field usage depends on service value: - Service itunes_connect: Specific finance accounts to sync. Must be populated if finance_account_sync_mode is set to SpecificFinanceAccounts.
folder str: Field usage depends on service value: - Service dropbox: Your Dropbox Folder URL.
folder_id str: Field usage depends on service value: - Service box: Folder URL - Service google_drive: Folder URL
folder_path str: Field usage depends on service value: - Service adobe_analytics_data_feed: Folder Path - Service one_drive: Your OneDrive folder URL - Service oracle_business_intelligence_publisher: The folder path to save data models and reports.
forecast_id str: Field usage depends on service value: - Service clari: Your Clari Forecast id .
ftp_host str: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP host.
ftp_password str: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP password.
ftp_port float: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP port.
ftp_user str: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP user.
function str: Field usage depends on service value: - Service aws_lambda: The name of your AWS Lambda Function.
function_app str: Field usage depends on service value: - Service azure_function: Function app name in Azure portal.
function_key str: Field usage depends on service value: - Service azure_function: Function key used for authorization.
function_name str: Field usage depends on service value: - Service azure_function: Name of the function to be triggered.
function_trigger str: Field usage depends on service value: - Service google_cloud_function: The trigger URL of the cloud function.
gcs_bucket str: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the cloud_storage_type - Service webhooks: The GCS bucket name. Required if bucket_service is set to GCS.
gcs_export_bucket str: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the export_storage_type
gcs_export_folder str: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the export_storage_type
gcs_folder str: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the cloud_storage_type
generate_fivetran_pk bool: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
group_id str: Field usage depends on service value: - Service line_ads: Your LINE Ads group ID(s).
group_name str: Field usage depends on service value: - Service fivetran_log: (Optional) The group name of the target_group_id.
hana_backup_password str
hana_mode str: Field usage depends on service value: - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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.
has_manage_permissions bool: Field usage depends on service value: - Service azure_service_bus: The boolean value specifying whether the connection string has manage permissions
historic_sync_time_frame str: Field usage depends on service value: - Service braze: Range of data in history you would like to include in the initial sync. - Service iterable: The time range for which historical data should be synced. Default value: All Time. - Service klaviyo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service marketo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service sailthru: Range of historical data you would like to include in the initial sync. Default value: ALL_TIME. - Service salesforce_marketing_cloud: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME.
historical_sync_limit str: Field usage depends on service value: - Service concur: Historical Sync Limit for the Sync - Service eloqua: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service pardot: The time range for which historical data should be synced. Default value: All Time.
historical_sync_time_frame str: Field usage depends on service value: - Service rokt: Your Rokt historical sync time frame. - Service skimlinks: Your Skimlinks Historical sync time frame. - Service vimeo: Your Vimeo Historical sync time frame. - Service zendesk: Used to configure Historical sync timeframe for selected tables
home_folder str: Field usage depends on service value: - Service appsflyer: Your S3 home folder path of the Data Locker.
host str: Field usage depends on service value: - Service aurora: DB instance host or IP address. - Service aurora_postgres: DB instance host or IP address. - Service azure_postgres: DB instance host or IP address. - Service azure_sql_db: DB instance host or IP address. - Service azure_sql_managed_db: DB instance host or IP address. - Service clarity: DB instance host or IP address. - Service cockroachdb: DB instance host or IP address. - Service commercetools: Your commercetools host. - Service databricks_db: The host URL for your Databricks account. - Service db2i_hva: A host address of the primary node. It should be a DB instance host/IP address with a port number. - Service db2i_sap_hva: DB instance host or IP address. - Service documentdb: Host IP address of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: DB instance host or IP address. - Service ehr: DB instance host or IP address. - Service elastic_cloud: DB instance host or IP address. - Service es_self_hosted: DB instance host or IP address. - Service ftp: FTP host address. - Service google_cloud_mysql: DB instance host or IP address. - Service google_cloud_postgresql: DB instance host or IP address. - Service google_cloud_sqlserver: DB instance host or IP address. - Service hana_sap_hva_b1: DB instance host or IP address. - Service hana_sap_hva_ecc: DB instance host or IP address. - Service hana_sap_hva_ecc_netweaver: DB instance host or IP address. - Service hana_sap_hva_s4: DB instance host or IP address. - Service hana_sap_hva_s4_netweaver: DB instance host or IP address. - Service heroku_postgres: DB instance host or IP address. - Service jira: The Jira service host address. - Service magento_mysql: DB instance host or IP address. - Service magento_mysql_rds: DB instance host or IP address. - Service maria: DB instance host or IP address. - Service maria_azure: DB instance host or IP address. - Service maria_rds: DB instance host or IP address. - Service marin: The Marin host address. - Service mysql: DB instance host or IP address. - Service mysql_azure: DB instance host or IP address. - Service mysql_rds: DB instance host or IP address. - Service netsuite_suiteanalytics: The NetSuite service host address. - Service opendistro: DB instance host or IP address. - Service opensearch: DB instance host or IP address. - Service oracle: DB instance host or IP address. - Service oracle_ebs: DB instance host or IP address. - Service oracle_hva: DB instance host or IP address. - Service oracle_rac: DB instance host or IP address. - Service oracle_rds: DB instance host or IP address. - Service oracle_sap_hva: DB instance host or IP address. - Service oracle_sap_hva_netweaver: DB instance host or IP address. - Service postgres: DB instance host or IP address. - Service postgres_rds: DB instance host or IP address. - Service redshift_db: Host name - Service sap_hana: The SAP HANA host or IP address. - Service sap_s4hana: The SAP S/4 host or IP address. - Service sftp: SFTP host address. - Service snowflake_db: Host name - Service splunk: The Splunk service host address. - Service sql_server: DB instance host or IP address. - Service sql_server_hva: DB instance host or IP address. - Service sql_server_rds: DB instance host or IP address. - Service sql_server_sap_ecc_hva: DB instance host or IP address.
host_ip str: Field usage depends on service value: - Service azure_blob_storage: IP address of host tunnel machine which is used to connect to the Storage container. - Service azure_service_bus: The IP address of the host machine which we use to connect to ASB via ssh
host_name str: Field usage depends on service value: - Service coassemble: Your Coassemble Hostname. - Service datadog: Your Datadog host name.
host_url str: Field usage depends on service value: - Service adobe_commerce: Your Adobe Commerce host url. - Service sparkpost: Your SparkPost host URL.
host_user str: Field usage depends on service value: - Service azure_blob_storage: Username in the host machine. - Service azure_service_bus: The username on the host machine which we use to connect to ASB via ssh
hostname str: Field usage depends on service value: - Service akamai: Your Akamai hostname. - Service ukg_pro: Your UKG Pro hostname.
hosts Sequence[str]: Field usage depends on service value: - Service azure_cosmos_for_mongo: A list of host addresses for Azure Cosmos DB for Mongo DB. - Service mongo: 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. - Service mongo_sharded: 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.
http_path str: Field usage depends on service value: - Service databricks_db: http path
identifier str: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management client identifier. - Service statistics_netherlands_cbs: Your Statistics Netherlands CBS catalog identifier.
identity str: Field usage depends on service value: - Service marketo: Marketo REST API identity url.
include_ocapi_endpoints bool: Field usage depends on service value: - Service salesforce_commerce_cloud: Whether to sync data through OCAPI endpoints.
instance str: Field usage depends on service value: - Service acumatica: Your Acumatica instance name. - Service coupa: The instance name of your Coupa account in the URL. - Service flywheel_digital: Your Flywheel Digital instance. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud instance ID - Service servicenow: ServiceNow Instance ID.
instance_number str: Field usage depends on service value: - Service hana_sap_hva_b1: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service oracle_sap_hva_netweaver: Two-digit number (00-97) of the SAP instance within its host.
instance_url str: Field usage depends on service value: - Service sap_business_by_design: The SAP Business ByDesign instance URL.
integration_key str: Field usage depends on service value: - Service pendo: The integration key of the Pendo account.
ip_address str: Field usage depends on service value: - Service aveva_pi: IP address of the AF Server
is_account_level_connector bool: Field usage depends on service value: - Service fivetran_log: (Optional) Retrieve account-level logs.
is_auth2_enabled bool: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Default value: false
is_custom_api_credentials bool: Field usage depends on service value: - Service twitter_ads: Custom API credentials
is_external_activities_endpoint_selected bool: Field usage depends on service value: - Service pardot: Whether the EXTERNAL_ACTIVITY table must be synced or not.
is_ftps bool: Field usage depends on service value: - Service adobe_analytics_data_feed: Use Secure FTP (FTPS).
is_keypair bool: Field usage depends on service value: - Service sftp: Whether to use a key pair for authentication. When true, do not use password.
is_multi_entity_feature_enabled bool: Field usage depends on service value: - Service zuora: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false. - Service zuora_sandbox: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false.
is_new_package bool: Field usage depends on service value: - Service salesforce_marketing_cloud: Indicates that that your installed package uses OAuth 2.0. Default value: false
is_private_key_encrypted bool: Field usage depends on service value: - Service snowflake_db: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
is_private_link_required bool: Field usage depends on service value: - Service aws_lambda: We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our PrivateLink documentation. - Service s3: Set to true if you want to connect to S3 bucket over PrivateLink. Default value: false.
is_public bool: Field usage depends on service value: - Service aws_cost_report: Whether you are syncing from a public bucket. Default value: false. - Service kinesis: Is the bucket public? (you don't need an AWS account for syncing public buckets!) - Service s3: Whether you are syncing from a public bucket. Default value: false.
is_sailthru_connect_enabled bool: Field usage depends on service value: - Service sailthru: Enable this if you want to sync Sailthru Connect
is_secure bool: Field usage depends on service value: - Service ftp: Whether the server supports FTPS.
is_sftp_creds_available bool: Field usage depends on service value: - Service salesforce_marketing_cloud: Provide SFTP credentials
is_single_table_mode bool: Field usage depends on service value: - Service box: Allows the creation of connector using Merge Mode strategy. - Service dropbox: Allows the creation of connector using Merge Mode strategy. - Service google_drive: Allows the creation of connector using Merge Mode strategy. - Service sftp: Allows the creation of connector using the specified Sync strategy. - Service share_point: Allows the creation of connector using Merge Mode strategy.
is_test_account bool: Field usage depends on service value: - Service adyen: Whether or not your Adyen Account is a Test Account. Default value: false.
is_vendor bool: Field usage depends on service value: - Service amazon_selling_partner: Whether or not you have a Vendor Account. Default value: false.
issuer str: Field usage depends on service value: - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud issuer name.
json_delivery_mode str: Field usage depends on service value: - Service aws_cost_report: Control how your JSON data is delivered into your destination - Service azure_blob_storage: Control how your JSON data is delivered into your destination - Service box: Control how your JSON data is delivered into your destination - Service dropbox: Control how your JSON data is delivered into your destination - Service email: Control how your JSON data is delivered into your destination - Service ftp: Control how your JSON data is delivered into your destination - Service gcs: Control how your JSON data is delivered into your destination - Service google_drive: Control how your JSON data is delivered into your destination - Service kinesis: Control how your JSON data is delivered into your destination - Service s3: Control how your JSON data is delivered into your destination - Service sftp: Control how your JSON data is delivered into your destination - Service share_point: Control how your JSON data is delivered into your destination - Service wasabi_cloud_storage: Specifies how Fivetran should handle your JSON data. Default value: Packed.
key str: Field usage depends on service value: - Service uservoice: The UserVoice API key.
key_password str: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Key Password.
key_store_type str: Field usage depends on service value: - Service heroku_kafka: Key Store Type
keystore str: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Keystore File as Base64 encoded string.
keystore_password str: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Keystore Password.
last_synced_changes_utc_ str
latest_version str
legal_entity_id str: Field usage depends on service value: - Service younium: Your Younium legal entity ID.
limit_for_api_calls_to_external_activities_endpoint float: Field usage depends on service value: - Service pardot: API limit for the external activities endpoint.
line_separator str: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
list_id str: Field usage depends on service value: - Service pigment: Your Pigment list ID.
list_of_company_ids str: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail list of company IDs.
list_strategy str: Field usage depends on service value: - Service aws_cost_report: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service kinesis: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service s3: The listing strategy you want to use. Default value: complete_listing.
list_sync_mode str: Field usage depends on service value: - Service google_analytics_4_export: The Sync Mode
log_journal str: Field usage depends on service value: - Service db2i_hva: The log journal name. - Service db2i_sap_hva: The log journal name.
log_journal_schema str: Field usage depends on service value: - Service db2i_hva: The log journal schema. - Service db2i_sap_hva: The log journal schema.
log_on_group str: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional. - Service hana_sap_hva_s4_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional.
login str: Field usage depends on service value: - Service rebound_returns: Your ReBound Returns login. - Service the_trade_desk: The Trade Desk email. It is a part of the login credentials. - Service walmart_dsp: Walmart DSP email. It is a part of the login credentials.
login_password str: Field usage depends on service value: - Service concur: The SAP Concur password. - Service sage_intacct: The login password. It is a part of the login credentials.
manager_accounts Sequence[str]: Field usage depends on service value: - Service google_ads: The list of the Manager Account IDs whose clients will be synced. Must be populated if sync_mode is set to ManagerAccounts.
max_api_requests_per_day float: Field usage depends on service value: - Service reltio: Maximum API requests per day
merchant_id str: Field usage depends on service value: - Service afterpay: Your Afterpay Merchant ID. - Service amazon_selling_partner: The Merchant ID or Vendor Code. - Service avantlink: Your AvantLink Merchant ID. - Service braintree: Your Braintree merchant ID. - Service braintree_sandbox: Your Braintree merchant ID. - Service shareasale: Your ShareASale merchant ID. - Service xsolla: Your Xsolla Merchant ID.
message_type str: Field usage depends on service value: - Service apache_kafka: Kafka message type. - Service aws_msk: The Message type. - Service azure_event_hub: Message type. - Service azure_service_bus: The format of messages in the topic - Service confluent_cloud: Confluent Cloud message type. - Service heroku_kafka: Heroku Kafka message type.
metric_id str: Field usage depends on service value: - Service pigment: Your Pigment metric ID.
metrics Sequence[str]: Field usage depends on service value: - Service adroll: The metrics that you want to sync. - Service criteo: Metrics - Service double_click_campaign_manager: Report metrics to include into a sync. - Service google_analytics: The report metrics to include into a sync. - Service google_display_and_video_360: 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.
named_range str: Field usage depends on service value: - Service google_sheets: The name of the named data range on the sheet that contains the data to be synced.
namespace str: Field usage depends on service value: - Service azure_service_bus: The ASB namespace which we have to sync. Required for AzureActiveDirectory authentication.
network_code float: Field usage depends on service value: - Service double_click_publishers: Network code is a unique, numeric identifier for your Ad Manager network.
non_standard_escape_char bool: Field usage depends on service value: - Service gcs: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false. - Service s3: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false.
null_sequence str: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service azure_blob_storage: If your CSVs use a special value indicating null, you can specify it here. - Service box: If your CSVs use a special value indicating null, you can specify it here. - Service dropbox: If your CSVs use a special value indicating null, you can specify it here. - Service email: If your CSVs use a special value indicating null, you can specify it here. - Service ftp: If your CSVs use a special value indicating null, you can specify it here. - Service gcs: If your CSVs use a special value indicating null, you can specify it here. - Service google_drive: If your CSVs use a special value indicating null, you can specify it here. - Service kinesis: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service s3: If your CSVs use a special value indicating null, you can specify it here. - Service sftp: If your CSVs use a special value indicating null, you can specify it here. - Service share_point: If your CSVs use a special value indicating null, you can specify it here. - Service wasabi_cloud_storage: If your CSVs use a special value indicating null, you can specify it here.
oauth_token str
oauth_token_secret str
ocapi_client_id str: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client ID.
ocapi_client_secret str: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client secret.
ocapi_custom_object_types str: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI custom object types.
ocapi_hostname str: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI hostname.
odbc_driver_manager_library_path str: Field usage depends on service value: - Service hana_sap_hva_b1: ODBC manager library path - Service hana_sap_hva_ecc: ODBC manager library path - Service hana_sap_hva_s4: ODBC manager library path
odbc_sys_ini_path str: Field usage depends on service value: - Service hana_sap_hva_b1: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_ecc: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_s4: odbc.ini and odbcsinst.ini location
on_error str: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
on_premise bool: Field usage depends on service value: - Service jira: Whether the Jira instance is local or in cloud.
organization str: Field usage depends on service value: - Service gladly: Your Gladly Organization Name. - Service statuspage: Your Statuspage Organization ID.
organization_domain str: Field usage depends on service value: - Service adobe_workfront: Your Adobe Workfront organization domain.
organization_id str: Field usage depends on service value: - Service adobe_analytics: Organization ID from the Service Account (JWT) credentials of your Adobe Project. - Service integrate: Your Integrate organization ID. - Service megaphone: Your Megaphone organization ID. - Service productive: Your Productive Organization ID. - Service salesforce_commerce_cloud: The organization ID from Salesforce Commerce Cloud account. - Service sentry: Your Sentry organization ID. - Service zoho_books: Your Zoho Books Organization ID. - Service zoho_inventory: Your Zoho Inventory organization ID.
organization_name str: Field usage depends on service value: - Service brightpearl: Your Brightpearl organization name. - Service confluence: Your Confluence organization name.
organizations Sequence[str]: Field usage depends on service value: - Service apple_search_ads: Organizations - Service snapchat_ads: Specific organizations IDs to sync. Must be populated if syncMode is set to SpecificOrganizations.
packed_mode_tables Sequence[str]: Field usage depends on service value: - Service azure_cosmos_for_mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service dynamodb: List of tables to be synced in packed mode. - Service firebase: Specific tables to sync. Must be populated if packing_mode is set to SelectTablesForPackedMode. - Service mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service mongo_sharded: List of tables to be synced in packed mode; format:db.table(case-sensitive).
packing_mode str: Field usage depends on service value: - Service azure_cosmos_for_mongo: Indicates the desired sync pack mode. Accepted values are UsePackedModeOnly and UseUnpackedModeOnly. SelectTablesForPackedMode is deprecated. - Service firebase: Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service klaviyo: Packing mode for EVENT and PERSON tables. - Service mongo: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service mongo_sharded: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service optimizely: Packing mode for conversion and decision tables. - Service sailthru: Packing mode for LIST_STATE and USER tables.
pages Sequence[str]: Field usage depends on service value: - Service facebook_pages: Specific pages to sync. Must be populated if sync_mode is set to SpecificPages.
partner_code str: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission partner code.
partner_user_id str: Field usage depends on service value: - Service expensify: Your Expensify partnerUserID.
partner_user_secret str: Field usage depends on service value: - Service expensify: Your Expensify partnerUserSecret.
partners Sequence[str]: Field usage depends on service value: - Service google_display_and_video_360: The list of partners to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service the_trade_desk: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service walmart_dsp: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
pass_phrase str: Field usage depends on service value: - Service qualtrics: Pass Phrase
passphrase str: Field usage depends on service value: - Service snowflake_db: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
password str: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS password. - Service adobe_commerce: Your Adobe Commerce password. - Service akeneo: Your Akeneo password. - Service anaplan: Your Anaplan password. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Password. - Service aurora: The user's password. - Service aurora_postgres: The user's password. - Service azure_cosmos_for_mongo: Password used for source database authentication. - Service azure_postgres: The user's password. - Service azure_sql_db: The user's password. - Service azure_sql_managed_db: The user's password. - Service boostr: Your Boostr password. - Service ceridian_dayforce: Your Ceridian Dayforce Password. - Service cin7: Your Cin7 API Key. - Service clarity: The user's password. - Service cockroachdb: The user's password. - Service collibra: Your collibra password. - Service compliance_checkpoint: Your Compliance Checkpoint account password. - Service contrast_security: Your Contrast Security API Password. - Service db2i_hva: The user's password. - Service db2i_sap_hva: The user's password. - Service deposco: Your Deposco password. - Service documentdb: The user's password. - Service dynamics_365_fo: The user's password. - Service ehr: The user's password. - Service elastic_cloud: The user's password. - Service es_self_hosted: The user's password. - Service ftp: FTP password. - Service globalmeet: Your GlobalMeet Password. - Service google_cloud_mysql: The user's password. - Service google_cloud_postgresql: The user's password. - Service google_cloud_sqlserver: The user's password. - Service green_power_monitor: Your GreenPowerMonitor password. - Service guru: Your Guru password. - Service hana_sap_hva_b1: The user's password. - Service hana_sap_hva_ecc: The user's password. - Service hana_sap_hva_ecc_netweaver: The user's password. - Service hana_sap_hva_s4: The user's password. - Service hana_sap_hva_s4_netweaver: The user's password. - Service heroku_postgres: The user's password. - Service hilti_ontrack: Your Hilti On!Track password. - Service impact: Your Impact Account Token - Service integral_ad_science: Your integral_ad_science password. - Service itunes_connect: Your password - Service jamf: Your Jamf password. - Service jira: The Jira user's password. - Service khoros_care: Your Khoros Care password. - Service kissmetrics: Your Kissmetrics API Password. - Service klarna: Your Klarna Password. - Service lessonly: Your Lessonly password. - Service magento_mysql: The user's password. - Service magento_mysql_rds: The user's password. - Service maria: The user's password. - Service maria_azure: The user's password. - Service maria_rds: The user's password. - Service marin: The Marin user's password. - Service moloco: Your Moloco account password. - Service mongo: The user's password. - Service mongo_sharded: The user's password. - Service myosh: Your myosh password. - Service mysql: The user's password. - Service mysql_azure: The user's password. - Service mysql_rds: The user's password. - Service netsuite_suiteanalytics: The NetSuite user's password. - Service opendistro: The user's password. - Service opensearch: The user's password. - Service oracle: The user's password. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence user password. - Service oracle_ebs: The user's password. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud user password. - Service oracle_hva: The user's password. - Service oracle_rac: The user's password. - Service oracle_rds: The user's password. - Service oracle_sap_hva: The user's password. - Service oracle_sap_hva_netweaver: The user's password. - Service outbrain: The Outbrain user's password. - Service pardot: The Pardot user's password. - Service partnerize: Your Partnerize account's password. - Service podio: Your Podio account password. - Service postgres: The user's password. - Service postgres_rds: The user's password. - Service qmatic_data_connect: Your Qmatic Data Connect password. - Service redshift_db: The Redshift user's password. - Service revx: Your RevX Password. - Service rtb_house: Your RTB House password. - Service sap_business_by_design: The SAP Business ByDesign password. - Service sap_hana: Your SAP HANA password. - Service sap_s4hana: Your SAP S/4 password. - Service scorm: Your Scorm Secret Key. - Service servicenow: Your account password. - Service sftp: SFTP password. - Service shiphero: Your ShipHero password. - Service shipstation: Your ShipStation password. - Service shopware: Your Shopware password. - Service skuvault: Your SkuVault password. - Service smadex: Your Smadex Password. - Service snowflake_db: The Snowflake user's password. - Service splash: Your Splash password. - Service splunk: The Splunk user's password. - Service sql_server: The user's password. - Service sql_server_hva: The user's password. - Service sql_server_rds: The user's password. - Service sql_server_sap_ecc_hva: The user's password. - Service starrez: Your StarRez API password - Service stickyio: Your sticky.io password. - Service stylight: Your Stylight Password. - Service sugarcrm: Your SugarCRM password. - Service teamwork: Your Teamwork password. - Service the_trade_desk: The Trade Desk password. It is a part of the login credentials. - Service toggl_track: Your Toggl Track Password - Service ukg_pro: Your UKG Pro password. - Service unicommerce: Your uniware login password. - Service upland: Your Upland Software Password. - Service veevavault: Your Veeva Vault password. - Service walmart_dsp: Walmart DSP password. It is a part of the login credentials. - Service when_i_work: Your When I Work password. - Service wherefour: Your Wherefour password. - Service workday: Workday password. - Service workday_financial_management: Workday password. - Service workday_hcm: Workday password. - Service xandr: Your Xandr password. - Service younium: Your Younium password.
pat str: Field usage depends on service value: - Service github: The Personal Access Token generated in Github.
pat_name str: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Name.
pat_secret str: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Secret.
path str: Field usage depends on service value: - Service jira: A URL subdirectory where the Jira instance is working.
pats Sequence[str]: Field usage depends on service value: - Service github: The Personal Access Tokens.
pattern str: Field usage depends on service value: - Service aws_cost_report: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service azure_blob_storage: All files in your search path matching this regular expression will be synced. - Service box: All files in your search path matching this regular expression will be synced. - Service dropbox: All files in your search path matching this regular expression will be synced. - Service email: All files in your search path matching this regular expression will be synced. - Service ftp: All files in your search path matching this regular expression will be synced. - Service gcs: All files in your search path matching this regular expression will be synced. - Service google_drive: All files in your search path matching this regular expression will be synced. - Service kinesis: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service s3: All files in your search path matching this regular expression will be synced. - Service sftp: All files in your search path matching this regular expression will be synced. - Service share_point: All files in your search path matching this regular expression will be synced. - Service wasabi_cloud_storage: All files in your search path matching this regular expression will be synced.
pdb_name str: Field usage depends on service value: - Service oracle: Optional: Required only for containerized database. - Service oracle_ebs: Optional: Required only for containerized database. - Service oracle_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases. - Service oracle_rac: Optional: Required only for containerized database. - Service oracle_rds: Optional: Required only for containerized database. - Service oracle_sap_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
pem_certificate str: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Must be populated if is_auth2_enabled is set to false.
pem_private_key str: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM secret key file. Must be populated if is_auth2_enabled is set to true.
per_interaction_dimensions Sequence[str]: Field usage depends on service value: - Service double_click_campaign_manager: Per Interaction Dimensions.
personal_access_token str: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail personal access token. - Service databricks_db: Access Token - Service harvest: Your Harvest Personal Access Token. - Service productive: Your Productive personal access token. - Service totango: Your Totango personal access token.
personal_api_token str: Field usage depends on service value: - Service circleci: Your CircleCI Personal API token. - Service monday: Your Monday.com Personal API Token.
pgp_pass_phrase str: Field usage depends on service value: - Service azure_blob_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true.
pgp_secret_key str: Field usage depends on service value: - Service azure_blob_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true.
phone_number str: Field usage depends on service value: - Service itunes_connect: Register the number on AppleId Account Page for 2FA
plan_type str: Field usage depends on service value: - Service justcall: Your JustCall Plan Type.
port float: Field usage depends on service value: - Service aurora: The port number. - Service aurora_postgres: The port number. - Service aveva_pi: Port number at which the AF Server is running - Service azure_postgres: The port number. - Service azure_sql_db: The port number. - Service azure_sql_managed_db: The port number. - Service clarity: The port number. - Service cockroachdb: The port number. - Service databricks_db: The port of your SQL warehouse. - Service db2i_hva: The port number. - Service db2i_sap_hva: The port number. - Service documentdb: Port of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: The port number. - Service ehr: The port number. - Service elastic_cloud: The port number. - Service es_self_hosted: The port number. - Service ftp: FTP port. - Service google_cloud_mysql: The port number. - Service google_cloud_postgresql: The port number. - Service google_cloud_sqlserver: The port number. - Service hana_sap_hva_b1: The port number. - Service hana_sap_hva_ecc: The port number. - Service hana_sap_hva_ecc_netweaver: The port number. - Service hana_sap_hva_s4: The port number. - Service hana_sap_hva_s4_netweaver: The port number. - Service heroku_postgres: The port number. - Service jira: The Jira service host port. - Service magento_mysql: The port number. - Service magento_mysql_rds: The port number. - Service maria: The port number. - Service maria_azure: The port number. - Service maria_rds: The port number. - Service mysql: The port number. - Service mysql_azure: The port number. - Service mysql_rds: The port number. - Service netsuite_suiteanalytics: The NetSuite service host port. - Service opendistro: The port number. - Service opensearch: The port number. - Service oracle: The port number. - Service oracle_ebs: The port number. - Service oracle_hva: The port number. - Service oracle_rac: The port number. - Service oracle_rds: The port number. - Service oracle_sap_hva: The port number. - Service postgres: The port number. - Service postgres_rds: The port number. - Service redshift_db: Port number - Service sap_hana: The SAP HANA port number. - Service sap_s4hana: The SAP S/4 port number. - Service sftp: SFTP port. - Service snowflake_db: The Snowflake optional port number. - Service splunk: The Splunk service host port. - Service sql_server: The port number. - Service sql_server_hva: The port number. - Service sql_server_rds: The port number. - Service sql_server_sap_ecc_hva: The port number.
post_click_attribution_window_size str: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on clicks. Default value: DAY_30
prebuilt_report str: Field usage depends on service value: - Service facebook: The name of report of which connector will sync the data. Possible prebuilt_report values. - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data.
prefix str: Field usage depends on service value: - Service aws_cloudtrail: If prefix is present when configuring the bucket. - Service aws_cost_report: Folder path to the aws_cost_report files within the bucket. - Service aws_inventory: The prefix if you used one when configuring the bucket. - Service azure_blob_storage: All files and folders under this folder path will be searched for files to sync. - Service box: All files and folders under this folder path will be searched for files to sync. - Service cloudfront: The name of the CloudFront folder in the bucket. - Service dropbox: All files and folders under this folder path will be searched for files to sync. - Service ftp: All files and folders under this folder path will be searched for files to sync. - Service gcs: All files and folders under this folder path will be searched for files to sync. - Service google_drive: 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 - Service kinesis: Folder path to the Kinesis files within the bucket. - Service marin: Folder path to the Marin manifest file. - Service microsoft_dynamics_365_fo: Folder name in which the exported dynamics 365 data resides. - Service s3: All files and folders under this folder path will be searched for files to sync. - Service segment: Folder path to the Segment files within the bucket. Must be populated if sync_type is set to S3. - Service sftp: All files and folders under this folder path will be searched for files to sync. - Service share_point: All files and folders under this folder path link will be searched for files to sync. This can be any shared folder link. - Service wasabi_cloud_storage: All files and folders under this folder path will be searched for files to sync.
primary_key str: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission primary key.
primary_keys Sequence[str]: Field usage depends on service value: - Service workday: Primary Keys
private_key str: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS REST API private key. - Service adobe_analytics: The complete contents of your private key file including the start and end tags (----BEGIN PRIVATE KEY---- to ----END PRIVATE KEY----). - Service adp_workforce_now: Private Key. - Service anaplan: The contents of your private key file. Must be populated if auth_mode is set to Certificate. - Service apple_search_ads: The contents of your secret key file. Must be populated if is_auth2_enabled is set to false. - Service braintree: The contents of your secret key file. - Service braintree_sandbox: The contents of your secret key file. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud private key. - Service qualtrics: Your private key - Service salesforce: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service snowflake_db: Private access key. The field should be specified if authentication type is KEY_PAIR.
private_token str: Field usage depends on service value: - Service eventbrite: Your Eventbrite private token.
product str: Field usage depends on service value: - Service webconnex: Your Webconnex product.
profiles Sequence[str]: Field usage depends on service value: - Service amazon_ads: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SpecificProfiles. - Service google_analytics: Specific User Profile IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_mcf: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
profiles_amazon_dsp str: Field usage depends on service value: - Service amazon_dsp: Comma-separated list of your Amazon DSP profiles.
project_access_token str: Field usage depends on service value: - Service rollbar: Your Rollbar project access token.
project_credentials Sequence[GetConnectorConfigProjectCredential]: Field usage depends on service value: - Service amplitude: * Project(s)
project_id str: Field usage depends on service value: - Service bigquery_db: BigQuery project ID - Service google_analytics_360: The project ID. - Service google_analytics_4_export: The Project ID. - Service mixpanel: Project ID
project_ids str: Field usage depends on service value: - Service sentry: Your Sentry project IDs.
project_key str: Field usage depends on service value: - Service commercetools: Your commercetools project key.
projects Sequence[str]: Field usage depends on service value: - Service asana: Specific Project IDs to sync. Must be populated if syncMode is set to SpecificProjects. - Service jira: Specific projects to sync. Must be populated if syncMode is set to CUSTOM.
properties Sequence[str]: Field usage depends on service value: - Service google_analytics_4: The array of strings in the properties/{id} format where id is a Google Analytics 4 property identifier. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
property_id str: Field usage depends on service value: - Service cloudbeds: Your Cloudbeds property IDs.
public_key str: Field usage depends on service value: - Service aurora: Public Key - Service aurora_postgres: Public Key - Service azure_blob_storage: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_cosmos_for_mongo: Public Key - Service azure_postgres: Public Key - Service azure_service_bus: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_sql_db: Public Key. - Service azure_sql_managed_db: Public Key. - Service braintree: The contents of your PEM certificate file. - Service braintree_sandbox: The contents of your PEM certificate file. - Service clarity: Public Key. - Service cockroachdb: Public Key - Service db2i_hva: Public Key - Service db2i_sap_hva: Public Key - Service documentdb: Public Key - Service dynamics_365_fo: Public Key. - Service ehr: Public Key. - Service elastic_cloud: Public Key - Service es_self_hosted: Public Key - Service google_cloud_mysql: Public Key - Service google_cloud_postgresql: Public Key - Service google_cloud_sqlserver: Public Key. - Service hana_sap_hva_b1: Public Key - Service hana_sap_hva_ecc: Public Key - Service hana_sap_hva_ecc_netweaver: Public Key - Service hana_sap_hva_s4: Public Key - Service hana_sap_hva_s4_netweaver: Public Key - Service heroku_postgres: Public Key - Service magento_mysql: Public Key - Service magento_mysql_rds: Public Key - Service maria: Public Key - Service maria_azure: Public Key - Service maria_rds: Public Key - Service mongo: Public Key - Service mongo_sharded: Public Key - Service mysql: Public Key - Service mysql_azure: Public Key - Service mysql_rds: Public Key - Service opendistro: Public Key - Service opensearch: Public Key - Service oracle: Public Key - Service oracle_ebs: Public Key - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud public key. - Service oracle_hva: Public Key - Service oracle_rac: Public Key - Service oracle_rds: Public Key - Service oracle_sap_hva: Public Key - Service partnerstack_vendor: Your PartnerStack Vendor Public key. - Service postgres: Public Key - Service postgres_rds: Public Key - Service sap_hana: Public Key - Service sap_s4hana: Public Key - Service sftp: Public Key - Service sql_server: Public Key. - Service sql_server_hva: Public Key. - Service sql_server_rds: Public Key. - Service sql_server_sap_ecc_hva: Public Key.
publication_name str: Field usage depends on service value: - Service aurora_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service azure_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service google_cloud_postgresql: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service heroku_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres_rds: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT".
publisher_id str: Field usage depends on service value: - Service skimlinks: Your Skimlinks publisher ID.
pull_archived_campaigns bool: Field usage depends on service value: - Service outbrain: Include or ignore results from archived campaigns
python_version str
query_id str: Field usage depends on service value: - Service google_display_and_video_360: The ID of the query whose configuration you want to reuse. This is a required parameter when config_method is set to REUSE_EXISTING.
query_param_value str: Field usage depends on service value: - Service alchemer: Your Alchemer API key. - Service birdeye: Your Birdeye query-param-value.
quota_project_id str: Field usage depends on service value: - Service bigquery_db: Specify a different project ID to account for quota and billing of Fivetran query workload
quote_char str: Field usage depends on service value: - Service azure_blob_storage: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service gcs: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service google_drive: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service s3: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service sftp: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service share_point: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
quote_character_enabled bool: Field usage depends on service value: - Service azure_blob_storage: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service gcs: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service google_drive: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service s3: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service sftp: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service share_point: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
rate_limit_plan str: Field usage depends on service value: - Service vimeo: Your Vimeo rate limit plan.
refresh_token str: Field usage depends on service value: - Service ironsource: Your Ironsource Client Secret.
refresh_token_expires_at str: Field usage depends on service value: - Service pinterest_ads: The expiration date of the refresh token. Unix timestamp in seconds
region str: Field usage depends on service value: - Service algolia: Your Algolia analytics region. - Service amazon_ads: The region used by the Amazon Ads profile. - Service amazon_selling_partner: The region used by the Amazon Selling Partner profile. - Service anaplan: Your Anaplan account region - Service atlassian_ops_genie: Your company's Osgenie region (usually company.opsgenie.com) - Service awin: Your Awin Region. - Service aws_lambda: The AWS region code for the DynamoDB instance. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Region - Service concur: The region. - Service cvent: Your Cvent region. - Service everflow: Your Everflow region. - Service exact_online: Your Exact Online region. - Service getfeedback: Your GetFeedback region. - Service happyfox: Your HappyFox region. - Service keypay: Your KeyPay region. - Service medallia_agile_research: Your Medallia Agile region. - Service messagebird: Your MessageBird Account region. - Service mixpanel: Data Region - Service navan: Your Navan region. - Service on24: Your ON24 region. - Service pendo: The Pendo account region. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Region. - Service ringover: Your Ringover region. - Service samsara: The region of your Samsara account. For instance, if your region is EUROPE, provide eu.samsara in the Region field. If your region is not in Europe, provide samsara. - Service snyk: Your Snyk region. - Service talkdesk: Your Talkdesk region (".com",".eu","ca.com") - Service totango: Your Totango region. - Service transcend: Your Transcend region. - Service vonage_contact_center: Your Vonage Contact Center region. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: US_EAST_1. - Service workday_strategic_sourcing: Your Workday Strategic Sourcing Region. - Service zoho_books: Your Zoho Books application host region. - Service zoho_campaigns: Your Zoho Campaigns application host region. - Service zoho_desk: Your Zoho Desk domain. - Service zoho_inventory: Your Zoho Inventory application host region.
region_api_url str: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution API URL region.
region_auth_url str: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution auth URL region.
region_token_url str: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution token URL region.
region_url str: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management region URL.
replica_id float: Field usage depends on service value: - Service aurora: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service google_cloud_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
replication_slot str: Field usage depends on service value: - Service aurora_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service azure_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service google_cloud_postgresql: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service heroku_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres_rds: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT".
report_configs Sequence[GetConnectorConfigReportConfig]: Field usage depends on service value: - Service yahoo_dsp: Specify the reports you want to sync. This is optional.
report_configuration_ids Sequence[str]: Field usage depends on service value: - Service double_click_campaign_manager: You can select only one Floodlight Configuration ID per account.
report_format_type str: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
report_granularity str: Field usage depends on service value: - Service pinterest_ads: Granularity at which reports will be
report_keys str: Field usage depends on service value: - Service rakutenadvertising: Your Rakuten Advertising report keys.
report_lists Sequence[GetConnectorConfigReportList]: Field usage depends on service value: - Service spotify_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
report_service_api_key str: Field usage depends on service value: - Service adyen: Your Report Service API key.
report_suites Sequence[str]
report_timezone str: Field usage depends on service value: - Service criteo: Report Timezone
report_type str: Field usage depends on service value: - Service adroll: The report type you want. Default value: ALL_ADS. - Service double_click_campaign_manager: Type of reporting data to sync. Default value: STANDARD. - Service google_display_and_video_360: The type of the report to create. This is a required parameter when config_method is set to CREATE_NEW. - Service youtube_analytics: The name of report of which connector will sync the data.
report_url str: Field usage depends on service value: - Service workday: URL for a live custom report.
reports Sequence[GetConnectorConfigReport]: Field usage depends on service value: - Service google_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics_4: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_search_ads_360: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service google_search_console: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service workday: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
reports_linkedin_ads Sequence[str]: Field usage depends on service value: - Service linkedin_ads: Specific analytics reports to sync. Must be populated if adAnalytics is set to 'SpecificReports'.
repositories Sequence[str]: Field usage depends on service value: - Service github: Specific Repository IDs to sync. Must be populated if syncMode is set to SpecificRepositories.
resource_token str: Field usage depends on service value: - Service cosmos: A token that provides access to a specific Azure Cosmos DB resource. Required for the RESOURCE_TOKEN data access method.
resource_url str: Field usage depends on service value: - Service dynamics_365: URL at which Dynamics 365 is accessed
rest_api_limit float: Field usage depends on service value: - Service pardot: The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
rfc_library_path str: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service hana_sap_hva_s4_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service oracle_sap_hva_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files.
role str: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Role ID for connection. - Service snowflake_db: Snowflake Connector role name
role_arn str: Field usage depends on service value: - Service appsflyer: S3 Role ARN - Service aws_cloudtrail: The Role ARN required for authentication. - Service aws_cost: The Role ARN required for authentication. - Service aws_cost_report: The Role ARN required for authentication. - Service aws_inventory: The Role ARN required for authentication. - Service aws_lambda: The Role ARN required for authentication. - Service aws_msk: If sasl_mechanism is set to IAM, enter your Role ARN - Service cloudfront: The Role ARN required for authentication. - Service dynamodb: Role ARN - Service heap: The Role ARN required for authentication. - Service kinesis: The Role ARN required for authentication. - Service s3: The Role ARN required for authentication. Required for connector creation when syncing using private bucket. - Service segment: The Role ARN required for authentication. Must be populated if sync_type is set to S3.
rollback_window float: Field usage depends on service value: - Service appsflyer: Rollback window
rollback_window_size float: Field usage depends on service value: - Service bingads: A period of time in days during which a conversion is recorded.
s3_bucket str: Field usage depends on service value: - Service webhooks: The S3 bucket name. Required if bucket_service is set to S3.
s3_export_bucket str: Field usage depends on service value: - Service braze: Your S3 user export bucket. Required if AWS_S3 is the export_storage_type
s3_export_external_id str: Field usage depends on service value: - Service braze: This is the same as your group_id, used if export_storage_type is AWS_S3
s3_export_folder str: Field usage depends on service value: - Service braze: Your S3 user export folder name. Required if AWS_S3 is the export_storage_type
s3_export_role_arn str: Field usage depends on service value: - Service braze: The Role ARN required for authentication required if AWS_S3 is the export_storage_type
s3_role_arn str: Field usage depends on service value: - Service adjust: Used if the export_storage_type is AWS_S3, the Role ARN required for authentication. - Service webhooks: The Role ARN required for authentication. Required if bucket_service is set to S3.
s3bucket str: Field usage depends on service value: - Service adobe_analytics_data_feed: The S3 bucket name. - Service braze: Your S3 bucket required if AWS_S3 is the cloud_storage_type - Service sailthru: Name of the bucket configured to receive sailthru connect data.
s3external_id str: Field usage depends on service value: - Service braze: 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 - Service sailthru: The external ID is a string that designates who can assume the role.
s3folder str: Field usage depends on service value: - Service braze: Your S3 folder name required if AWS_S3 is the cloud_storage_type
s3path str: Field usage depends on service value: - Service sailthru: Copy and use this to configure Sailthru Connect in your sailthru account.
s3role_arn str: Field usage depends on service value: - Service adobe_analytics_data_feed: The Role ARN required for authentication. - Service braze: The Role ARN required for authentication required if AWS_S3 is the cloud_storage_type - Service sailthru: Role ARN of the IAM role created for Fivetran.
sales_account_sync_mode str: Field usage depends on service value: - Service itunes_connect: Whether to sync all sales accounts or specific sales accounts.
sales_accounts Sequence[str]: Field usage depends on service value: - Service itunes_connect: Specific sales account to sync. Must be populated if sales_account_sync_mode is set to SpecificSalesAccounts.
salesforce_security_token str: Field usage depends on service value: - Service pardot: The Pardot user's Salesforce SSO Account Security Token.
sandbox_account str: Field usage depends on service value: - Service gocardless: Your GoCardless account type.
sap_schema str: Field usage depends on service value: - Service db2i_hva: The SAP schema. - Service db2i_sap_hva: SAP schema name. - Service sql_server_hva: SAP Schema Name. Required only for High-Volume Agent SAP ECC connector. - Service sql_server_sap_ecc_hva: SAP Schema Name.
sap_source_schema str: Field usage depends on service value: - Service hana_sap_hva_b1: The schema name where the HANA tables reside. - Service hana_sap_hva_ecc: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_ecc_netweaver: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4_netweaver: The Hana schema name where the SAP tables reside.
sap_user str: Field usage depends on service value: - Service oracle_sap_hva: The Oracle schema name where the SAP tables reside.
sasl_mechanism str: Field usage depends on service value: - Service apache_kafka: SASL Mechanism - Service aws_msk: If security_protocol is set to SASL, enter the SASL Mechanism
sasl_plain_key str: Field usage depends on service value: - Service apache_kafka: API Key
sasl_plain_secret str: Field usage depends on service value: - Service apache_kafka: API Secret
sasl_scram256_key str: Field usage depends on service value: - Service apache_kafka: API Key
sasl_scram256_secret str: Field usage depends on service value: - Service apache_kafka: API Secret
sasl_scram512_key str: Field usage depends on service value: - Service apache_kafka: API Key - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
sasl_scram512_secret str: Field usage depends on service value: - Service apache_kafka: API Secret - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
schema_registry_credentials_source str: Field usage depends on service value: - Service apache_kafka: Schema Registry Credentials source - Service aws_msk: Schema Registry Credentials source - Service confluent_cloud: Schema Registry Credentials source
schema_registry_key str: Field usage depends on service value: - Service apache_kafka: Schema Registry Key - Service aws_msk: Schema Registry Key - Service azure_service_bus: The key used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Key
schema_registry_secret str: Field usage depends on service value: - Service apache_kafka: Schema Registry Secret - Service aws_msk: Schema Registry Secret - Service azure_service_bus: The secret used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Secret
schema_registry_urls Sequence[str]: Field usage depends on service value: - Service apache_kafka: Your schema registry URLs - Service aws_msk: Your schema registry URLs - Service azure_service_bus: The comma-separated list of schema registry servers in the server:port format - Service confluent_cloud: Your schema registry URLs
scope str: Field usage depends on service value: - Service ebay: Your eBay scopes.
scopes str: Field usage depends on service value: - Service cornerstone: Your Cornerstone scopes.
seats Sequence[str]: Field usage depends on service value: - Service yahoo_dsp: Specific Seats to sync. Must be populated if sync_mode_seat is set to SPECIFIC_SEATS.
secret str: Field usage depends on service value: - Service appcues: Your Appcues Secret. - Service buildium: Your Buildium API secret. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure secret. - Service loopio: Your Loopio Secret. - Service mode: Your Mode Secret. - Service playvox_workforce_management: Your Playvox Workforce Management client secret. - Service twilio: The Twilio API secret - Service uservoice: The UserVoice API secret. - Service venminder: Your Venminder secret. - Service vts: Your VTS secret.
secret_key str: Field usage depends on service value: - Service afterpay: Your Afterpay Secret Key. - Service appsflyer: Your AWS secret key. - Service bigquery_db: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service checkr: Your Checkr secret key. - Service ezofficeinventory: Your EZOfficeInventory API secret key. - Service gcs: Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket. - Service ironsource: Your Ironsource Client ID. - Service line_ads: Your LINE Ads secret key. - Service mailjet: Your Mailjet secret key. - Service partnerstack_vendor: Your PartnerStack Vendor Secret key. - Service paypal: Client Secret of your PayPal client application. - Service paypal_sandbox: Client Secret of your PayPal client application. - Service phoenix_ads: Your Phoenix Ads Secret key. - Service retailnext: Your RetailNext secret key. - Service statsig: Your Statsig secret key. - Service yotpo: Your Yotpo Secret key
secrets str: Field usage depends on service value: - Service aws_lambda: The secrets that should be passed to the function at runtime. - Service azure_function: The secrets that should be passed to the function at runtime. - Service google_cloud_function: The secrets that should be passed to the function at runtime.
secrets_lists Sequence[GetConnectorConfigSecretsList]: Field usage depends on service value: - Service aws_lambda: List of Secrets that should be passed to the function at runtime. - Service azure_function: The list of secrets that should be passed to the function at runtime. - Service google_cloud_function: The list of secrets that should be passed to the function at runtime.
security_protocol str: Field usage depends on service value: - Service apache_kafka: Security protocol for Kafka interaction. - Service aws_msk: The security protocol for Kafka interaction. - Service confluent_cloud: Security protocol for Confluent Cloud interaction. - Service heroku_kafka: Security protocol for Heroku Kafka interaction.
segments Sequence[str]: Field usage depends on service value: - Service google_analytics: 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.
selected_event_types Sequence[str]: Field usage depends on service value: - Service salesforce_marketing_cloud: Select the event types to be synced.
selected_exports Sequence[str]: Field usage depends on service value: - Service anaplan: 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.
sender_id str: Field usage depends on service value: - Service sage_intacct: Your Sender ID
sender_password str: Field usage depends on service value: - Service sage_intacct: Your Sender Password
server str: Field usage depends on service value: - Service castor_edc: Your Castor EDC Server.
server_address str: Field usage depends on service value: - Service tableau_source: Your Tableau Source server address.
server_region str: Field usage depends on service value: - Service clockify: Your Clockify server region.
server_url str: Field usage depends on service value: - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence Instance URL. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud Instance URL.
server_variable str: Field usage depends on service value: - Service myosh: Your myosh server variable.
servers Sequence[str]: Field usage depends on service value: - Service apache_kafka: Comma-separated list of Kafka servers in the format server:port. - Service aws_msk: Comma-separated list of Kafka servers in the server:port format. - Service confluent_cloud: Comma-separated list of Confluent Cloud servers in the format server:port. - Service heroku_kafka: Comma-separated list of Heroku Kafka servers in the format server:port.
service_account str: Field usage depends on service value: - Service google_drive: Share the folder with the email address
service_account_email str: Field usage depends on service value: - Service google_cloud_function: Provide Invoker role to this service account.
service_account_key str: Field usage depends on service value: - Service firebase: The contents of your service account key file. Required for authentication.
service_account_secret str: Field usage depends on service value: - Service mixpanel: Service Account Secret
service_account_username str: Field usage depends on service value: - Service mixpanel: Service Account Username
service_authentication str: Field usage depends on service value: - Service dsv: A base64 encoded variant of your username:password string. Required for authentication.
service_name str: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service walmart_marketplace: Your Walmart Marketplace service name.
service_version str
sftp_host str: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP host. - Service salesforce_marketing_cloud: Host
sftp_is_key_pair bool: Field usage depends on service value: - Service adobe_analytics_data_feed: Log in with key pair or password - Service salesforce_marketing_cloud: Set this field if you use a key pair for logging into your SFTP server. Don't set it if you use a username and password
sftp_password str: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP password required if sftp_is_key_pair is false - Service salesforce_marketing_cloud: Password
sftp_port float: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP port. - Service salesforce_marketing_cloud: Port
sftp_public_key str: Field usage depends on service value: - Service adobe_analytics_data_feed: Public Key - Service salesforce_marketing_cloud: Public Key
sftp_user str: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP user. - Service salesforce_marketing_cloud: User
share_url str: Field usage depends on service value: - Service share_point: Your SharePoint folder URL. You can find the folder URL by following the steps mentioned here.
sheet_id str: Field usage depends on service value: - Service google_sheets: 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.
shop str: Field usage depends on service value: - Service shopify: The Shopify shop name. Can be found in the URL before .myshopify.com.
shop_domain str: Field usage depends on service value: - Service triple_whale: Your Triple Whale shop domain.
short_code str: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce eight-character string assigned to a realm for routing purposes.
should_sync_events_with_deleted_profiles bool: Field usage depends on service value: - Service klaviyo: Sync events linked to deleted profiles
show_records_with_no_metrics bool: Field usage depends on service value: - Service apple_search_ads: Turn the toggle on if you want the reports to also return records without metrics.
sid str: Field usage depends on service value: - Service twilio: The Twilio API key SID
signer_public_key str: Field usage depends on service value: - Service azure_blob_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service ftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service gcs: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service s3: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service sftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service wasabi_cloud_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed.
site_address str: Field usage depends on service value: - Service teamwork: Your Teamwork site address.
site_id str: Field usage depends on service value: - Service microsoft_lists: The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the id field in the Graph API response for sites. - Service salesforce_commerce_cloud: The name of the site from which you want to sync data.
site_name str: Field usage depends on service value: - Service microsoft_lists: The Name of the SharePoint site. The Site Name is the name field in the Graph API response for sites. - Service tableau_source: Your Tableau Source site name.
site_urls Sequence[str]: Field usage depends on service value: - Service google_search_console: Specific Site URLs to sync. Must be populated if sync_mode is set to SpecificSites.
skip_after float: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service box: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service dropbox: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service email: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service ftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service gcs: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service google_drive: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination. - Service sftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service share_point: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service wasabi_cloud_storage: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
skip_before float: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified before syncing data. - Service box: We will skip over the number of lines specified before syncing data. - Service dropbox: We will skip over the number of lines specified before syncing data. - Service email: We will skip over the number of lines specified before syncing data. - Service ftp: We will skip over the number of lines specified before syncing data. - Service gcs: We will skip over the number of lines specified before syncing data. - Service google_drive: We will skip over the number of lines specified before syncing data. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified before syncing data. - Service sftp: We will skip over the number of lines specified before syncing data. - Service share_point: We will skip over the number of lines specified before syncing data. - Service wasabi_cloud_storage: We will skip over the number of lines specified before syncing data.
skip_empty_reports bool: Field usage depends on service value: - Service google_ads: Toggles the "Skip empty reports" feature. Enabled by default
snc_certificate str
snc_certificate_source str
snc_fivetran_name str
snc_library_path str: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Path to the external security product's library. - Service hana_sap_hva_s4_netweaver: Path to the external security product's library.
snc_mode str
snc_my_name str
snc_name str: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Client SNC name. - Service hana_sap_hva_s4_netweaver: Client SNC name.
snc_partner_name str: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Communication partner's SNC name. - Service hana_sap_hva_s4_netweaver: Communication partner's SNC name.
snc_source_name str
soap_uri str: Field usage depends on service value: - Service marketo: Marketo SOAP API Endpoint.
social_data_sync_timeframe str: Field usage depends on service value: - Service linkedin_company_pages: The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: SIX .
source str: Field usage depends on service value: - Service adobe_analytics_data_feed: The data source.
store_hash str: Field usage depends on service value: - Service big_commerce: The BigCommerce store hash.
store_id str: Field usage depends on service value: - Service reviewsio: Your REVIEWS.io store ID
sub_domain str: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS subdomain. - Service activecampaign: Your ActiveCampaign sub-domain. - Service acumatica: Your Acumatica subdomain. - Service ada: Your Ada sub-domain. - Service alchemer: Your Alchemer sub-domain. - Service atlassian_jira_align: Your Jira Align base URL. - Service azure_boards: Your Azure Boards Organization Name. - Service azure_devops: Your Azure Organization Name - Service betterworks: Your Betterworks subdomain. - Service bubble: Your Bubble subdomain. - Service buildium: Your Buildium subdomain. - Service canvas_by_instructure: Your Canvas by Instructure domain. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 subdomain. - Service chargebee_product_catalog_2: Your Chargebee subdomain. - Service checkr: Your Checkr subdomain. - Service clubspeed: Your Clubspeed subdomain. - Service collibra: Your collibra subdomain. - Service compliance_checkpoint: Your Compliance Checkpoint subdomain. - Service concord: Your Concord Sub Domain. - Service contrast_security: Your Contrast Security subdomain. - Service customerio: Your Customer.io region-specific Subdomain. - Service dbt_cloud: Your dbt Cloud API server region. - Service deputy: Your Deputy subdomain. - Service docebo: Your Docebo subdomain. - Service drata: Your Drata sub_domain. - Service eventsforce: Your Eventsforce subdomain. - Service ezofficeinventory: Your EZOfficeInventory Subdomain. - Service fountain: Your Fountain subdomain. - Service freshchat: Your Freshchat Sub Domain - Service gainsight_customer_success: The subdomain of your Gainsight account. - Service gainsight_product_experience: Your Gainsight Product Experience subdomain. - Service genesys: Your Genesys subdomain. - Service green_power_monitor: Your GreenPowerMonitor subdomain. - Service infobip: Your Infobip sub_domain. - Service insightly: Your company's Insightly subdomain name. - Service instructure: The Sub domain in which your Instructure account is hosted. - Service jamf: Your Jamf subdomain. - Service kandji: Your Kandji Subdomain. - Service khoros_care: Your Khoros Care subDomain. - Service looker_source: Your looker SubDomain name. - Service lucca: Your Lucca subdomain. - Service mailgun: Your Mailgun subdomain. - Service matomo: Your Matomo subdomain. - Service maxio_chargify: Enter Your Subdomain. - Service myosh: Your myosh subdomain. - Service namely: Your Namely subdomain. - Service nylas: Your Nylas subdomain. - Service okta: Your Okta subdomain. - Service picqer: Your Picqer subdomain. - Service pinpoint: Your Pinpoint sub domain name. - Service piwik_pro: Your Piwik PRO subdomain. - Service playvox: Your Playvox Subdomain. - Service posthog: Your PostHog data region (app or eu). - Service recurly: Your company's Recurly subdomain. - Service reltio: Your Reltio subdomain. - Service revel: Your Revel Systems subDomain. - Service rundeck: Your Rundeck subdomain. - Service sage_hr: Your Sage HR subdomain. - Service salesforce_marketing_cloud: Your Salesforce Marketing Cloud subdomain. - Service salsify: Your Salsify Organization ID. - Service sap_success_factors: Your SAP SuccessFactors Subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service starrez: Your StarRez subdomain - Service sugarcrm: Your SugarCRM subdomain. - Service tableau_source: Your Tableau Source subdomain. - Service tempo: Your Tempo subdomain. - Service testrail: Your TestRail subdomain. - Service thinkific: Your Thinkific subdomain. - Service totango: Your Totango Subdomain. - Service tymeshift: Your Tymeshift subdomain. - Service upland: Your Upland Software subDomain. - Service wordpress: Your WordPress subdomain. - Service workable: Your Workable Subdomain. - Service wrike: Your Wrike Subdomain.
subdomain str: Field usage depends on service value: - Service bamboohr: The subdomain used to access your account. If you access BambooHR at 'https://mycompany.bamboohr.com', then the subdomain is 'mycompany'. - Service datadog: Your Datadog subdomain. - Service ebay: Your eBay environment. - Service freshdesk: Your company's freshdesk subdomain (usually company.freshdesk.com). - Service freshsales: Your Freshsales domain. - Service freshservice: Your company's freshservice subdomain (usually company.freshservice.com). - Service freshsuccess: Your Freshsuccess subdomain. - Service gorgias: Your Gorgias subdomain. - Service jama_software: Your Jama Software subdomain. - Service klarna: Your Klarna subdomain. - Service learnupon: Your Learnupon subdomain. - Service maxio_saasoptics: Your Maxio SaaSOptics subdomain. - Service medallia: Medallia subdomain - Service packiyo: Your Packiyo subdomain. - Service qmatic_data_connect: Your Qmatic Data Connect subdomain. - Service sana: Your Sana subdomain. - Service skillstx: Your SkillsTX subdomain. - Service smarthr: Your SmartHR subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service toast: Your Toast domain. - Service vts: Your VTS Subdomain. - Service zendesk_chat: Your Zendesk domain.
subscriber_name str: Field usage depends on service value: - Service azure_service_bus: 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
subscription str: Field usage depends on service value: - Service retailnext: Your RetailNext subscription.
subscription_key str: Field usage depends on service value: - Service dsv: Your DSV subscription key.
support_connected_accounts_sync bool: Field usage depends on service value: - Service stripe: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts. - Service stripe_test: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.
support_nested_columns bool: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
survey_ids str: Field usage depends on service value: - Service qualaroo: Array of Qualaroo Survey IDs.
swipe_attribution_window str: Field usage depends on service value: - Service snapchat_ads: The time period to attribute conversions based on swipes. Default value: DAY_28
sync_data_locker bool: Field usage depends on service value: - Service appsflyer: Sync AppsFlyer Data Locker. Default value is true, set it to false to sync AppsFlyer data using only webhooks.
sync_format str: Field usage depends on service value: - Service webhooks: The webhooks sync format. Default value: Unpacked. Unpacked messages must be valid JSON.
sync_formula_fields bool: Field usage depends on service value: - Service financial_force: Enable this option to sync formula fields directly (default value = false) - Service salesforce: Enable this option to sync formula fields directly (default value = false) - Service salesforce_sandbox: Enable this option to sync formula fields directly (default value = false)
sync_metadata bool: Field usage depends on service value: - Service facebook_ads: Parameter defining whether to enable or disable metadata synchronisation. Default value: TRUE.
sync_method str: Field usage depends on service value: - Service aws_lambda: Sync Method
sync_mode str: Field usage depends on service value: - Service adroll: Whether to sync all advertisables or specific advertisables. Default value: AllAdvertisables. - Service amazon_ads: Option to select connector should sync all profiles or specific profiles. - Service anaplan: Whether to sync all exports or specific exports. - Service apple_search_ads: Sync Mode - Service asana: Whether to sync all projects or specific projects. - Service bingads: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service double_click_campaign_manager: Whether to sync all user profiles or specific ones. Default value: AllAccounts. - Service dynamodb: Which packed mode setting to use. Default value: UsePackedModeOnly. - Service facebook: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_ad_account: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service facebook_ads: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_pages: Whether to sync all accounts or specific accounts. Default value: AllPages. - Service github: Whether to sync all repositories or specific repositories. - Service google_ads: Whether to sync all accounts or specific accounts. - Service google_analytics: Whether to sync all accounts or specific accounts. - Service google_analytics_4: Whether to sync all accounts or specific accounts. - Service google_analytics_mcf: Whether to sync all accounts or specific accounts. Default value: ALL_ACCOUNTS - Service google_search_console: Whether to sync all sites or specific sites. - Service instagram_business: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service iterable: Events Sync Mode. - Service jira: Whether to sync all projects or specific projects. - Service linkedin_ads: Whether to sync all accounts or specific accounts. Default value: AllAccounts - Service pendo: Whether to sync all App IDs or specific App IDs. Default value: AllAppIds. - Service pinterest_ads: Whether to sync all advertisers or specific advertisers. - Service reddit_ads: Whether to sync all accounts or specific accounts. - Service salesforce_marketing_cloud: Select the sync mode. - Service snapchat_ads: Whether to sync all organizations or specific organizations. Default value: AllOrganizations. - Service spotify_ads: Whether to sync all ad accounts or specific ad accounts. - Service taboola: Whether to sync all accounts or specific accounts. - Service the_trade_desk: Whether to sync all accounts or specific accounts. - Service tiktok_ads: Whether to sync all advertiser accounts or specific accounts. - Service twilio: Whether to sync all accounts or specific accounts. - Service twitter: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service twitter_ads: Whether to sync all accounts or specific accounts. - Service walmart_dsp: Whether to sync all accounts or specific accounts. - Service yahoo_gemini: Whether to sync all accounts or specific accounts. Default value: SpecificAccounts. - Service zuora: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both. - Service zuora_sandbox: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both.
sync_mode_advertiser str: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all advertisers or specific advertisers. Default value: ALL_ADVERTISERS.
sync_mode_seat str: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all seats or specific seats. Default value: ALL_SEATS.
sync_multiple_accounts bool: Field usage depends on service value: - Service reddit_ads: 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
sync_pack_mode str: Field usage depends on service value: - Service cosmos: 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 Azure Cosmos DB Sync Pack Mode Options documentation. - Service documentdb: Indicates whether synced data will be packed into a single entry(column), or unpacked with one layer of nested fields.
sync_pull_api bool: Field usage depends on service value: - Service appsflyer: These options are for Appsflyer's Pull API, and are only necessary for syncing events from Pull API.
sync_type str: Field usage depends on service value: - Service apache_kafka: Kafka sync type. Unpacked messages must be valid JSON. - Service aws_msk: The sync type. Unpacked messages must be valid JSON. - Service azure_event_hub: Sync type. Unpacked messages must be valid JSON. - Service azure_service_bus: 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 - Service confluent_cloud: Kafka sync type. Unpacked messages must be valid JSON. - Service heroku_kafka: Heroku Kafka sync type. Unpacked messages must be valid JSON. - Service segment: The Segment connector sync type.
sysnr str
system_id str: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
table_id str: Field usage depends on service value: - Service pigment: Your Pigment table ID.
table_name str: Field usage depends on service value: - Service airtable: Name of table in Airtable
tables_without_access_updated_at str: Field usage depends on service value: - Service hubspot: Timestamp to indicate when tables without access was updated
target_entity_id str: Field usage depends on service value: - Service culture_amp: Your Culture Amp Target entity ID.
target_host str: Field usage depends on service value: - Service d2l_brightspace: Your D2L Brightspace target host.
tde_certificate str: Field usage depends on service value: - Service sql_server_hva: Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Certificate used to protect a database encryption key
tde_certificate_name str: Field usage depends on service value: - Service sql_server_hva: Name of the Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Name of the Certificate used to protect a database encryption key
tde_password str: Field usage depends on service value: - Service sql_server_hva: Password of the TDE private key - Service sql_server_sap_ecc_hva: Password of the TDE private key
tde_private_key str: Field usage depends on service value: - Service sql_server_hva: Private key associated with the TDE certificate - Service sql_server_sap_ecc_hva: Private key associated with the TDE certificate
team_id str: Field usage depends on service value: - Service asana: Team ID
technical_account_id str: Field usage depends on service value: - Service adobe_analytics: Technical Account ID from the Service Account (JWT) credentials of your Adobe Project.
template_labels Sequence[str]: Field usage depends on service value: - Service mandrill: Provide the labels to filter the templates
tenant str: Field usage depends on service value: - Service microsoft_entra_id: Your Microsoft Entra ID Tenant. - Service microsoft_power_bi: Your Microsoft Power BI tenant. - Service microsoft_teams: Your Microsoft Teams Tenant. - Service unicommerce: Your uniware tenant. - Service workday: Workday tenant name - Service workday_financial_management: Workday tenant name - Service workday_hcm: Workday tenant name
tenant_app_url str: Field usage depends on service value: - Service planful: Your Planful tenant app URL.
tenant_code str: Field usage depends on service value: - Service deposco: Your Deposco tenant code.
tenant_configs Sequence[GetConnectorConfigTenantConfig]: Field usage depends on service value: - Service reltio: * tenant(s)
tenant_id str: Field usage depends on service value: - Service azure_sql_db: Azure AD tenant ID. - Service azure_sql_managed_db: Azure AD tenant ID. - Service business_central: Tenant ID of your Business Central application - Service crowddev: Your crowd.dev Tenant ID. - Service reltio: Your Reltio tenant ID. - Service servicetitan: Your ServiceTitan tenant ID. - Service visma: Your Visma tenant ID.
tenant_name str: Field usage depends on service value: - Service mambu: Your Mambu tenant name.
tenant_url str: Field usage depends on service value: - Service ivanti: Your Ivanti Tenant URL. - Service playvox_workforce_management: Your Playvox Workforce Management tenant URL. - Service reltio: Your Reltio tenant URL.
test_table_name str: Field usage depends on service value: - Service sap_hana: testTableName - Service sap_s4hana: testTableName
time_zone str: Field usage depends on service value: - Service pardot: The time zone configured in your Pardot instance. An empty value defaults to UTC+00:00.
timeframe_months str: Field usage depends on service value: - Service adobe_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector has been created. Default value: TWELVE . - Service adroll: 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. - Service apple_search_ads: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service bingads: 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. - Service criteo: 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. NOTE: The greater number of months means the initial sync will take more time. - Service double_click_campaign_manager: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service double_click_publishers: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service facebook: 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. - Service facebook_ads: 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. - Service google_ads: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: TWELVE. - Service google_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_4: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_mcf: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service google_display_and_video_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service google_search_ads_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service google_search_console: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service instagram_business: 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. - Service itunes_connect: Historical sync time frame in months. - Service linkedin_ads: 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. - Service outbrain: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service pinterest_ads: 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. - Service reddit_ads: 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. - Service snapchat_ads: 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. - Service spotify_ads: 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: SIX. - Service taboola: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service the_trade_desk: 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. - Service tiktok_ads: 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. - Service twitter: 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. - Service twitter_ads: Historical sync timeframe in months. - Service walmart_dsp: 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. - Service yahoo_dsp: Number of monthsworth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value:THREE. - Service yahoo_gemini: 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`.
timezone str: Field usage depends on service value: - Service rokt: Your Rokt timezone.
timezone_mode str: Field usage depends on service value: - Service apple_search_ads: Determines whether to use UTC or the users timezone from the apple account
tns str: Field usage depends on service value: - Service oracle_hva: Single-tenant database: The database's SID. Multi-tenant database: The database's TNS. - Service oracle_sap_hva: Single-tenant database: The database SID. Multi-tenant database: The database TNS.
toast_id str: Field usage depends on service value: - Service toast: Your Toast Restaurant External ID.
token str: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities token. - Service matomo: Your Matomo auth token. - Service mode: Your Mode Token. - Service oracle_moat_analytics: Your Oracle Moat Analytics Token. - Service shareasale: Your ShareASale token. - Service solarwinds_service_desk: Your SolarWinds Service Desk token.
token_authenticated_container str: Field usage depends on service value: - Service cosmos: The container name. Required for the RESOURCE_TOKEN data access method.
token_authenticated_database str: Field usage depends on service value: - Service cosmos: The database name. Required for the RESOURCE_TOKEN data access method.
token_id str: Field usage depends on service value: - Service chargedesk: Your ChargeDesk token ID. - Service mux: Your Mux token ID
token_key str: Field usage depends on service value: - Service netsuite_suiteanalytics: Token ID - Service on24: Your ON24 token key. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Token Key.
token_secret str: Field usage depends on service value: - Service netsuite_suiteanalytics: Token Secret - Service on24: Your ON24 token secret.
token_secret_key str: Field usage depends on service value: - Service mux: Your Mux token secret key
token_url_region str: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP token URL region.
topics Sequence[str]: Field usage depends on service value: - Service azure_service_bus: The comma-separated list of topics which should be synced. Required if you do not have manage permissions
trust_store_type str: Field usage depends on service value: - Service heroku_kafka: Trust Store Type
trusted_cert str: Field usage depends on service value: - Service apache_kafka: Kafka trusted certificate. - Service heroku_kafka: Heroku Kafka trusted certificate. Required for TLS security protocol.
truststore str: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Truststore File as Base64 encoded string.
tunnel_host str: Field usage depends on service value: - Service aurora: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service aurora_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_cosmos_for_mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_managed_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service clarity: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service cockroachdb: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service db2i_hva: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service db2i_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service documentdb: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service dynamics_365_fo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service ehr: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service elastic_cloud: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service es_self_hosted: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service google_cloud_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_postgresql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_sqlserver: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_b1: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service heroku_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo_sharded: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service opendistro: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service opensearch: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service oracle: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_ebs: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rac: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_s4hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sftp: Tunnel host address, specify only to connect via SSH tunnel. - Service sql_server: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_sap_ecc_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
tunnel_port float: Field usage depends on service value: - Service aurora: SSH port, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH port, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH port, specify only to connect via an SSH tunnel. - Service clarity: SSH port, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH port, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service documentdb: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH port, specify only to connect via an SSH tunnel. - Service ehr: SSH port, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH port, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH port, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH port, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service maria: SSH port, specify only to connect via an SSH tunnel. - Service maria_azure: SSH port, specify only to connect via an SSH tunnel. - Service maria_rds: SSH port, specify only to connect via an SSH tunnel. - Service mongo: SSH port, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH port, specify only to connect via an SSH tunnel. - Service mysql: SSH port, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH port, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service opendistro: SSH port, specify only to connect using an SSH tunnel. - Service opensearch: SSH port, specify only to connect using an SSH tunnel. - Service oracle: SSH port, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH port, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service postgres: SSH port, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH port, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH port, specify only to connect via an SSH tunnel. - Service sftp: Tunnel port, specify only to connect via SSH tunnel. - Service sql_server: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH port, specify only to connect via an SSH tunnel.
tunnel_user str: Field usage depends on service value: - Service aurora: SSH user, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH user, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH user, specify only to connect via an SSH tunnel. - Service clarity: SSH user, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH user, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service documentdb: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH user, specify only to connect via an SSH tunnel. - Service ehr: SSH user, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH user, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH user, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH user, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service maria: SSH user, specify only to connect via an SSH tunnel. - Service maria_azure: SSH user, specify only to connect via an SSH tunnel. - Service maria_rds: SSH user, specify only to connect via an SSH tunnel. - Service mongo: SSH user, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH user, specify only to connect via an SSH tunnel. - Service mysql: SSH user, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH user, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service opendistro: SSH user, specify only to connect using an SSH tunnel. - Service opensearch: SSH user, specify only to connect using an SSH tunnel. - Service oracle: SSH user, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH user, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service postgres: SSH user, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH user, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH user, specify only to connect via an SSH tunnel. - Service sftp: Tunnel user, specify only to connect via SSH tunnel. - Service sql_server: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH user, specify only to connect via an SSH tunnel.
type_name str: Field usage depends on service value: - Service akamai: Your Akamai type name. - Service bubble: Your Bubble type name.
unique_id str
update_config_on_each_sync bool: Field usage depends on service value: - Service google_display_and_video_360: 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.
update_method str: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service azure_postgres: 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. - Service azure_sql_db: (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. - Service azure_sql_managed_db: (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. - Service clarity: (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. - Service dynamics_365_fo: Update Method - Service ehr: (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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: (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. - Service heroku_postgres: 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. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Default value: Teleport - Service snowflake_db: Default value: Teleport - Service sql_server: (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. - Service sql_server_hva: (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. - Service sql_server_rds: (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. - Service sql_server_sap_ecc_hva: (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.
uri str: Field usage depends on service value: - Service cosmos: Cosmos resource instance address.
url_format str: Field usage depends on service value: - Service fountain: Your Fountain URL format.
use_api_keys bool: Field usage depends on service value: - Service mandrill: Whether to use multiple API keys for interaction.
use_customer_bucket bool: Field usage depends on service value: - Service appsflyer: Use Custom Bucket. Set it to 'true' if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket.
use_oracle_rac bool: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using a RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you're using a RAC instance.
use_pgp_encryption_options bool: Field usage depends on service value: - Service azure_blob_storage: Set to true if files present in the Azure Blob Storage container are encrypted using PGP. Default value: false. - Service ftp: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service gcs: Set to true if files are encrypted using PGP in the GCS bucket. Default value: false. - Service s3: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service sftp: Set to true if files present in SFTP server are encrypted using PGP. Default value: false. - Service wasabi_cloud_storage: Set to true if files are encrypted using PGP in the Wasabi Cloud Storage bucket. Default value: false.
use_service_account bool: Field usage depends on service value: - Service bigquery_db: BigQuery use service account; default is false
use_template_labels bool: Field usage depends on service value: - Service mandrill: Use template labels to filter templates for sync
use_webhooks bool: Field usage depends on service value: - Service github: Set to true to capture deletes. - Service xero: Updates to few fields like sent_to_contact in Invoice table might be missed if you don't enable this.
use_workspace bool: Field usage depends on service value: - Service bigquery_db: Create and drop tables in a query results dataset. Default is false - Service snowflake_db: Choose a database and schema to create temporary tables for syncs.
user str: Field usage depends on service value: - Service aurora: The user name. - Service aurora_postgres: The user name. - Service azure_cosmos_for_mongo: Username for source database access. - Service azure_postgres: The user name. - Service azure_sql_db: The user name. For Azure Databases, the format must be user@domain. - Service azure_sql_managed_db: The user name. For Azure Databases, the format must be user@domain. - Service clarity: The user name. For Azure Databases, the format must be user@domain. - Service cockroachdb: The user name. - Service db2i_hva: The user name. - Service db2i_sap_hva: The username. - Service documentdb: The user name. - Service dynamics_365_fo: The user name. The format must be user@domain. - Service ehr: The user name. For Azure Databases, the format must be user@domain. - Service elastic_cloud: The user name. - Service es_self_hosted: The user name. - Service ftp: FTP user. - Service google_cloud_mysql: The user name. - Service google_cloud_postgresql: The user name. - Service google_cloud_sqlserver: The user name. For Azure Databases, the format must be user@domain. - Service hana_sap_hva_b1: The username. - Service hana_sap_hva_ecc: The username. - Service hana_sap_hva_ecc_netweaver: The username. - Service hana_sap_hva_s4: The username. - Service hana_sap_hva_s4_netweaver: The username. - Service heroku_postgres: The user name. - Service jira: The Jira username. - Service magento_mysql: The user name. - Service magento_mysql_rds: The user name. - Service maria: The user name. - Service maria_azure: The user name. - Service maria_rds: The user name. - Service marin: The Marin username. - Service mongo: The user name. - Service mongo_sharded: The user name. - Service mysql: The user name. - Service mysql_azure: The user name. - Service mysql_rds: The user name. - Service opendistro: The user name. - Service opensearch: The user name. - Service oracle: The user name. - Service oracle_ebs: The user name. - Service oracle_hva: The user name. - Service oracle_rac: The user name. - Service oracle_rds: The user name. - Service oracle_sap_hva: The username. - Service oracle_sap_hva_netweaver: The username. - Service outbrain: The username or email of the Outbrain user. - Service postgres: The user name. - Service postgres_rds: The user name. - Service redshift_db: The Redshift username. - Service sap_hana: Your SAP HANA user name. - Service sap_s4hana: Your SAP S/4 user name. - Service sftp: SFTP user. - Service snowflake_db: The Snowflake username. - Service splunk: The Splunk username. - Service sql_server: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_hva: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_rds: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_sap_ecc_hva: The user name. For Azure Databases, the format must be user@domain.
user_id str: Field usage depends on service value: - Service coassemble: Your Coassemble user ID. - Service gmail: Your Gmail user ID. - Service hibob: Your HiBob Service User Token. - Service marketo: Marketo SOAP API User Id. - Service okendo: Your Okendo user ID. - Service playvox: Your Playvox User ID. - Service sage_intacct: User ID - Service vimeo: Your Vimeo user ID.
user_key str
user_name str: Field usage depends on service value: - Service workday: Workday username.
user_profiles Sequence[str]: Field usage depends on service value: - Service double_click_campaign_manager: IDs of specific User Profiles to sync. Must be populated if sync_mode is set to SpecificAccounts.
user_token str: Field usage depends on service value: - Service hibob: Your HiBob Service User ID. - Service konnect_insights: Your Konnect Insights User Token. - Service sonarqube: Your Sonarqube user token.
username str: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS username. - Service adobe_commerce: Your Adobe Commerce username. - Service akeneo: Your Akeneo username. - Service anaplan: Your Anaplan user ID. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Username. - Service aveva_pi: Username for the user to authenticate as with the AF Server - Service ceridian_dayforce: Your Ceridian Dayforce Username. - Service churnzero: Your ChurnZero username. - Service cin7: Your Cin7 API Username. - Service collibra: Your collibra username. - Service compliance_checkpoint: Your Compliance Checkpoint account username. - Service concur: The SAP Concur username. - Service confluence: Your Confluence username. - Service contrast_security: Your Contrast Security API Username. - Service dcl_logistics: Your DCL Logistics username. - Service deposco: Your Deposco username. - Service github: Login of your GitHub profile. - Service gladly: Your Gladly Username. - Service globalmeet: Your GlobalMeet Username. - Service gorgias: Your Gorgias username. - Service green_power_monitor: Your GreenPowerMonitor username. - Service guru: Your Guru username. - Service hilti_ontrack: Your Hilti On!Track username. - Service impact: Your Impact Account SID - Service integral_ad_science: Your integral_ad_science username. - Service itunes_connect: Your Apple ID - Service jamf: Your Jamf username. - Service khoros_care: Your Khoros Care username. - Service kissmetrics: Your Kissmetrics API Username. - Service klarna: Your Klarna Username. - Service learnupon: Your Learnupon username. - Service lessonly: Your Lessonly username. - Service mailgun: Your Mailgun API username. - Service myosh: Your myosh username. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence username. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud username. - Service partnerize: Your Partnerize account's username. - Service pingdom: Your Pingdom Username. - Service podio: Your Podio account username. - Service qmatic_data_connect: Your Qmatic Data Connect username. - Service quorum: Your Quorum username . - Service revx: Your RevX Username. - Service rtb_house: Your RTB House username. - Service sap_business_by_design: The SAP Business ByDesign username. - Service scorm: Your Scorm App ID. - Service servicenow: Your ServiceNow User ID (username). - Service shiphero: Your ShipHero username. - Service shipstation: Your ShipStation username. - Service shopware: Your Shopware username. - Service splash: Your Splash username. - Service starrez: Your StarRez API username - Service stickyio: Your sticky.io username . - Service stylight: Your Stylight Username. - Service sugarcrm: Your SugarCRM username. - Service teamwork: Your Teamwork username. - Service testrail: Your TestRail username. - Service ukg_pro: Your UKG Pro username. - Service unicommerce: Your uniware login username. - Service upland: Your Upland Software Username. - Service veevavault: Your Veeva Vault username. - Service when_i_work: Your When I Work username. - Service wherefour: Your Wherefour username. - Service workday_financial_management: Workday username. - Service workday_hcm: Username of your Workday Integration System User account - Service xandr: Your Xandr username. - Service younium: Your Younium username.
version str: Field usage depends on service value: - Service criteo_retail_media: Your Criteo Retail Media version.
view_attribution_window str: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on views. Possible view_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'view' action. - Service snapchat_ads: The time period to attribute conversions based on views. Default value: DAY_1
view_id str: Field usage depends on service value: - Service pigment: Your Pigment view ID.
view_through_attribution_window_size str: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on views. Default value: DAY_7
web_service_api_key str: Field usage depends on service value: - Service adyen: Your Adyen Web Service API key.
webhook_endpoint str: Field usage depends on service value: - Service appsflyer: Webhook Url
webhook_key str: Field usage depends on service value: - Service xero: Webhook Key
webhook_url str: Field usage depends on service value: - Service branch: Webhook URL - Service pipedrive: The registered URL for webhooks in your Pipedrive dashboard. - Service segment: Webhook URL. - Service xero: (ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO.
word_press_site_id_or_woocommerce_domain_name str: Field usage depends on service value: - Service woocommerce: The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance.
workplace_id str: Field usage depends on service value: - Service moloco: Your Moloco workplace ID.
workspace str: Field usage depends on service value: - Service mode: Your Mode Workspace.
workspace_name str: Field usage depends on service value: - Service bigquery_db: Workspace Dataset Name - Service snowflake_db: The name of the database where the temporary tables will be created.
workspace_same_as_source bool: Field usage depends on service value: - Service bigquery_db: Use the source dataset as the workspace dataset
workspace_schema str: Field usage depends on service value: - Service snowflake_db: The name of the schema that belongs to the workspace database where the temporary tables will be created.
ws_certificate str: Field usage depends on service value: - Service adp_workforce_now: Web Services Certificate.
x_api_key str: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X API key.
x_key str: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research key.
x_master_key str: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research master key.
x_user_email str: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Email.
x_user_token str: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Token.

absConnectionMethod String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection method
absConnectionString String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage connection string. - Service braze: Connection String
absContainerAddress String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container address
absContainerName String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage container name. - Service braze: Container Name
absHostIp String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage host IP
absHostUser String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage username
absPrefix String: Field usage depends on service value: - Service braze: Prefix
absPublicKey String: Field usage depends on service value: - Service adobe_analytics_data_feed: Azure Blob Storage public key
academyId String: Field usage depends on service value: - Service workramp: Your WorkRamp academy ID.
accessId String: Field usage depends on service value: - Service planful: Your Planful access ID.
accessKey String: Field usage depends on service value: - Service gainsight_customer_success: The access key for API authentication. - Service gongio: Your Gongio Access key. - Service line_ads: Your LINE Ads access key. - Service planful: Your Planful access key. - Service retailnext: Your RetailNext access key.
accessKeyId String: Field usage depends on service value: - Service appsflyer: Your AWS access key ID. - Service aws_cost_report: Access Key ID - Service checkout: Your Checkout.com access key ID. - Service cloudtalk: Your CloudTalk Access Key ID. - Service nice: Your NICE access key ID. - Service s3: Access Key ID - Service wasabi_cloud_storage: Access Key ID
accessKeySecret String: Field usage depends on service value: - Service aws_cost_report: Access Key Secret - Service checkout: Your Checkout.com access key secret. - Service cloudtalk: Your CloudTalk Access Key Secret. - Service gongio: Your Gongio Access Key Secret. - Service nice: Your NICE access key secret. - Service s3: Access Key Secret - Service wasabi_cloud_storage: Access Key Secret
accessToken String: Field usage depends on service value: - Service 7shifts: Your 7shifts access token. - Service attio: Your Attio bearer token - Service big_commerce: API access token of your store. - Service bitly: Your Bitly access token. - Service calabrio: Your Calabrio access token. - Service coupa: Your Coupa access token fetched using client_id and client_secret - Service deputy: Your Deputy API access token. - Service getfeedback: Your GetFeedback Access token. - Service gocardless: Your GoCardless API token. - Service ironclad: Your Ironclad access token. - Service khoros_marketing: Your Khoros Marketing access token. - Service kustomer: Your Kustomer API key. - Service lattice: Your Lattice API access token. - Service launchdarkly: Your LaunchDarkly access token. - Service leap_crm: Your Leap CRM access token. - Service nylas: Your Nylas access_token. - Service planhat: Your Planhat access token. - Service rollbar: Your Rollbar Access Token. - Service samsara: Your Samsara API token. - Service slab: Your Slab API key. - Service stripe: The Stripe API Restricted Key - Service stripe_test: The Stripe API Restricted Key - Service talkwalker: Your Talkwalker access token. - Service workable: Your Workable Access Token. - Service workramp: Your WorkRamp access token.
accessType String: Field usage depends on service value: - Service share_point: Access Type
account String: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Account ID. - Service ordway: Your Ordway account type.
accountAccessToken String: Field usage depends on service value: - Service rollbar: Your Rollbar account access token.
accountId String: Field usage depends on service value: - Service appcues: Your Appcues Account ID. - Service brightcove: Your Brightcove account ID. - Service cin7core: Your Cin7 Core account ID. - Service dear: Your Dear Account ID. - Service harvest: Your Harvest Account ID. - Service optimizely: Your Optimizely account ID. - Service rokt: Your Rokt account ID. - Service udemy_business: Your Udemy Business account ID.
accountIds List<String>: Field usage depends on service value: - Service taboola: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
accountKey String: Field usage depends on service value: - Service cosmos: The read-only primary or secondary account key for the database account. Required for the ACCOUNT_KEY data access method. - Service simplesat: Your Simplesat account key.
accountName String: Field usage depends on service value: - Service eventsforce: Your Eventsforce account name. - Service freshdesk_contact_center: Your Freshdesk Contact Center account name. - Service happyfox: Your HappyFox account name. - Service maxio_saasoptics: Your Maxio SaaSOptics account name. - Service talkdesk: Your Talkdesk Account Name. - Service udemy_business: Your Udemy Business account name.
accountPlan String: Field usage depends on service value: - Service tymeshift: Your Tymeshift account plan.
accountRegion String: Field usage depends on service value: - Service iterable: If your Iterable account URL starts with https://app.eu.iterable.com then provide EU else US
accountSid String: Field usage depends on service value: - Service fone_dynamics: Your Fone Dynamics account SID.
accountSyncMode String: Field usage depends on service value: - Service itunes_connect: Account Sync Mode
accountToken String: Field usage depends on service value: - Service konnect_insights: Your Konnect Insights Account Token.
accountType String: Field usage depends on service value: - Service freightview: Your Freightview Account Type.
accounts List<String>: Field usage depends on service value: - Service bingads: Specific accounts to sync. Must be populated if syncMode is set to SpecificAccounts. - Service facebook: List of accounts of which connector will sync the data. - Service facebook_ad_account: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service facebook_ads: List of accounts of which connector will sync the data. - Service google_ads: The list of Account IDs to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service google_analytics: The list of specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_4: The list of specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_analytics_mcf: Specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service google_search_ads_360: Specific accounts to sync. Must be populated if accountsSyncMode is set to SPECIFIC_ACCOUNTS. - Service instagram_business: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service itunes_connect: Accounts - Service linkedin_ads: Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service spotify_ads: The list of Ad Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. - Service tiktok_ads: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twilio: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter: Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. - Service twitter_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
accountsRedditAds List<Property Map>: Field usage depends on service value: - Service reddit_ads: Accounts
accountsSyncMode String: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all accounts or specific.
actionBreakdowns List<String>: Field usage depends on service value: - Service facebook: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
actionReportTime String: Field usage depends on service value: - Service facebook: The report time of action stats. Possible action_report time values.
adAnalytics String: Field usage depends on service value: - Service linkedin_ads: Whether to sync all analytic reports or specific. Default value: AllReports
adUnitView String: Field usage depends on service value: - Service double_click_publishers: Ad unit view for the report.
adminApiKey String: Field usage depends on service value: - Service splitio: Your Split admin api key.
adobeAnalyticsConfigurations List<Property Map>: Field usage depends on service value: - Service adobe_analytics: 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.
advertisables List<String>: Field usage depends on service value: - Service adroll: Specific advertisables to sync. Must be populated if sync_mode is set to SpecificAdvertisables.
advertisers List<String>: Field usage depends on service value: - Service google_display_and_video_360: The list of advertisers to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service google_search_ads_360: Specific advertisers to sync. Must be populated if advertisersSyncMode is set to SPECIFIC_ADVERTISERS. - Service pinterest_ads: Specific Advertisers to sync. Must be populated if sync_mode is set to SpecificAdvertisers.
advertisersIds List<String>: Field usage depends on service value: - Service yahoo_gemini: Specific Advertiser IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
advertisersSyncMode String: Field usage depends on service value: - Service google_search_ads_360: Whether to sync all or specific advertisers.
advertisersWithSeats List<String>: Field usage depends on service value: - Service yahoo_dsp: Specific Advertisers to sync. Must be populated if sync_mode_advertiser is set to SPECIFIC_ADVERTISERS. Pay attention to the format: AdvertiserId:SeatId
agentConfigMethod String
agentHost String: Field usage depends on service value: - Service db2i_hva: The agent host. - Service db2i_sap_hva: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service oracle_hva: The host of the agent. This is the same as database host, since the agent must be installed in the same machine as source database. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service sql_server_hva: The host address of the machine running the agent. Often the same as the DB host. - Service sql_server_sap_ecc_hva: The host address of the machine running the agent. Often the same as the DB host.
agentId String: Field usage depends on service value: - Service phoenix_ads: Your Phoenix Ads Agent ID.
agentOraHome String: Field usage depends on service value: - Service oracle_hva: The home directory of the Oracle database. - Service oracle_sap_hva: The home directory of the Oracle database.
agentPassword String: Field usage depends on service value: - Service db2i_hva: The agent password. - Service db2i_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_b1: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_ecc_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4: The agent user's password. It must have a minimum length of 10 characters. - Service hana_sap_hva_s4_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_hva: The agent user's password. It should have a minimum length of 10 characters. - Service oracle_sap_hva: The agent user's password. It must have a minimum length of 10 characters. - Service oracle_sap_hva_netweaver: The agent user's password. It must have a minimum length of 10 characters. - Service sql_server_hva: The password for the agent user. - Service sql_server_sap_ecc_hva: The password for the agent user.
agentPort Number: Field usage depends on service value: - Service db2i_hva: The agent port. - Service db2i_sap_hva: The port number of the agent. - Service hana_sap_hva_b1: The port number of the agent. - Service hana_sap_hva_ecc: The port number of the agent. - Service hana_sap_hva_ecc_netweaver: The port number of the agent. - Service hana_sap_hva_s4: The port number of the agent. - Service hana_sap_hva_s4_netweaver: The port number of the agent. - Service oracle_hva: The port number of the agent. - Service oracle_sap_hva: The port number of the agent. - Service oracle_sap_hva_netweaver: The port number of the agent. - Service sql_server_hva: The port that the agent has open for Fivetran's connection. Default value is 4343. - Service sql_server_sap_ecc_hva: The port that the agent has open for Fivetran's connection. Default value is 4343.
agentPublicCert String: Field usage depends on service value: - Service db2i_hva: The public certificate for the agent. - Service db2i_sap_hva: The agent public certificate. - Service hana_sap_hva_b1: The agent public certificate. - Service hana_sap_hva_ecc: The agent public certificate. - Service hana_sap_hva_ecc_netweaver: The agent public certificate. - Service hana_sap_hva_s4: The agent public certificate. - Service hana_sap_hva_s4_netweaver: The agent public certificate. - Service oracle_hva: The agent public certificate. - Service oracle_sap_hva: The agent public certificate. - Service oracle_sap_hva_netweaver: The agent public certificate. - Service sql_server_hva: The public certificate generated by the agent. - Service sql_server_sap_ecc_hva: The public certificate generated by the agent.
agentUser String: Field usage depends on service value: - Service db2i_hva: The agent user name. - Service db2i_sap_hva: The agent's user. - Service hana_sap_hva_b1: The agent's user. - Service hana_sap_hva_ecc: The agent's user. - Service hana_sap_hva_ecc_netweaver: The agent's user. - Service hana_sap_hva_s4: The agent's user. - Service hana_sap_hva_s4_netweaver: The agent's user. - Service oracle_hva: The agent's user. - Service oracle_sap_hva: The agent's user. - Service oracle_sap_hva_netweaver: The agent's user. - Service sql_server_hva: The agent's username. - Service sql_server_sap_ecc_hva: The agent's username.
aggregation String: Field usage depends on service value: - Service facebook: Options to select aggregation duration. Possible aggregation values.
agreementGrantToken String: Field usage depends on service value: - Service economic: Your E-conomic X-AgreementGrantToken goes here.
alwaysEncrypted Boolean: Field usage depends on service value: - Service aurora: Require TLS through Tunnel - Service aurora_postgres: Require TLS through Tunnel - Service azure_cosmos_for_mongo: Require TLS - Service azure_postgres: Require TLS through Tunnel - Service azure_sql_db: Require TLS through Tunnel. - Service azure_sql_managed_db: Require TLS. - Service clarity: Require TLS through Tunnel. - Service cockroachdb: Require TLS - Service db2i_hva: Require TLS through Tunnel - Service db2i_sap_hva: Require TLS through Tunnel - Service documentdb: Require TLS encryption. - Service dynamics_365_fo: Require TLS through Tunnel. - Service ehr: Require TLS through Tunnel. - Service elastic_cloud: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service es_self_hosted: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service google_cloud_mysql: Require TLS through Tunnel - Service google_cloud_postgresql: Require TLS through Tunnel - Service google_cloud_sqlserver: Require TLS. - Service heroku_postgres: Require TLS through Tunnel - Service magento_mysql: Require TLS through Tunnel - Service magento_mysql_rds: Require TLS through Tunnel - Service maria: Require TLS through Tunnel - Service maria_azure: Require TLS through Tunnel - Service maria_rds: Require TLS through Tunnel - Service mongo: Require TLS - Service mongo_sharded: Require TLS through Tunnel - Service mysql: Require TLS through Tunnel - Service mysql_azure: Require TLS through Tunnel - Service mysql_rds: Require TLS through Tunnel - Service opendistro: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service opensearch: Default value: true. Set to false if TLS is not required when using an SSH tunnel. - Service oracle: Require TLS through Tunnel - Service oracle_ebs: Require TLS through Tunnel - Service oracle_hva: Require TLS through Tunnel - Service oracle_rac: Require TLS through Tunnel - Service oracle_rds: Require TLS through Tunnel - Service oracle_sap_hva: Require TLS through Tunnel - Service oracle_sap_hva_netweaver: Require TLS. - Service postgres: Require TLS through Tunnel - Service postgres_rds: Require TLS through Tunnel - Service sql_server: Require TLS. - Service sql_server_hva: Require TLS. - Service sql_server_rds: Require TLS. - Service sql_server_sap_ecc_hva: Require TLS.
api String: Field usage depends on service value: - Service freshsuccess: Set this parameter to api.
apiAccessToken String: Field usage depends on service value: - Service flywheel_digital: Your Flywheel Digital API access token. - Service shopify: API access token of your custom app. - Service square: The Square API access token of your application.
apiEnvironment String: Field usage depends on service value: - Service afterpay: Your Afterpay API environment.
apiId String: Field usage depends on service value: - Service aircall: Your Aircall API ID.
apiKey String: Field usage depends on service value: - Service 15five: Your 15five API key. - Service 360learning: Your 360Learning API Key. - Service 6sense: Your 6sense API Key. - Service acculynx: Your Acculynx API key. - Service activecampaign: Your ActiveCampaign API key. - Service affinity: Your Affinity API key. - Service airtable: API key of the Airtable account. - Service algolia: Your Algolia API key. - Service anvyl: Your Anvyl API key. - Service appcues: Your Appcues API key. - Service ashby: Your Ashby API key. - Service assembled: Your Assembled API key. - Service atlassian_jira_align: Your Jira Align API key. - Service atlassian_ops_genie: Your Opsgenie API key - Service attentive: Your Attentive API key. - Service aumni: Your Aumni API key. - Service avantlink: Your AvantLink API key. - Service ballotready: Your BallotReady API token. - Service bamboohr: Your API Key. - Service bazaarvoice: Your Bazaarvoice API key. - Service betterworks: Your Betterworks API key. - Service bigmarker: Your BigMarker API key. - Service bizzabo: Your Bizzabo API key. - Service brave_ads: Your Brave Ads API key - Service braze: Your Braze API Key. - Service brevo: Your Brevo API key. - Service bubble: Your Bubble API token. - Service buildium: Your Buildium private API key. - Service callrail: Your CallRail API key. - Service campaignmonitor: Your Campaign Monitor API key. - Service canny: Your Canny API key. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 API key. - Service chargebee_product_catalog_2: Your Chargebee API key. - Service chartmogul: Your ChartMogul API key. - Service chorusai: Your Chorus API key. - Service churnkey: Your Churnkey API Key. - Service churnzero: Your ChurnZero API key. - Service cimis: Your Cimis API key. - Service circleci: Your CircleCI API Key. - Service clickup: Your ClickUp API key. - Service clockify: Your Clockify API key. - Service clockodo: Your Clockodo API key. - Service close: Your Close API key. - Service cloudbeds: Your Cloudbeds API key. - Service clubspeed: Your Clubspeed API key. - Service coassemble: Your Coassemble API key. - Service codefresh: Your Codefresh API Key. - Service column: Your Column API key. - Service concord: Your Concord API key. - Service confluent_cloud: API Key - Service contrast_security: Your Contrast Security API Key. - Service copper: Your Copper API key. - Service coupa: Your Coupa API key. - Service datadog: Your Datadog API key. - Service dbt_cloud: Your dbt Cloud service token. - Service dcl_logistics: Your DCL Logistics API key. - Service delighted: API Key for your Delighted account - Service destini: Your Destini API Key. - Service donus: Your Donus API key. - Service doorloop: Your DoorLoop API key. - Service drata: Your Drata API Key. - Service dropbox_sign: Your Dropbox Sign API key. - Service duoplane: Your Duoplane API key. - Service easypost: Your EasyPost API Key. - Service electronic_tenant_solutions: Your Electronic Tenant Solutions API key. - Service eventsforce: Your Eventsforce API secret key. - Service everflow: Your Everflow API key. - Service everhour: Your Everhour API Token. - Service expensein: Your ExpenseIn API key. - Service factorial: Your Factorial API key. - Service firehydrant: Your FireHydrant API key. - Service float: Your Float API key. - Service forj_community: Your Forj Community API key. - Service fourkites: Your FourKites API key. - Service freightview: Your Freightview API key. - Service freshdesk: Your Freshdesk API Key. - Service freshdesk_contact_center: Your Freshdesk Contact Center API key. - Service freshsales: Your Freshsales API key. - Service freshservice: Your Freshservice API Key. - Service freshsuccess: Your Freshsuccess API key. - Service freshteam: Your Freshteam API key. - Service friendbuy: Your Friendbuy API key. - Service fullstory: Your Fullstory API key. - Service gainsight_product_experience: Your Gainsight Product Experience API key. - Service gem: Your Gem API key. - Service gorgias: Your Gorgias API key. - Service greenhouse: Your Greenhouse API key. - Service grepsr: Your Grepsr API Key. - Service grin: Your Grin API key. - Service happyfox: Your HappyFox API key. - Service height: Your Height API key. - Service helpshift: Your Helpshift API Key. - Service incidentio: Your incident.io API key. - Service infobip: Your Infobip API key. - Service insightly: Your Insightly API key. - Service integrate: Your Integrate API key. - Service invoiced: Your Invoiced API key. - Service iterable: Your Iterable API key. - Service ivanti: Your Ivanti API Key. - Service jotform: Your Jotform API key. - Service justcall: Your JustCall API key. - Service katana: Your Katana API key. - Service kevel: Your Kevel API key. - Service keypay: Your KeyPay API key. - Service kisi: Your Kisi API key. - Service klaviyo: Your Klaviyo API key. - Service learnupon: Your Learnupon API key. - Service lemlist: Your Lemlist API key. - Service lever: Your Lever API key. - Service liftoff: Your Liftoff API key. - Service linear: Your Linear API key. - Service linksquares: Your LinkSquares API key. - Service lob: Your Lob API key. - Service loop: Your Loop API key. - Service lucca: Your Lucca API key. - Service luma: Your Luma API key. - Service maileon: Your Maileon API key. - Service mailgun: Your Mailgun API key. - Service mailjet: Your Mailjet API key. - Service malomo: Your Malomo API key. - Service mambu: Your Mambu API key. - Service mandrill: Your Mandrill API key. - Service maxio_chargify: Enter Your API Key. - Service messagebird: Your MessageBird API key. - Service mountain: Your MNTN API key. - Service myosh: Your myosh API key. - Service okendo: Your Okendo API key. - Service ometria: Your Ometria API Key. - Service oncehub: Your OnceHub API key. - Service ordway: Your Ordway API key. - Service ortto: Your Ortto API key. - Service pagerduty: Your PagerDuty API key. - Service pandadoc: Your PandaDoc API key. - Service papershift: Your Papershift API Key - Service partnerize: Your Partnerize user API key. - Service persona: Your Persona API key. - Service picqer: Your Picqer API key. - Service pigment: Your Pigment API key. - Service pinpoint: Your Pinpoint API key. - Service pipe17: The Pipe17 API key. - Service placerai: Your Placer.ai API key. - Service playvox: Your Playvox API Key. - Service posthog: Your PostHog API key. - Service prive: Your Prive API key. - Service prosperstack: Your ProsperStack API key. - Service qualaroo: Your Qualaroo API Key. - Service quorum: Your Quorum API key. - Service rebound_returns: Your ReBound Returns API key. - Service recurly: The Recurly API key. - Service replyio: Your Reply API key. - Service revenuecat: Your RevenueCat API key. - Service reviewsio: Your REVIEWS.io API key. - Service revops: Your RevOps bearer token. - Service ricochet360: Your Ricochet360 API key. - Service ringover: Your Ringover API key. - Service rippling: Your Rippling API key. - Service rocketlane: Your Rocketlane API key. - Service rootly: Your Rootly API key. - Service ruddr: Your Ruddr API key. - Service safebase: Your SafeBase API key. - Service sage_hr: Your Sage HR API key. - Service sailthru: The Sailthru API key. - Service salsify: Your Salsify API Key. - Service security_journey: Your Security Journey API key. - Service sendgrid: The SendGrid API key. - Service sendinblue: Your Sendinblue API key. - Service shortcut: Your Shortcut API token. - Service shortio: Your Short.io API key. - Service simplesat: Your Simplesat API key. - Service sistrix: Your SISTRIX API key. - Service skilljar: Your Skilljar API key. - Service smartwaiver: Your Smartwaiver API key. - Service snyk: Your Snyk API key. - Service sonarqube: Your Sonarqube API key. - Service sparkpost: Your SparkPost API key. - Service squarespace: Your Squarespace API key. - Service stackadapt: Your StackAdapt API key. - Service statuspage: Your Statuspage API Key. - Service stripe: Restricted API key - Service stripe_test: Restricted API key - Service subscript: Your Subscript API key. - Service survicate: Your Survicate API Key. - Service teads: Your Teads API key. - Service teamtailor: Your Teamtailor API key. - Service testrail: Your TestRail API key. - Service ticket_tailor: Your Ticket Tailor API key. - Service transcend: Your Transcend API key. - Service trello: Your TRELLO api key. - Service triple_whale: Your Triple Whale API key. - Service uppromote: Your UpPromote API key. - Service veeqo: Your Veeqo API key. - Service venminder: Your Venminder API key. - Service visit_by_ges: Your Visit by GES API key. - Service vitally: Your Vitally API key. - Service vonage: Your Vonage API Key. - Service vts: Your VTS API key. - Service webconnex: Your Webconnex API key. - Service wicked_reports: Your Wicked Reports API key. - Service workleap_officevibe: Your Workleap Officevibe API key. - Service xsolla: Your Xsolla API key. - Service yougov_sport: Your Yougov Sport API key. - Service zingtree: Your Zingtree API key. - Service zip: Your Zip API key.
apiKeyApiSecret String: Field usage depends on service value: - Service revel: Your Revel Systems API Key and API Secret.
apiKeys List<String>: Field usage depends on service value: - Service mandrill: Comma-separated list of API keys. Required if use_api_keys is set to true.
apiPassword String: Field usage depends on service value: - Service duoplane: Your Duoplane API password.
apiQuota Number: Field usage depends on service value: - Service marketo: Allowed number of API requests to Marketo instance per day, the default value is 10000.
apiReadAccessToken String: Field usage depends on service value: - Service the_movie_database: Your The Movie Database API read access token.
apiRequestsPerMinute Number: Field usage depends on service value: - Service qualtrics: Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
apiSecret String: Field usage depends on service value: - Service confluent_cloud: API Secret - Service forj_community: Your Forj Community API secret. - Service friendbuy: Your Friendbuy API secret. - Service justcall: Your JustCall API secret. - Service liftoff: Your Liftoff API secret. - Service mixpanel: Mixpanel API Secret. - Service qualaroo: Your Qualaroo API Secret. - Service sailthru: The Sailthru API secret. - Service shareasale: Your ShareASale API secret. - Service vonage: Your Vonage API Secret.
apiSecretKey String: Field usage depends on service value: - Service alchemer: Your Alchemer API Secret key.
apiServer String: Field usage depends on service value: - Service sigma_computing_source: Your Sigma Computing api server.
apiToken String: Field usage depends on service value: - Service aha: Your Aha! API key. - Service aircall: Your Aircall API Token. - Service appsflyer: API Token for AppsFlyer's PULL API. - Service awin: Your Awin API Token. - Service backbone_plm: Your Backbone PLM API token. - Service brex: Your Brex API token - Service buildkite: Your Buildkite API token. - Service buzzsprout: Your Buzzsprout API token. - Service centra: Your Centra API token. - Service chameleon: Your Chameleon API token. - Service clari: Your Clari API token. - Service cloudflare_analytics: Your Cloudflare Analytics API token. - Service confluence: The Confluence API token. - Service dixa: Your Dixa API token. - Service drip: Your Drip API Token. - Service factbird: Your Factbird API token. - Service fone_dynamics: Your Fone Dynamics API token. - Service fountain: Your Fountain API token. - Service g2: Your G2 API token. - Service gladly: Your Gladly API Token. - Service hibob: Your Hibob API token. - Service kandji: Your Kandji API token. - Service livechat: Your Livechat Access token. - Service livechat_partner: Your Livechat Partner API Token. - Service maxio_saasoptics: Your Maxio SaaSOptics API token. - Service megaphone: Your Megaphone API token. - Service missive: Your Missive API token. - Service mixmax: Mixmax API token. - Service okta: Your Okta API token. - Service ordway: Your Ordway API token. - Service packiyo: Your Packiyo API token. - Service pipedrive: (Optional)Your Pipedrive personal API token - Service pivotal_tracker: Pivotal Tracker API token. - Service postmark: Your Postmark account API token. - Service productive: Your Productive API token. - Service qualtrics: API token of the Qualtrics account. - Service rakutenadvertising: Your Rakuten Advertising API token. - Service recharge: The Recharge API token. - Service referralhero: Your Referralhero API token. - Service resource_management_by_smartsheet: Your Resource Management by Smartsheet API token. - Service retently: Your Retently API token. - Service reviewsai: Your REVIEWS.ai API token. - Service rundeck: Your Rundeck API token. - Service safetyculture: Your SafetyCulture API token. - Service sensor_tower: Your Sensor Tower API token. - Service sentry: Your Sentry auth token. - Service simplecast: Your Simplecast API token. - Service snyk: Your Snyk API token. - Service textus: Your TextUs API token. - Service toggl_track: Your Toggl Track API token - Service trello: Your TRELLO api token. - Service trisolute: Your Trisolute API token. - Service vwo: Your VWO API token. - Service web_scraper: Your Web Scraper API token. - Service zendesk: Zendesk API tokens are auto-generated passwords in the Support admin interface. - Service zendesk_sunshine: Zendesk API tokens are auto-generated passwords in the Support admin interface.
apiType String
apiUrl String: Field usage depends on service value: - Service braze: Your Braze API URL.
apiUrlRegion String: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP API URL region.
apiUsage String: Field usage depends on service value: - Service zendesk: Maximum Zendesk Api Usage allowed
apiUserIdentifier String: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user identifier.
apiUserSecret String: Field usage depends on service value: - Service shipnetwork: Your ShipNetwork API user secret.
apiUtilizationPercentage String: Field usage depends on service value: - Service kustomer: Api Utilization Percentage
apiVersion String: Field usage depends on service value: - Service pardot: API Version
appId String: Field usage depends on service value: - Service churnkey: Your Churnkey APP ID. - Service open_exchange_rates: Your Open Exchange Rates App Id. - Service rokt: Your Rokt app ID.
appIds List<String>: Field usage depends on service value: - Service pendo: Specific App IDs to sync. Must be populated if sync_mode is set to SpecificAppIds.
appIdsAppsflyers List<Property Map>: Field usage depends on service value: - Service appsflyer: * App ID(s)
appKey String: Field usage depends on service value: - Service loopio: Your Loopio App Key. - Service servicetitan: Your ServiceTitan app key. - Service yotpo: Your Yotpo App Key
appReference String: Field usage depends on service value: - Service brightpearl: Your Brightpearl app reference.
appSecret String: Field usage depends on service value: - Service rokt: Your Rokt app secret.
appSecretToken String
appSpecificPassword String: Field usage depends on service value: - Service itunes_connect: Your app-specific password
appSyncMode String: Field usage depends on service value: - Service itunes_connect: Whether to sync all apps or specific apps.
appendFileOption String: Field usage depends on service value: - Service aws_cost_report: If you know that the source completely overwrites the same file with new data, you can append the changes instead of upserting based on filename and line number. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
applicationId String: Field usage depends on service value: - Service algolia: Your Algolia application ID. - Service xactly: Your Xactly Application ID.
applicationKey String: Field usage depends on service value: - Service cin7core: Your Cin7 Core application key. - Service datadog: Your Datadog application key. - Service dear: Your Dear Application key. - Service partnerize: Your Partnerize user application key.
apps List<String>: Field usage depends on service value: - Service itunes_connect: Specific apps to sync. Must be populated if app_sync_mode is set to SpecificApps.
archiveLogFormat String: Field usage depends on service value: - Service sql_server_hva: Format for archive log file names - Service sql_server_sap_ecc_hva: Format for archive log file names
archiveLogPath String: Field usage depends on service value: - Service sql_server_hva: Directory where archive logs are located - Service sql_server_sap_ecc_hva: Directory where archive logs are located
archivePattern String: Field usage depends on service value: - Service aws_cost_report: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service azure_blob_storage: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service box: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service dropbox: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service email: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service ftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service gcs: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service google_drive: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service kinesis: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced. - Service s3: Files inside compressed archives with filenames matching this regular expression will be synced. - Service sftp: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service share_point: Files inside of compressed archives with filenames matching this regular expression will be synced. - Service wasabi_cloud_storage: Files inside compressed archives with filenames matching this regular expression will be synced.
areSoapCredentialsProvided Boolean: Field usage depends on service value: - Service marketo: Marketo SOAP credentials provided.
asbIp String: Field usage depends on service value: - Service azure_service_bus: The IP address (or) the URL of ASB namespace
asmOption Boolean: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using ASM on a non-RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you are using ASM on a non-RAC instance.
asmOracleHome String: Field usage depends on service value: - Service oracle_hva: ASM Oracle Home path. - Service oracle_sap_hva: The Oracle ASM home directory.
asmPassword String: Field usage depends on service value: - Service oracle_hva: ASM password. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user's password. Mandatory if use_oracle_rac or asm_option is set to true.
asmTns String: Field usage depends on service value: - Service oracle_hva: ASM TNS. - Service oracle_sap_hva: ASM TNS.
asmUser String: Field usage depends on service value: - Service oracle_hva: ASM user. Mandatory if use_oracle_rac or asm_option is set to true. - Service oracle_sap_hva: The ASM user. Mandatory if use_oracle_rac or asm_option is set to true.
attributionWindow String: Field usage depends on service value: - Service amazon_ads: Time period used to attribute conversions based on clicks.
attributionWindowSize String: Field usage depends on service value: - Service tiktok_ads: Rollback sync duration to capture conversions. Set this to your configured attribution window in TikTok Ads. The default value is 7 days.
audience String: Field usage depends on service value: - Service auth0: Your Auth0 API audience.
auth String: Field usage depends on service value: - Service databricks_db: Token-based authentication type - Service redshift_db: Password-based authentication type - Service snowflake_db: Password-based or key-based authentication type
authCode String: Field usage depends on service value: - Service happyfox: Your HappyFox auth code.
authEnvironment String: Field usage depends on service value: - Service younium: Your Younium auth environment.
authMethod String: Field usage depends on service value: - Service aurora_postgres: Database authentication method - Service azure_postgres: Database authentication method - Service azure_sql_db: Authentication Method. - Service azure_sql_managed_db: Authentication Method. - Service google_cloud_postgresql: Database authentication method - Service heroku_postgres: Database authentication method - Service postgres: Database authentication method - Service postgres_rds: Database authentication method - Service sql_server_hva: Authentication Method - Service sql_server_sap_ecc_hva: Authentication Method - Service webhooks: The authentication mechanism you want to use
authMode String: Field usage depends on service value: - Service anaplan: The Anaplan authentication method. - Service concur: The Authentication Mode used by SAP Concur. It can be PasswordGrant or CompanyLevel auth mode - Service github: Authorization type.
authToken String: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback auth token.
authType String: Field usage depends on service value: - Service airtable: Type of authentication being used by connector - Service aws_cost_report: Access approach - Service azure_service_bus: The authentication mode to access the topic - Service dynamics_365: Authentication mechanism. Either one of OAUTH2, or SERVICE_PRINCIPAL. Default value OAUTH2 - Service gcs: Authorization type. Required for storage bucket authentication. - Service google_sheets: The OAuth value must be specified for this type of authorization. - Service jira: Authorization type. - Service mixpanel: Authentication Method - Service pardot: Authenticate using OAuth or HTTP Basic - Service qualtrics: Type of authentication being used by connector - Service s3: Access approach - Service wasabi_cloud_storage: The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: ACCESS_KEY.
authUrlRegion String: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP auth grant URL region.
authenticationMethod String: Field usage depends on service value: - Service adobe_analytics: Authentication Method - Service elastic_cloud: The authentication method used to connect to your cluster. - Service es_self_hosted: The authentication method used to connect to your cluster. - Service opendistro: The authentication method used to connect to your cluster. - Service opensearch: The authentication method used to connect to your cluster. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud authentication method. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud authentication method. - Service salesforce: (Optional) Authentication type (default value = STANDARD) - Service salesforce_sandbox: (Optional) Authentication type (default value = STANDARD)
authorizationMethod String
awsRegionCode String: Field usage depends on service value: - Service dynamodb: The AWS region code for the DynamoDB instance, e.g. us-east-1.
backintConfigurationPath String
backintExecutablePath String
backwardSyncLimit String: Field usage depends on service value: - Service zendesk: Limit of the Historical Sync Time for selected tables
baseCurrency String: Field usage depends on service value: - Service open_exchange_rates: Your Open Exchange Rates Base Currency.
baseDomain String: Field usage depends on service value: - Service freshteam: Your company's Freshteam base domain name (usually company.freshteam.com).
baseId String: Field usage depends on service value: - Service airtable: ID of base in Airtable
baseUrl String: Field usage depends on service value: - Service aha: Your Aha! subdomain. - Service akeneo: Your Akeneo base URL. - Service billing_platform: Your BillingPlatform subdomain. - Service boostr: Your Boostr base URL. - Service brex: Your Brex Base URL - Service centra: Your Centra base URL. - Service cornerstone: Your Cornerstone base URL. - Service culture_amp: Your Culture Amp base URL. - Service datadog: Your Datadog base url. - Service factbird: Your Factbird base url. - Service fillout: Your Fillout Base URL. - Service financial_force: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service freshsales: Your Freshsales product. - Service gongio: Your Gong API Base URL. - Service ironclad: Your Ironclad base url. - Service jotform: Your Jotform base URL. - Service mailgun: Your Mailgun base URL. - Service nice: Your NICE base URL. - Service ortto: Your Ortto base URL. Possible values: api, api.au, api.eu. - Service prisma_cloud: Your Prisma Cloud admin console URL. - Service salesforce: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service salesforce_sandbox: (Optional) The custom Salesforce domain. Make sure that the base_url starts with https://. - Service stickyio: Your sticky.io base URL . - Service veevavault: Your Veeva Vault base URL. - Service vitally: Your Vitally base URL.
bearerToken String: Field usage depends on service value: - Service ada: Your Ada API Access Token. - Service crowddev: Your crowd.dev Auth Token. - Service customerio: Your Customer.io App API Key. - Service freshchat: Your Freshchat API Token. - Service hopin: Your Hopin API key. - Service orbit: Your Orbit API Token. - Service productboard: Your Productboard API key. - Service smarthr: Your SmartHR access token. - Service sprout: Your Sprout Social API Access Token. - Service zenefits: Your Zenefits bearer token.
blobSasUrl String: Field usage depends on service value: - Service webhooks: The blob SAS URL of your Azure container. Required if bucket_service is set to AZURE.
blockchain String: Field usage depends on service value: - Service rarible: Your Rarible Blockchain.
brandId String: Field usage depends on service value: - Service oracle_moat_analytics: Your Oracle Moat Analytics Brand ID.
breakdowns List<String>: Field usage depends on service value: - Service facebook: List of breakdowns which connector will sync. Possible breakdowns values.
bucket String: Field usage depends on service value: - Service appsflyer: Customer S3 Bucket - Service aws_cloudtrail: The AWS bucket name which is configured for AWS CloudTrail. - Service aws_cost_report: The S3 bucket name with the AWS Cost and Usage Report - Service aws_inventory: The AWS bucket name that is configured for AWS Config. - Service aws_lambda: S3 Bucket - Service cloudfront: The bucket name for CloudFront. - Service gcs: The name of the GCS bucket. - Service google_play: The Google Cloud Storage source bucket. - Service heap: The S3 bucket name. - Service kinesis: The name of the Kinesis bucket. - Service s3: The S3 bucket name. Required for connector creation. - Service segment: The name of the Segment bucket. Must be populated if sync_type is set to S3. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket name. Required for connector creation.
bucketName String: Field usage depends on service value: - Service adjust: Your AWS S3 or GCS bucket. - Service google_analytics_360: The name of the bucket. - Service google_analytics_4_export: The name of the bucket.
bucketService String: Field usage depends on service value: - Service webhooks: Whether to store the events in Fivetran's container service or your S3 bucket. Default value: Fivetran.
businessAccounts List<String>: Field usage depends on service value: - Service reddit_ads: Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts.
businessId String: Field usage depends on service value: - Service birdeye: Your Birdeye Business ID.
businessUnit String: Field usage depends on service value: - Service deposco: Your Deposco business unit.
businessUnitId String: Field usage depends on service value: - Service pardot: Business Unit Id
catalog String: Field usage depends on service value: - Service databricks_db: catalog to sync
certificate String: Field usage depends on service value: - Service anaplan: The contents of your PEM certificate file. Must be populated if auth_mode is set to Certificate. - Service qualtrics: Your Client Certificate - Service salesforce: Provide content of the .pem certificate (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .pem certificate (only when authentication_method = ADVANCED).
clickAttributionWindow String: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on clicks. Possible click_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'click' action.
client String
clientCert String: Field usage depends on service value: - Service apache_kafka: Kafka client certificate. - Service heroku_kafka: Heroku Kafka client certificate. Required for TLS security protocol.
clientCertKey String: Field usage depends on service value: - Service apache_kafka: Kafka client certificate key. - Service heroku_kafka: Heroku Kafka client certificate key. Required for TLS security protocol.
clientHost String: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Host.
clientId String: Field usage depends on service value: - Service acumatica: Your Acumatica client ID. - Service adobe_analytics: Client ID from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client ID. - Service adp_workforce_now: Your ADP Client ID. - Service akamai: Your Akamai client ID. - Service akeneo: Your Akeneo client ID. - Service auth0: Your Auth0 client ID. - Service autodesk_bim_360: Your Autodesk BIM 360 client ID. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Id - Service billing_platform: Your BillingPlatform client ID. - Service bing_webmaster_tools: Your Bing Webmaster Tools client ID. - Service brightcove: Your Brightcove client ID. - Service brightpearl: Your Brightpearl client ID. - Service buildium: Your Buildium API client ID. - Service canvas_by_instructure: Your Canvas by Instructure client ID. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure client ID. - Service castor_edc: Your Castor EDC client Id. - Service clazar: Your Clazar client ID. - Service cloudbeds: Your Cloudbeds client ID. - Service commercetools: Your commercetools client ID. - Service concur: The SAP Concur Client ID. - Service constant_contact: Your Constant Contact client ID. - Service cornerstone: Your Cornerstone client ID. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo Client ID. - Service criteo_retail_media: Your Criteo Retail Media client ID. - Service culture_amp: Your Culture Amp client ID. - Service cvent: Your Cvent client ID. - Service d2l_brightspace: Your D2L Brightspace client ID. - Service dialpad: Your Dialpad client ID. - Service ebay: Your eBay app ID. - Service exact_online: Your Exact Online client ID. - Service fillout: Your Fillout client ID. - Service flexport: The Flexport API Key. - Service formstack: Your Formstack client ID. - Service genesys: Your Genesys client ID. - Service hana_sap_hva_ecc_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hana_sap_hva_s4_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service hilti_ontrack: Your Hilti On!Track client ID. - Service ilevel: Your iLevel Client ID. - Service instructure: Your Instructure client ID. - Service integral_ad_science: Your integral_ad_science client id. - Service ironclad: Your Ironclad client ID. - Service jama_software: Your Jama Software client ID. - Service jibble: Your Jibble client ID. - Service khoros_communities: Your Khoros Communities client ID. - Service looker_source: Your Looker Client ID. - Service marketo: Marketo REST API Client Id. - Service medallia: Medallia Client ID - Service microsoft_entra_id: Your Microsoft Entra ID Client ID. - Service microsoft_power_bi: Your Microsoft Power BI client ID. - Service microsoft_teams: Your Microsoft Teams Client ID. - Service navan: Your Navan client ID. - Service nice: Your NICE client ID. - Service on24: Your ON24 client ID. - Service oracle_sap_hva_netweaver: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon. - Service paychex: Your Paychex client ID. - Service paypal: Client ID of your PayPal client application. - Service paypal_sandbox: Client ID of your PayPal client application. - Service personio: Your Personio Client ID. - Service piwik_pro: Your Piwik PRO client ID. - Service podio: Your Podio client ID. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client ID. - Service prisma_cloud: Your Prisma Cloud access key ID. - Service procore: Your Procore client ID. - Service quora_ads: Your Quora Ads client ID. - Service reltio: Your Reltio client ID. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client ID. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client ID. - Service salesloft: Client ID of your Salesloft client application. - Service sana: Your Sana client ID. - Service sap_success_factors: Your SAP SuccessFactors Client ID. - Service servicenow: ServiceNow Client ID. - Service servicetitan: Your ServiceTitan client ID. - Service sharetribe: Your Sharetribe client ID. - Service shipnetwork: Your ShipNetwork client ID. - Service sigma_computing_source: Your Sigma Computing client ID. - Service skillstx: Your SkillsTX client ID. - Service skimlinks: Your Skimlinks client ID. - Service smartrecruiters: Your SmartRecruiters client ID. - Service splash: Your Splash client ID. - Service square: The Application ID of your organization. - Service standard_metrics: Your Standard Metrics Client ID. - Service sugarcrm: Your SugarCRM client ID. - Service swoogo: Your Swoogo client Id. - Service taboola: The Taboola client ID. - Service talkdesk: The Client ID of your OAuth Client - Service tive: Your Tive client ID. - Service toast: Your Toast client ID. - Service trelica: Your Trelica client ID. - Service tremendous: Your Tremendous client ID. - Service tymeshift: Your Tymeshift email. - Service udemy_business: Your Udemy Business client ID. - Service vimeo: Your Vimeo client ID. - Service visma: Your Visma client ID. - Service vonage_contact_center: Your Vonage Contact Center client ID. - Service walmart_marketplace: Your Walmart Marketplace client ID. - Service xero: your clientId - Service xray: Your Xray Client ID. - Service yougov_sport: Your Yougov Sport client ID. - Service zendesk_chat: Your Zendesk client ID. - Service zoho_books: Your Zoho Books Client ID. - Service zoho_campaigns: Your Zoho Campaigns Client ID. - Service zoho_desk: Your Zoho Desk Client Id. - Service zoho_inventory: Your Zoho Inventory client ID. - Service zuora: Zuora Client ID. - Service zuora_sandbox: Zuora Client ID.
clientKey String: Field usage depends on service value: - Service appfigures: Your Appfigures Client Key. - Service thinkific: Your Thinkific client key. - Service yougov_sport: Your Yougov Sport client key.
clientName String: Field usage depends on service value: - Service destini: Your Destini Client Name. - Service medallia: Medallia company name
clientNamespace String: Field usage depends on service value: - Service ceridian_dayforce: Your Ceridian Dayforce Client Namespace.
clientPrivateKey String: Field usage depends on service value: - Service aurora_postgres: Client Private Key in .pem format. - Service azure_postgres: Client Private Key in .pem format. - Service google_cloud_postgresql: Client Private Key in .pem format. - Service heroku_postgres: Client Private Key in .pem format. - Service postgres: Client Private Key in .pem format. - Service postgres_rds: Client Private Key in .pem format.
clientPublicCertificate String: Field usage depends on service value: - Service aurora_postgres: Client Certificate in .pem format. - Service azure_postgres: Client Certificate in .pem format. - Service google_cloud_postgresql: Client Certificate in .pem format. - Service heroku_postgres: Client Certificate in .pem format. - Service postgres: Client Certificate in .pem format. - Service postgres_rds: Client Certificate in .pem format.
clientSecret String: Field usage depends on service value: - Service acumatica: Your Acumatica client secret. - Service adobe_analytics: Client Secret from the OAuth Server-to-Server or Service Account (JWT) credentials of your Adobe Project. - Service adobe_workfront: Your Adobe Workfront client secret. - Service adp_workforce_now: Your ADP Client Secret. - Service akamai: Your Akamai client secret. - Service akeneo: Your Akeneo client secret. - Service auth0: Your Auth0 client secret. - Service autodesk_bim_360: Your Autodesk BIM 360 client secret. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Client Secret - Service billing_platform: Your BillingPlatform client secret. - Service bing_webmaster_tools: Your Bing Webmaster Tools client secret. - Service brightcove: Your Brightcove client secret. - Service brightpearl: Your Brightpearl client secret. - Service canvas_by_instructure: Your Canvas by Instructure client secret. - Service castor_edc: Your Castor EDC Client Secret. - Service clazar: Your Clazar client secret. - Service cloudbeds: Your Cloudbeds client secret. - Service commercetools: Your commercetools client secret. - Service concur: The SAP Concur Client secret. - Service constant_contact: Your Constant Contact client secret. - Service cornerstone: Your Cornerstone client secret. - Service coupa: Your Coupa client_id - Service criteo: Your Criteo client secret key. - Service criteo_retail_media: Your Criteo Retail Media client secret. - Service culture_amp: Your Culture Amp client secret. - Service cvent: Your Cvent client secret. - Service d2l_brightspace: Your D2L Brightspace client secret. - Service dialpad: Your Dialpad client secret. - Service ebay: Your eBay cert ID. - Service exact_online: Your Exact Online client secret. - Service fillout: Your Fillout client secret - Service flexport: The Flexport API Secret. - Service formstack: Your Formstack client secret. - Service genesys: Your Genesys client secret. - Service hilti_ontrack: Your Hilti On!Track client secret. - Service ilevel: Your iLevel Client Secret. - Service instructure: Your Instructure client secret. - Service integral_ad_science: Your integral_ad_science client secret. - Service ironclad: Your Ironclad client secret. - Service jama_software: Your Jama Software client secret. - Service jibble: Your Jibble client secret. - Service looker_source: Your Looker Client Secret. - Service marketo: Marketo REST API Client Secret. - Service medallia: Medallia Client Secret key - Service microsoft_entra_id: Your Microsoft Entra ID Client Secret. - Service microsoft_power_bi: Your Microsoft Power BI client secret. - Service microsoft_teams: Your Microsoft Teams Client Secret. - Service navan: Your Navan client secret. - Service nice: Your NICE client secret. - Service paychex: Your Paychex client secret. - Service personio: Your Personio secret. - Service piwik_pro: Your Piwik PRO client secret. - Service podio: Your Podio client secret. - Service power_reviews_enterprise: Your PowerReviews Enterprise Client Secret. - Service prisma_cloud: Your Prisma Cloud secret access Key. - Service procore: Your Procore client secret. - Service quora_ads: Your Quora Ads client secret. - Service reltio: Your Reltio client secret. - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud Client secret. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud client secret. - Service salesloft: Client Secret of your Salesloft client application. - Service sana: Your Sana client secret. - Service sap_success_factors: Your SAP SuccessFactors Client Secret that you generated through SAML Assertion. - Service servicenow: ServiceNow Client Secret. - Service servicetitan: Your ServiceTitan secret key. - Service sharetribe: Your Sharetribe client secret. - Service sigma_computing_source: Your Sigma Computing client secret. - Service skillstx: Your SkillsTX client secret. - Service skimlinks: Your Skimlinks client secret. - Service smartrecruiters: Your SmartRecruiters client secret. - Service splash: Your Splash client secret. - Service square: The Application Secret of your organization. - Service standard_metrics: Your Standard Metrics Client secret. - Service sugarcrm: Your SugarCRM client secret. - Service swoogo: Your Swoogo Client Secret. - Service taboola: The Taboola client secret. - Service talkdesk: The Client Secret of your OAuth Client - Service thinkific: Your Thinkific client secret. - Service tive: Your Tive client secret. - Service toast: Your Toast client secret. - Service trelica: Your Trelica client secret. - Service tremendous: Your Tremendous client secret. - Service tymeshift: Your Tymeshift password. - Service udemy_business: Your Udemy Business client secret. - Service vimeo: Your Vimeo client secret. - Service visma: Your Visma client secret. - Service vonage_contact_center: Your Vonage Contact Center client secret. - Service walmart_marketplace: Your Walmart Marketplace client secret. - Service xero: your clientSecret - Service xray: Your Xray Client Secret. - Service zendesk_chat: Your Zendesk client secret. - Service zoho_books: Your Zoho Books Client Secret. - Service zoho_campaigns: Your Zoho Campaigns Client Secret. - Service zoho_desk: Your Zoho Desk Client secret. - Service zoho_inventory: Your Zoho Inventory client secret. - Service zuora: Zuora Client Secret. - Service zuora_sandbox: Zuora Client Secret.
cloudStorageType String: Field usage depends on service value: - Service braze: Cloud storage type Braze Current is connected to.
collectionAddress String: Field usage depends on service value: - Service rarible: Your Rarible Collection Address.
columns List<String>: Field usage depends on service value: - Service double_click_publishers: Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.
communityDomain String: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community domain.
communityId String: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities community ID.
companies List<String>: Field usage depends on service value: - Service business_central: List of companies to sync
company String: Field usage depends on service value: - Service ordway: Your Ordway company name.
companyId String: Field usage depends on service value: - Service 360learning: Your 360Learning Company ID. - Service sage_intacct: Company ID - Service sap_success_factors: Your SAP SuccessFactors Company ID.
companyIds String: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail company IDs.
companyKey String: Field usage depends on service value: - Service khoros_care: Your Khoros Care companyKey. - Service upland: Your Upland Software Company Key.
companyName String: Field usage depends on service value: - Service clockodo: Your Clockodo company name.
companyRequestToken String: Field usage depends on service value: - Service concur: The SAP Concur Company Request Token
companyUuid String: Field usage depends on service value: - Service concur: The SAP Concur Company UUID
compression String: Field usage depends on service value: - Service aws_cost_report: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service azure_blob_storage: The secrets that should be passed to the function at runtime. - Service box: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service dropbox: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service email: The secrets that should be passed to the function at runtime. - Service ftp: The secrets that should be passed to the function at runtime. - Service gcs: The secrets that should be passed to the function at runtime. - Service google_drive: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service kinesis: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions. - Service s3: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service sftp: The secrets that should be passed to the function at runtime. - Service share_point: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. - Service wasabi_cloud_storage: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
configMethod String: Field usage depends on service value: - Service google_display_and_video_360: The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is CREATE_NEW.
configRepositoryUrl String: Field usage depends on service value: - Service snowplow: Public repository URL containing JSON configuration files.
configType String: Field usage depends on service value: - Service facebook: Option to select Prebuilt Reports or Custom Reports. Possible config_type values. - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports.
connectPassword String: Field usage depends on service value: - Service xactly: Your Xactly Connect password.
connectUsername String: Field usage depends on service value: - Service xactly: Your Xactly Connect username.
connectingUser String
connectingUserEmail String
connectionMethod String: Field usage depends on service value: - Service aws_msk: How Fivetran connects to your message brokers in the cluster - Service azure_blob_storage: Connection Method. Possible values: 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. - Service azure_function: Connection Method. Possible values: DIRECT: Fivetran will connect directly to your function, PRIVATE_LINK: Fivetran will connect to your storage container using PrivateLink. - Service azure_service_bus: The connection method - Service sftp: The connection method used to connect to SFTP Server.
connectionName String: Field usage depends on service value: - Service appsflyer: Your Data Locker Connection Name. Default value: `data-locker-hourly/
connectionString String: Field usage depends on service value: - Service azure_blob_storage: The blob storage container connection string. - Service azure_event_hub: Connection string of the Event Hub Namespace you want to sync. - Service azure_service_bus: The connection string used for authentication. Required if the authentication type is ConnectionString - Service microsoft_dynamics_365_fno: The blob storage container's connection string. - Service microsoft_dynamics_365_fo: The blob storage container connection string.
connectionType String: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service aws_cost_report: Connection method. Default value: Directly. - Service aws_lambda: Connection method. Default value: Directly. - Service azure_blob_storage: Connection method. Default value: Directly. - Service azure_cosmos_for_mongo: Possible values:Directly, PrivateLink. Directly is the default value - Service azure_postgres: 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. - Service azure_sql_db: 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. - Service azure_sql_managed_db: 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. - Service bigquery_db: Direct or PrivateLink connection - Service clarity: 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. - Service cockroachdb: Possible values:Directly, 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. - Service db2i_hva: Possible values:SshTunnel. SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service db2i_sap_hva: 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. - Service documentdb: Possible values:SshTunnel, PrivateLink . SshTunnel is used as a value if this parameter is omitted in the request and the following parameter's values are specified: tunnel_host, tunnel_port, tunnel_user. - Service dynamics_365_fo: 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. - Service ehr: 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. - Service elastic_cloud: Possible values:Directly, 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. - Service email: Connection method. Default value: Directly. - Service es_self_hosted: Possible values:Directly, 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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: 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. - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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. - Service heroku_postgres: 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. - Service kinesis: Connection method. Default value: Directly. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mongo: 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. - Service mongo_sharded: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service opendistro: Possible values:Directly, 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. - Service opensearch: Possible values:Directly, 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service oracle_sap_hva_netweaver: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Directly or Private Link - Service s3: Connection method. Default value: Directly. - Service sap_hana: 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. - Service sap_s4hana: Connection Method - Service snowflake_db: Directly or Private Link - Service sql_server: 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. - Service sql_server_hva: 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. - Service sql_server_rds: 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. - Service sql_server_sap_ecc_hva: 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.
consoleUrl String: Field usage depends on service value: - Service prisma_cloud: Your Prisma Cloud console URL.
consumerGroup String: Field usage depends on service value: - Service apache_kafka: Kafka consumer group name. - Service aws_msk: The name of consumer group created for Fivetran. - Service azure_event_hub: Name of consumer group created for Fivetran. - Service confluent_cloud: Confluent Cloud consumer group name. - Service heroku_kafka: Heroku Kafka consumer group name.
consumerKey String: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Key - Service twitter: API Key of your app - Service twitter_ads: The Twitter App consumer key. - Service woocommerce: Your WooCommerce Consumer key.
consumerName String: Field usage depends on service value: - Service xactly: Your Xactly Connect consumer name.
consumerSecret String: Field usage depends on service value: - Service netsuite_suiteanalytics: Consumer Secret - Service twitter: API Secret of your app - Service twitter_ads: The Twitter App consumer secret. - Service woocommerce: Your WooCommerce Consumer secret.
containerAddress String: Field usage depends on service value: - Service azure_blob_storage: IP address of the Azure Storage Container which is accessible from host machine.
containerName String: Field usage depends on service value: - Service azure_blob_storage: The name of the blob container. - Service microsoft_dynamics_365_fno: The name of the blob container. - Service microsoft_dynamics_365_fo: The name of the blob container.
contentOwnerId String: Field usage depends on service value: - Service youtube_analytics: Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.
contractVersion String: Field usage depends on service value: - Service acumatica: Your Acumatica contract version.
conversationWebhookUrl String: Field usage depends on service value: - Service helpscout: Your conversation webhook URL
conversionDimensions List<String>: Field usage depends on service value: - Service double_click_campaign_manager: Conversion Dimensions.
conversionReportTime String: Field usage depends on service value: - Service pinterest_ads: The date that the user interacted with the ad OR completed a conversion event.
conversionWindowSize Number: Field usage depends on service value: - Service google_ads: A period of time in days during which a conversion is recorded.
convertDatsTypeToDate Boolean
csvDefinition String: Field usage depends on service value: - Service adjust: CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition).
currency String: Field usage depends on service value: - Service criteo: Currency - Service rokt: Your Rokt currency.
customBaseUrl String: Field usage depends on service value: - Service datadog: Your Datadog custom base url. - Service deposco: Your Deposco custom base URL.
customEventSyncMode String: Field usage depends on service value: - Service iterable: Custom Events Sync Mode.
customEvents List<String>: Field usage depends on service value: - Service iterable: List of custom events to sync. Should be specified when custom_event_sync_mode is SelectedEvents
customFieldIds List<String>: Field usage depends on service value: - Service double_click_publishers: The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.
customFloodlightVariables List<String>: Field usage depends on service value: - Service double_click_campaign_manager: Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.
customPayloads List<Property Map>: Field usage depends on service value: - Service aws_lambda: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service azure_function: The list of key-value pairs that can be used to specify custom information to the function at runtime. - Service google_cloud_function: The list of key-value pairs that can be used to specify custom information to the function at runtime.
customReports List<Property Map>: Field usage depends on service value: - Service reddit_ads: The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data. - Service snapchat_ads: Custom reports for Snapchat Ads connector. - Service tiktok_ads: Title of Custom Report
customTables List<Property Map>: Field usage depends on service value: - Service facebook_ads: List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data.
customUrl String: Field usage depends on service value: - Service dbt_cloud: Your dbt Cloud access url. - Service factbird: Your Factbird custom base url. - Service jotform: Your Jotform custom base URL.
customerApiKey String: Field usage depends on service value: - Service ukg_pro: Your UKG Pro Customer API key.
customerId String: Field usage depends on service value: - Service google_ads: ID of the customer, can be retrieved from your AdWords dashboard.
customerListId String: Field usage depends on service value: - Service salesforce_commerce_cloud: The parameter to retrieve customer details.
dailyApiCallLimit Number
dataAccessMethod String: Field usage depends on service value: - Service cosmos: The source data access method. Supported values:ACCOUNT_KEY- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.RESOURCE_TOKEN- Fine-grained permission model based on native Azure Cosmos DB users and permissions. Learn more in our Azure Cosmos DB Data Access Methods documentation.
dataCenter String: Field usage depends on service value: - Service brightpearl: Your Brightpearl data center. - Service qualtrics: 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.) - Service zoho_crm: Data Center, depending on the Domain name
dataCenterId String: Field usage depends on service value: - Service zonka_feedback: Your Zonka Feedback data center ID.
dataSetName String: Field usage depends on service value: - Service bigquery_db: Data set name
database String: Field usage depends on service value: - Service aurora: The database name. - Service aurora_postgres: The database name. - Service azure_cosmos_for_mongo: Authentication database for the source. Usually 'admin'. - Service azure_postgres: The database name. - Service azure_sql_db: The database name. - Service azure_sql_managed_db: The database name. - Service clarity: The database name. - Service cockroachdb: The database name. - Service db2i_hva: The database name. - Service db2i_sap_hva: The database name. - Service dynamics_365_fo: The database name. - Service ehr: The database name. - Service google_cloud_mysql: The database name. - Service google_cloud_postgresql: The database name. - Service google_cloud_sqlserver: The database name. - Service hana_sap_hva_b1: The Hana database name. - Service hana_sap_hva_ecc: The Hana database name. - Service hana_sap_hva_ecc_netweaver: The Hana database name. - Service hana_sap_hva_s4: The Hana database name. - Service hana_sap_hva_s4_netweaver: The Hana database name. - Service heroku_postgres: The database name. - Service magento_mysql: The database name. - Service magento_mysql_rds: The database name. - Service maria: The database name. - Service maria_azure: The database name. - Service maria_rds: The database name. - Service mysql: The database name. - Service mysql_azure: The database name. - Service mysql_rds: The database name. - Service oracle: The database name. - Service oracle_ebs: The database name. - Service oracle_hva: The database name. - Service oracle_rac: The database name. - Service oracle_rds: The database name. - Service oracle_sap_hva: The database name. - Service postgres: The database name. - Service postgres_rds: The database name. - Service redshift_db: The database name: Redshift - Service sap_hana: The database name. - Service sap_s4hana: The database name. - Service snowflake_db: The database name: Snowflake - Service sql_server: The database name. - Service sql_server_hva: The database name. - Service sql_server_rds: The database name. - Service sql_server_sap_ecc_hva: The database name.
databaseName String: Field usage depends on service value: - Service firebase: Database Name
datasetId String: Field usage depends on service value: - Service google_analytics_360: The dataset ID. - Service google_analytics_4_export: The Dataset ID.
datasource String: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite data source value: NetSuite.com.
dateGranularity String: Field usage depends on service value: - Service adobe_analytics: The aggregation duration you want. Default value: HOUR .
db String: Field usage depends on service value: - Service myosh: Your Myosh Server variables/db .
delimiter String: Field usage depends on service value: - Service aws_cost_report: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service azure_blob_storage: 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. - Service box: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service dropbox: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service kinesis: Optional. 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. If your files sync with the wrong number of columns, consider setting this value - Service s3: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service sftp: 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. - Service share_point: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. - Service wasabi_cloud_storage: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
developerReference String: Field usage depends on service value: - Service brightpearl: Your Brightpearl dev reference.
dimensionAttributes List<String>: Field usage depends on service value: - Service double_click_publishers: Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions.
dimensions List<String>: Field usage depends on service value: - Service adroll: The dimenstions that you want to sync. - Service double_click_campaign_manager: 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 - Service double_click_publishers: Report dimensions to include in the sync. The date dimension is mandatory for all the report types. - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_display_and_video_360: 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.
directCaptureMethod String: Field usage depends on service value: - Service oracle_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY - Service oracle_sap_hva: Possible values:DIRECT, BFILE, ASM, ARCHIVE_ONLY
distributedConnectorClusterSize Number: Field usage depends on service value: - Service cosmos: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel. - Service dynamodb: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel.
domain String: Field usage depends on service value: - Service auth0: Your Auth0 domain. - Service bubble: Your Bubble app name or domain name. - Service confluence: Your Confluence domain. - Service kustomer: Domain is the beginning of your kustomer URL going before .kustomerapp.com, e.g. for yourcompany.kustomerapp.com the domain name is yourcompany - Service okta: Your Okta domain. - Service pipedrive: Your Pipedrive domain. - Service shopware: Your Shopware domain. - Service sistrix: Your SISTRIX domain. - Service solarwinds_service_desk: Your SolarWinds Service Desk domain. - Service uservoice: Domain of your UserVoice site. If it ends with ".uservoice.com", you can specify just the subdomain ("mydomain.uservoice.com" - "mydomain") - Service zendesk: Zendesk domain. - Service zendesk_sunshine: Zendesk domain.
domainHostName String: Field usage depends on service value: - Service workday: Workday host name. - Service workday_financial_management: Workday host name. - Service workday_hcm: Workday host name.
domainName String: Field usage depends on service value: - Service calabrio: Your Calabrio domain name - Service dynamics_365: The custom domain name associated with Dynamics 365. - Service helpshift: Your Helpshift domain name.
domainType String: Field usage depends on service value: - Service medallia: Domain type of your Medallia URL
dsvServiceAuth String
dsvSubscriptionKey String
ecommerceStores List<String>: Field usage depends on service value: - Service mailchimp: List of IDs of the Mailchimp E-Commerce Stores to Sync
edition String
elements List<String>
email String: Field usage depends on service value: - Service appcues: Your Appcues Email. - Service boostr: Your Boostr email. - Service copper: Your Copper email address. - Service email: Send your emails to this address. - Service moloco: Your Moloco account email. - Service netsuite_suiteanalytics: The NetSuite user's email address. - Service pardot: The email of the Pardot user. - Service skuvault: Your SkuVault email. - Service smadex: Your Smadex account's email ID. - Service zendesk: Zendesk email. - Service zendesk_sunshine: Zendesk email.
emailAddress String: Field usage depends on service value: - Service clockodo: Your Clockodo email address.
emailId String: Field usage depends on service value: - Service ordway: Your Ordway user email ID. - Service planful: Your Planful email ID.
emptyHeader Boolean: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service azure_blob_storage: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service box: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service dropbox: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service email: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service ftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service gcs: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service google_drive: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service kinesis: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service s3: 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. - Service sftp: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service share_point: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. - Service wasabi_cloud_storage: 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.
enableAllDimensionCombinations Boolean: Field usage depends on service value: - Service double_click_campaign_manager: Whether to enable all reach dimension combinations in the report. Default value: false
enableArchiveLogOnly Boolean: Field usage depends on service value: - Service sql_server_hva: Use archive log only mode - Service sql_server_sap_ecc_hva: Use archive log only mode
enableDataExtensionsSyncing Boolean
enableDistributedConnectorMode Boolean: Field usage depends on service value: - Service cosmos: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors. - Service dynamodb: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors.
enableEnrichments Boolean: Field usage depends on service value: - Service snowplow: Enable Enrichments
enableExports Boolean: Field usage depends on service value: - Service braze: Enable User Profile Exports
enableTde Boolean: Field usage depends on service value: - Service sql_server_hva: Using Transparent Data Encryption (TDE) - Service sql_server_sap_ecc_hva: Using Transparent Data Encryption (TDE)
encodedPublicKey String: Field usage depends on service value: - Service apple_search_ads: Use the public key to grant Fivetran access to Apple Search Ads api.
encryptionKey String: Field usage depends on service value: - Service marketo: Marketo SOAP API Encryption Key.
endpoint String: Field usage depends on service value: - Service branch: Webhook Endpoint - Service iterable: Register the following URL for webhooks on your Iterable dashboard. - Service marketo: Marketo REST API endpoint. - Service snowplow: Connection-specific collector endpoint. The collector endpoint will have the webhooks.fivetran.com/snowplow/endpoint_ID format. You will need it to configure Snowplow to connect with Fivetran. - Service webhooks: You can send your events to https://webhooks.fivetran.com/webhooks/{endpoint}
engagementAttributionWindow String: Field usage depends on service value: - Service pinterest_ads: The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action.
enrichedExport String: Field usage depends on service value: - Service optimizely: Enriched Events S3 bucket
entityId String: Field usage depends on service value: - Service checkout: Your Checkout.com entity ID. - Service zuora: If is_multi_entity_feature_enabled is true, then it's EntityId. - Service zuora_sandbox: If is_multi_entity_feature_enabled is true, then it's EntityId.
environment String: Field usage depends on service value: - Service bazaarvoice: Your Bazaarvoice environment. - Service buildium: Your Buildium environment. - Service checkout: Your Checkout.com environment. - Service concord: Your Concord environment. - Service deposco: Your Deposco environment. - Service dialpad: Your Dialpad environment. - Service invoiced: Your Invoiced environment. - Service jibble: Your Jibble environment. - Service lucca: Your Lucca environment. - Service procore: Your Procore account environment. - Service reltio: Your Reltio environment. - Service servicetitan: Your ServiceTitan environment. - Service smarthr: Your SmartHR environment. - Service trelica: Your Trelica environment. - Service tremendous: Your Tremendous environment. - Service vts: Your VTS environment. - Service xactly: Your Xactly environment. - Service younium: Your Younium API environment. - Service zuora: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox. - Service zuora_sandbox: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
environmentHost String: Field usage depends on service value: - Service xactly: Your Xactly environment host.
environmentName String: Field usage depends on service value: - Service business_central: Name of the environment
escapeChar String: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service azure_blob_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service box: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service dropbox: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service email: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service ftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service gcs: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service google_drive: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service kinesis: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service s3: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service sftp: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service share_point: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. - Service wasabi_cloud_storage: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
escapeCharOptions String: Field usage depends on service value: - Service gcs: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true. - Service s3: Approach used by CSV parser. Default value: CUSTOM_ESCAPE_CHAR. required for CSV parsing when non_standard_escape_char is true.
euRegion Boolean: Field usage depends on service value: - Service kustomer: Turn it on if your app is on EU region - Service survey_monkey: The SurveyMonkey account region. Specify true, if your account is hosted in the EU region. Default value is false.
events List<String>: Field usage depends on service value: - Service iterable: List of events to sync. Should be specified when sync_mode is SelectedEvents
exportStorageType String: Field usage depends on service value: - Service adjust: Your cloud storage. - Service braze: Export Storage. Required if enable_exports is true
externalId String: Field usage depends on service value: - Service appsflyer: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_cloudtrail: This is the same as your group_id, used for authentication along with the role_arn. - Service aws_cost_report: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service aws_lambda: The external ID is a string that designates who can assume the role. - Service aws_msk: This is the same as your group_id. This is required when sasl_mechanism is set to IAM. - Service azure_function: External ID. - Service cloudfront: This is the same as your group_id, used for authentication along with the role_arn. - Service dynamodb: This is the same as your group_id, used for authentication along with the role_arn. - Service kinesis: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a - Service s3: Used for authentication along with the role_arn. If not provided, it uses connector's group_id. Use the List All Groups endpoint to find the group_id. - Service segment: The external ID is a string that designates who can assume the role. For more information, see a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"Amazon's AWS Identity and Access Management User Guide/a.
facilityCodes String: Field usage depends on service value: - Service unicommerce: Your uniware facility codes.
fields List<String>: Field usage depends on service value: - Service facebook: List of fields which connector will sync. Possible field values.
fileType String: Field usage depends on service value: - Service aws_cost_report: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service azure_blob_storage: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service box: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service dropbox: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service email: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service ftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service gcs: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service google_drive: If your files are saved with improper extensions, you can force them to be synced as the selected filetype. - Service kinesis: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions - Service s3: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service sftp: If your files are saved with improper extensions, you can force them to by synced as the selected file type. - Service share_point: If your files are saved with improper extensions, you can force them to be synced as the selected file type. - Service wasabi_cloud_storage: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
filter String: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
financeAccountSyncMode String: Field usage depends on service value: - Service itunes_connect: Whether to sync all finance accounts or specific finance accounts.
financeAccounts List<String>: Field usage depends on service value: - Service itunes_connect: Specific finance accounts to sync. Must be populated if finance_account_sync_mode is set to SpecificFinanceAccounts.
folder String: Field usage depends on service value: - Service dropbox: Your Dropbox Folder URL.
folderId String: Field usage depends on service value: - Service box: Folder URL - Service google_drive: Folder URL
folderPath String: Field usage depends on service value: - Service adobe_analytics_data_feed: Folder Path - Service one_drive: Your OneDrive folder URL - Service oracle_business_intelligence_publisher: The folder path to save data models and reports.
forecastId String: Field usage depends on service value: - Service clari: Your Clari Forecast id .
ftpHost String: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP host.
ftpPassword String: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP password.
ftpPort Number: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP port.
ftpUser String: Field usage depends on service value: - Service adobe_analytics_data_feed: FTP user.
function String: Field usage depends on service value: - Service aws_lambda: The name of your AWS Lambda Function.
functionApp String: Field usage depends on service value: - Service azure_function: Function app name in Azure portal.
functionKey String: Field usage depends on service value: - Service azure_function: Function key used for authorization.
functionName String: Field usage depends on service value: - Service azure_function: Name of the function to be triggered.
functionTrigger String: Field usage depends on service value: - Service google_cloud_function: The trigger URL of the cloud function.
gcsBucket String: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the cloud_storage_type - Service webhooks: The GCS bucket name. Required if bucket_service is set to GCS.
gcsExportBucket String: Field usage depends on service value: - Service braze: Your GCS bucket. Required if GCS is the export_storage_type
gcsExportFolder String: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the export_storage_type
gcsFolder String: Field usage depends on service value: - Service braze: Your GCS folder name. Required if GCS is the cloud_storage_type
generateFivetranPk Boolean: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
groupId String: Field usage depends on service value: - Service line_ads: Your LINE Ads group ID(s).
groupName String: Field usage depends on service value: - Service fivetran_log: (Optional) The group name of the target_group_id.
hanaBackupPassword String
hanaMode String: Field usage depends on service value: - Service hana_sap_hva_b1: 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. - Service hana_sap_hva_ecc: 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. - Service hana_sap_hva_ecc_netweaver: 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. - Service hana_sap_hva_s4: 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. - Service hana_sap_hva_s4_netweaver: 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.
hasManagePermissions Boolean: Field usage depends on service value: - Service azure_service_bus: The boolean value specifying whether the connection string has manage permissions
historicSyncTimeFrame String: Field usage depends on service value: - Service braze: Range of data in history you would like to include in the initial sync. - Service iterable: The time range for which historical data should be synced. Default value: All Time. - Service klaviyo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service marketo: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service sailthru: Range of historical data you would like to include in the initial sync. Default value: ALL_TIME. - Service salesforce_marketing_cloud: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME.
historicalSyncLimit String: Field usage depends on service value: - Service concur: Historical Sync Limit for the Sync - Service eloqua: Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. - Service pardot: The time range for which historical data should be synced. Default value: All Time.
historicalSyncTimeFrame String: Field usage depends on service value: - Service rokt: Your Rokt historical sync time frame. - Service skimlinks: Your Skimlinks Historical sync time frame. - Service vimeo: Your Vimeo Historical sync time frame. - Service zendesk: Used to configure Historical sync timeframe for selected tables
homeFolder String: Field usage depends on service value: - Service appsflyer: Your S3 home folder path of the Data Locker.
host String: Field usage depends on service value: - Service aurora: DB instance host or IP address. - Service aurora_postgres: DB instance host or IP address. - Service azure_postgres: DB instance host or IP address. - Service azure_sql_db: DB instance host or IP address. - Service azure_sql_managed_db: DB instance host or IP address. - Service clarity: DB instance host or IP address. - Service cockroachdb: DB instance host or IP address. - Service commercetools: Your commercetools host. - Service databricks_db: The host URL for your Databricks account. - Service db2i_hva: A host address of the primary node. It should be a DB instance host/IP address with a port number. - Service db2i_sap_hva: DB instance host or IP address. - Service documentdb: Host IP address of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: DB instance host or IP address. - Service ehr: DB instance host or IP address. - Service elastic_cloud: DB instance host or IP address. - Service es_self_hosted: DB instance host or IP address. - Service ftp: FTP host address. - Service google_cloud_mysql: DB instance host or IP address. - Service google_cloud_postgresql: DB instance host or IP address. - Service google_cloud_sqlserver: DB instance host or IP address. - Service hana_sap_hva_b1: DB instance host or IP address. - Service hana_sap_hva_ecc: DB instance host or IP address. - Service hana_sap_hva_ecc_netweaver: DB instance host or IP address. - Service hana_sap_hva_s4: DB instance host or IP address. - Service hana_sap_hva_s4_netweaver: DB instance host or IP address. - Service heroku_postgres: DB instance host or IP address. - Service jira: The Jira service host address. - Service magento_mysql: DB instance host or IP address. - Service magento_mysql_rds: DB instance host or IP address. - Service maria: DB instance host or IP address. - Service maria_azure: DB instance host or IP address. - Service maria_rds: DB instance host or IP address. - Service marin: The Marin host address. - Service mysql: DB instance host or IP address. - Service mysql_azure: DB instance host or IP address. - Service mysql_rds: DB instance host or IP address. - Service netsuite_suiteanalytics: The NetSuite service host address. - Service opendistro: DB instance host or IP address. - Service opensearch: DB instance host or IP address. - Service oracle: DB instance host or IP address. - Service oracle_ebs: DB instance host or IP address. - Service oracle_hva: DB instance host or IP address. - Service oracle_rac: DB instance host or IP address. - Service oracle_rds: DB instance host or IP address. - Service oracle_sap_hva: DB instance host or IP address. - Service oracle_sap_hva_netweaver: DB instance host or IP address. - Service postgres: DB instance host or IP address. - Service postgres_rds: DB instance host or IP address. - Service redshift_db: Host name - Service sap_hana: The SAP HANA host or IP address. - Service sap_s4hana: The SAP S/4 host or IP address. - Service sftp: SFTP host address. - Service snowflake_db: Host name - Service splunk: The Splunk service host address. - Service sql_server: DB instance host or IP address. - Service sql_server_hva: DB instance host or IP address. - Service sql_server_rds: DB instance host or IP address. - Service sql_server_sap_ecc_hva: DB instance host or IP address.
hostIp String: Field usage depends on service value: - Service azure_blob_storage: IP address of host tunnel machine which is used to connect to the Storage container. - Service azure_service_bus: The IP address of the host machine which we use to connect to ASB via ssh
hostName String: Field usage depends on service value: - Service coassemble: Your Coassemble Hostname. - Service datadog: Your Datadog host name.
hostUrl String: Field usage depends on service value: - Service adobe_commerce: Your Adobe Commerce host url. - Service sparkpost: Your SparkPost host URL.
hostUser String: Field usage depends on service value: - Service azure_blob_storage: Username in the host machine. - Service azure_service_bus: The username on the host machine which we use to connect to ASB via ssh
hostname String: Field usage depends on service value: - Service akamai: Your Akamai hostname. - Service ukg_pro: Your UKG Pro hostname.
hosts List<String>: Field usage depends on service value: - Service azure_cosmos_for_mongo: A list of host addresses for Azure Cosmos DB for Mongo DB. - Service mongo: 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. - Service mongo_sharded: 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.
httpPath String: Field usage depends on service value: - Service databricks_db: http path
identifier String: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management client identifier. - Service statistics_netherlands_cbs: Your Statistics Netherlands CBS catalog identifier.
identity String: Field usage depends on service value: - Service marketo: Marketo REST API identity url.
includeOcapiEndpoints Boolean: Field usage depends on service value: - Service salesforce_commerce_cloud: Whether to sync data through OCAPI endpoints.
instance String: Field usage depends on service value: - Service acumatica: Your Acumatica instance name. - Service coupa: The instance name of your Coupa account in the URL. - Service flywheel_digital: Your Flywheel Digital instance. - Service salesforce_marketing_cloud: The Salesforce Marketing Cloud instance ID - Service servicenow: ServiceNow Instance ID.
instanceNumber String: Field usage depends on service value: - Service hana_sap_hva_b1: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_ecc_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4: Two-digit number (00-97) of the SAP instance within its host. - Service hana_sap_hva_s4_netweaver: Two-digit number (00-97) of the SAP instance within its host. - Service oracle_sap_hva_netweaver: Two-digit number (00-97) of the SAP instance within its host.
instanceUrl String: Field usage depends on service value: - Service sap_business_by_design: The SAP Business ByDesign instance URL.
integrationKey String: Field usage depends on service value: - Service pendo: The integration key of the Pendo account.
ipAddress String: Field usage depends on service value: - Service aveva_pi: IP address of the AF Server
isAccountLevelConnector Boolean: Field usage depends on service value: - Service fivetran_log: (Optional) Retrieve account-level logs.
isAuth2Enabled Boolean: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Default value: false
isCustomApiCredentials Boolean: Field usage depends on service value: - Service twitter_ads: Custom API credentials
isExternalActivitiesEndpointSelected Boolean: Field usage depends on service value: - Service pardot: Whether the EXTERNAL_ACTIVITY table must be synced or not.
isFtps Boolean: Field usage depends on service value: - Service adobe_analytics_data_feed: Use Secure FTP (FTPS).
isKeypair Boolean: Field usage depends on service value: - Service sftp: Whether to use a key pair for authentication. When true, do not use password.
isMultiEntityFeatureEnabled Boolean: Field usage depends on service value: - Service zuora: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false. - Service zuora_sandbox: Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false.
isNewPackage Boolean: Field usage depends on service value: - Service salesforce_marketing_cloud: Indicates that that your installed package uses OAuth 2.0. Default value: false
isPrivateKeyEncrypted Boolean: Field usage depends on service value: - Service snowflake_db: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
isPrivateLinkRequired Boolean: Field usage depends on service value: - Service aws_lambda: We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our PrivateLink documentation. - Service s3: Set to true if you want to connect to S3 bucket over PrivateLink. Default value: false.
isPublic Boolean: Field usage depends on service value: - Service aws_cost_report: Whether you are syncing from a public bucket. Default value: false. - Service kinesis: Is the bucket public? (you don't need an AWS account for syncing public buckets!) - Service s3: Whether you are syncing from a public bucket. Default value: false.
isSailthruConnectEnabled Boolean: Field usage depends on service value: - Service sailthru: Enable this if you want to sync Sailthru Connect
isSecure Boolean: Field usage depends on service value: - Service ftp: Whether the server supports FTPS.
isSftpCredsAvailable Boolean: Field usage depends on service value: - Service salesforce_marketing_cloud: Provide SFTP credentials
isSingleTableMode Boolean: Field usage depends on service value: - Service box: Allows the creation of connector using Merge Mode strategy. - Service dropbox: Allows the creation of connector using Merge Mode strategy. - Service google_drive: Allows the creation of connector using Merge Mode strategy. - Service sftp: Allows the creation of connector using the specified Sync strategy. - Service share_point: Allows the creation of connector using Merge Mode strategy.
isTestAccount Boolean: Field usage depends on service value: - Service adyen: Whether or not your Adyen Account is a Test Account. Default value: false.
isVendor Boolean: Field usage depends on service value: - Service amazon_selling_partner: Whether or not you have a Vendor Account. Default value: false.
issuer String: Field usage depends on service value: - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud issuer name. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud issuer name.
jsonDeliveryMode String: Field usage depends on service value: - Service aws_cost_report: Control how your JSON data is delivered into your destination - Service azure_blob_storage: Control how your JSON data is delivered into your destination - Service box: Control how your JSON data is delivered into your destination - Service dropbox: Control how your JSON data is delivered into your destination - Service email: Control how your JSON data is delivered into your destination - Service ftp: Control how your JSON data is delivered into your destination - Service gcs: Control how your JSON data is delivered into your destination - Service google_drive: Control how your JSON data is delivered into your destination - Service kinesis: Control how your JSON data is delivered into your destination - Service s3: Control how your JSON data is delivered into your destination - Service sftp: Control how your JSON data is delivered into your destination - Service share_point: Control how your JSON data is delivered into your destination - Service wasabi_cloud_storage: Specifies how Fivetran should handle your JSON data. Default value: Packed.
key String: Field usage depends on service value: - Service uservoice: The UserVoice API key.
keyPassword String: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Key Password.
keyStoreType String: Field usage depends on service value: - Service heroku_kafka: Key Store Type
keystore String: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Keystore File as Base64 encoded string.
keystorePassword String: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, enter your Keystore Password.
lastSyncedChangesUtc_ String
latestVersion String
legalEntityId String: Field usage depends on service value: - Service younium: Your Younium legal entity ID.
limitForApiCallsToExternalActivitiesEndpoint Number: Field usage depends on service value: - Service pardot: API limit for the external activities endpoint.
lineSeparator String: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service email: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
listId String: Field usage depends on service value: - Service pigment: Your Pigment list ID.
listOfCompanyIds String: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail list of company IDs.
listStrategy String: Field usage depends on service value: - Service aws_cost_report: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service kinesis: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code. - Service s3: The listing strategy you want to use. Default value: complete_listing.
listSyncMode String: Field usage depends on service value: - Service google_analytics_4_export: The Sync Mode
logJournal String: Field usage depends on service value: - Service db2i_hva: The log journal name. - Service db2i_sap_hva: The log journal name.
logJournalSchema String: Field usage depends on service value: - Service db2i_hva: The log journal schema. - Service db2i_sap_hva: The log journal schema.
logOnGroup String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional. - Service hana_sap_hva_s4_netweaver: Name of the SAP logon group. The default value is PUBLIC. This field is optional.
login String: Field usage depends on service value: - Service rebound_returns: Your ReBound Returns login. - Service the_trade_desk: The Trade Desk email. It is a part of the login credentials. - Service walmart_dsp: Walmart DSP email. It is a part of the login credentials.
loginPassword String: Field usage depends on service value: - Service concur: The SAP Concur password. - Service sage_intacct: The login password. It is a part of the login credentials.
managerAccounts List<String>: Field usage depends on service value: - Service google_ads: The list of the Manager Account IDs whose clients will be synced. Must be populated if sync_mode is set to ManagerAccounts.
maxApiRequestsPerDay Number: Field usage depends on service value: - Service reltio: Maximum API requests per day
merchantId String: Field usage depends on service value: - Service afterpay: Your Afterpay Merchant ID. - Service amazon_selling_partner: The Merchant ID or Vendor Code. - Service avantlink: Your AvantLink Merchant ID. - Service braintree: Your Braintree merchant ID. - Service braintree_sandbox: Your Braintree merchant ID. - Service shareasale: Your ShareASale merchant ID. - Service xsolla: Your Xsolla Merchant ID.
messageType String: Field usage depends on service value: - Service apache_kafka: Kafka message type. - Service aws_msk: The Message type. - Service azure_event_hub: Message type. - Service azure_service_bus: The format of messages in the topic - Service confluent_cloud: Confluent Cloud message type. - Service heroku_kafka: Heroku Kafka message type.
metricId String: Field usage depends on service value: - Service pigment: Your Pigment metric ID.
metrics List<String>: Field usage depends on service value: - Service adroll: The metrics that you want to sync. - Service criteo: Metrics - Service double_click_campaign_manager: Report metrics to include into a sync. - Service google_analytics: The report metrics to include into a sync. - Service google_display_and_video_360: 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.
namedRange String: Field usage depends on service value: - Service google_sheets: The name of the named data range on the sheet that contains the data to be synced.
namespace String: Field usage depends on service value: - Service azure_service_bus: The ASB namespace which we have to sync. Required for AzureActiveDirectory authentication.
networkCode Number: Field usage depends on service value: - Service double_click_publishers: Network code is a unique, numeric identifier for your Ad Manager network.
nonStandardEscapeChar Boolean: Field usage depends on service value: - Service gcs: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false. - Service s3: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: false.
nullSequence String: Field usage depends on service value: - Service aws_cost_report: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service azure_blob_storage: If your CSVs use a special value indicating null, you can specify it here. - Service box: If your CSVs use a special value indicating null, you can specify it here. - Service dropbox: If your CSVs use a special value indicating null, you can specify it here. - Service email: If your CSVs use a special value indicating null, you can specify it here. - Service ftp: If your CSVs use a special value indicating null, you can specify it here. - Service gcs: If your CSVs use a special value indicating null, you can specify it here. - Service google_drive: If your CSVs use a special value indicating null, you can specify it here. - Service kinesis: Optional. If your CSVs use a special value indicating null, you can specify it here. - Service s3: If your CSVs use a special value indicating null, you can specify it here. - Service sftp: If your CSVs use a special value indicating null, you can specify it here. - Service share_point: If your CSVs use a special value indicating null, you can specify it here. - Service wasabi_cloud_storage: If your CSVs use a special value indicating null, you can specify it here.
oauthToken String
oauthTokenSecret String
ocapiClientId String: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client ID.
ocapiClientSecret String: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI Client secret.
ocapiCustomObjectTypes String: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI custom object types.
ocapiHostname String: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce Commerce Cloud OCAPI hostname.
odbcDriverManagerLibraryPath String: Field usage depends on service value: - Service hana_sap_hva_b1: ODBC manager library path - Service hana_sap_hva_ecc: ODBC manager library path - Service hana_sap_hva_s4: ODBC manager library path
odbcSysIniPath String: Field usage depends on service value: - Service hana_sap_hva_b1: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_ecc: odbc.ini and odbcsinst.ini location - Service hana_sap_hva_s4: odbc.ini and odbcsinst.ini location
onError String: Field usage depends on service value: - Service aws_cost_report: 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. - Service azure_blob_storage: 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. - Service box: 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. - Service dropbox: 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. - Service ftp: 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. - Service gcs: 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. - Service google_drive: 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. - Service kinesis: 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. - Service s3: 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. - Service sftp: 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. - Service share_point: 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. - Service wasabi_cloud_storage: 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.
onPremise Boolean: Field usage depends on service value: - Service jira: Whether the Jira instance is local or in cloud.
organization String: Field usage depends on service value: - Service gladly: Your Gladly Organization Name. - Service statuspage: Your Statuspage Organization ID.
organizationDomain String: Field usage depends on service value: - Service adobe_workfront: Your Adobe Workfront organization domain.
organizationId String: Field usage depends on service value: - Service adobe_analytics: Organization ID from the Service Account (JWT) credentials of your Adobe Project. - Service integrate: Your Integrate organization ID. - Service megaphone: Your Megaphone organization ID. - Service productive: Your Productive Organization ID. - Service salesforce_commerce_cloud: The organization ID from Salesforce Commerce Cloud account. - Service sentry: Your Sentry organization ID. - Service zoho_books: Your Zoho Books Organization ID. - Service zoho_inventory: Your Zoho Inventory organization ID.
organizationName String: Field usage depends on service value: - Service brightpearl: Your Brightpearl organization name. - Service confluence: Your Confluence organization name.
organizations List<String>: Field usage depends on service value: - Service apple_search_ads: Organizations - Service snapchat_ads: Specific organizations IDs to sync. Must be populated if syncMode is set to SpecificOrganizations.
packedModeTables List<String>: Field usage depends on service value: - Service azure_cosmos_for_mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service dynamodb: List of tables to be synced in packed mode. - Service firebase: Specific tables to sync. Must be populated if packing_mode is set to SelectTablesForPackedMode. - Service mongo: List of tables to be synced in packed mode; format:db.table(case-sensitive). - Service mongo_sharded: List of tables to be synced in packed mode; format:db.table(case-sensitive).
packingMode String: Field usage depends on service value: - Service azure_cosmos_for_mongo: Indicates the desired sync pack mode. Accepted values are UsePackedModeOnly and UseUnpackedModeOnly. SelectTablesForPackedMode is deprecated. - Service firebase: Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service klaviyo: Packing mode for EVENT and PERSON tables. - Service mongo: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service mongo_sharded: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: UseUnpackedModeOnly. - Service optimizely: Packing mode for conversion and decision tables. - Service sailthru: Packing mode for LIST_STATE and USER tables.
pages List<String>: Field usage depends on service value: - Service facebook_pages: Specific pages to sync. Must be populated if sync_mode is set to SpecificPages.
partnerCode String: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission partner code.
partnerUserId String: Field usage depends on service value: - Service expensify: Your Expensify partnerUserID.
partnerUserSecret String: Field usage depends on service value: - Service expensify: Your Expensify partnerUserSecret.
partners List<String>: Field usage depends on service value: - Service google_display_and_video_360: The list of partners to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW. - Service the_trade_desk: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service walmart_dsp: Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts.
passPhrase String: Field usage depends on service value: - Service qualtrics: Pass Phrase
passphrase String: Field usage depends on service value: - Service snowflake_db: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
password String: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS password. - Service adobe_commerce: Your Adobe Commerce password. - Service akeneo: Your Akeneo password. - Service anaplan: Your Anaplan password. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Password. - Service aurora: The user's password. - Service aurora_postgres: The user's password. - Service azure_cosmos_for_mongo: Password used for source database authentication. - Service azure_postgres: The user's password. - Service azure_sql_db: The user's password. - Service azure_sql_managed_db: The user's password. - Service boostr: Your Boostr password. - Service ceridian_dayforce: Your Ceridian Dayforce Password. - Service cin7: Your Cin7 API Key. - Service clarity: The user's password. - Service cockroachdb: The user's password. - Service collibra: Your collibra password. - Service compliance_checkpoint: Your Compliance Checkpoint account password. - Service contrast_security: Your Contrast Security API Password. - Service db2i_hva: The user's password. - Service db2i_sap_hva: The user's password. - Service deposco: Your Deposco password. - Service documentdb: The user's password. - Service dynamics_365_fo: The user's password. - Service ehr: The user's password. - Service elastic_cloud: The user's password. - Service es_self_hosted: The user's password. - Service ftp: FTP password. - Service globalmeet: Your GlobalMeet Password. - Service google_cloud_mysql: The user's password. - Service google_cloud_postgresql: The user's password. - Service google_cloud_sqlserver: The user's password. - Service green_power_monitor: Your GreenPowerMonitor password. - Service guru: Your Guru password. - Service hana_sap_hva_b1: The user's password. - Service hana_sap_hva_ecc: The user's password. - Service hana_sap_hva_ecc_netweaver: The user's password. - Service hana_sap_hva_s4: The user's password. - Service hana_sap_hva_s4_netweaver: The user's password. - Service heroku_postgres: The user's password. - Service hilti_ontrack: Your Hilti On!Track password. - Service impact: Your Impact Account Token - Service integral_ad_science: Your integral_ad_science password. - Service itunes_connect: Your password - Service jamf: Your Jamf password. - Service jira: The Jira user's password. - Service khoros_care: Your Khoros Care password. - Service kissmetrics: Your Kissmetrics API Password. - Service klarna: Your Klarna Password. - Service lessonly: Your Lessonly password. - Service magento_mysql: The user's password. - Service magento_mysql_rds: The user's password. - Service maria: The user's password. - Service maria_azure: The user's password. - Service maria_rds: The user's password. - Service marin: The Marin user's password. - Service moloco: Your Moloco account password. - Service mongo: The user's password. - Service mongo_sharded: The user's password. - Service myosh: Your myosh password. - Service mysql: The user's password. - Service mysql_azure: The user's password. - Service mysql_rds: The user's password. - Service netsuite_suiteanalytics: The NetSuite user's password. - Service opendistro: The user's password. - Service opensearch: The user's password. - Service oracle: The user's password. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence user password. - Service oracle_ebs: The user's password. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud user password. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud user password. - Service oracle_hva: The user's password. - Service oracle_rac: The user's password. - Service oracle_rds: The user's password. - Service oracle_sap_hva: The user's password. - Service oracle_sap_hva_netweaver: The user's password. - Service outbrain: The Outbrain user's password. - Service pardot: The Pardot user's password. - Service partnerize: Your Partnerize account's password. - Service podio: Your Podio account password. - Service postgres: The user's password. - Service postgres_rds: The user's password. - Service qmatic_data_connect: Your Qmatic Data Connect password. - Service redshift_db: The Redshift user's password. - Service revx: Your RevX Password. - Service rtb_house: Your RTB House password. - Service sap_business_by_design: The SAP Business ByDesign password. - Service sap_hana: Your SAP HANA password. - Service sap_s4hana: Your SAP S/4 password. - Service scorm: Your Scorm Secret Key. - Service servicenow: Your account password. - Service sftp: SFTP password. - Service shiphero: Your ShipHero password. - Service shipstation: Your ShipStation password. - Service shopware: Your Shopware password. - Service skuvault: Your SkuVault password. - Service smadex: Your Smadex Password. - Service snowflake_db: The Snowflake user's password. - Service splash: Your Splash password. - Service splunk: The Splunk user's password. - Service sql_server: The user's password. - Service sql_server_hva: The user's password. - Service sql_server_rds: The user's password. - Service sql_server_sap_ecc_hva: The user's password. - Service starrez: Your StarRez API password - Service stickyio: Your sticky.io password. - Service stylight: Your Stylight Password. - Service sugarcrm: Your SugarCRM password. - Service teamwork: Your Teamwork password. - Service the_trade_desk: The Trade Desk password. It is a part of the login credentials. - Service toggl_track: Your Toggl Track Password - Service ukg_pro: Your UKG Pro password. - Service unicommerce: Your uniware login password. - Service upland: Your Upland Software Password. - Service veevavault: Your Veeva Vault password. - Service walmart_dsp: Walmart DSP password. It is a part of the login credentials. - Service when_i_work: Your When I Work password. - Service wherefour: Your Wherefour password. - Service workday: Workday password. - Service workday_financial_management: Workday password. - Service workday_hcm: Workday password. - Service xandr: Your Xandr password. - Service younium: Your Younium password.
pat String: Field usage depends on service value: - Service github: The Personal Access Token generated in Github.
patName String: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Name.
patSecret String: Field usage depends on service value: - Service tableau_source: Your Tableau Source PAT Secret.
path String: Field usage depends on service value: - Service jira: A URL subdirectory where the Jira instance is working.
pats List<String>: Field usage depends on service value: - Service github: The Personal Access Tokens.
pattern String: Field usage depends on service value: - Service aws_cost_report: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service azure_blob_storage: All files in your search path matching this regular expression will be synced. - Service box: All files in your search path matching this regular expression will be synced. - Service dropbox: All files in your search path matching this regular expression will be synced. - Service email: All files in your search path matching this regular expression will be synced. - Service ftp: All files in your search path matching this regular expression will be synced. - Service gcs: All files in your search path matching this regular expression will be synced. - Service google_drive: All files in your search path matching this regular expression will be synced. - Service kinesis: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional. - Service s3: All files in your search path matching this regular expression will be synced. - Service sftp: All files in your search path matching this regular expression will be synced. - Service share_point: All files in your search path matching this regular expression will be synced. - Service wasabi_cloud_storage: All files in your search path matching this regular expression will be synced.
pdbName String: Field usage depends on service value: - Service oracle: Optional: Required only for containerized database. - Service oracle_ebs: Optional: Required only for containerized database. - Service oracle_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases. - Service oracle_rac: Optional: Required only for containerized database. - Service oracle_rds: Optional: Required only for containerized database. - Service oracle_sap_hva: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
pemCertificate String: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM certificate file. Must be populated if is_auth2_enabled is set to false.
pemPrivateKey String: Field usage depends on service value: - Service apple_search_ads: The contents of your PEM secret key file. Must be populated if is_auth2_enabled is set to true.
perInteractionDimensions List<String>: Field usage depends on service value: - Service double_click_campaign_manager: Per Interaction Dimensions.
personalAccessToken String: Field usage depends on service value: - Service cj_commission_detail: Your CJ Commission Detail personal access token. - Service databricks_db: Access Token - Service harvest: Your Harvest Personal Access Token. - Service productive: Your Productive personal access token. - Service totango: Your Totango personal access token.
personalApiToken String: Field usage depends on service value: - Service circleci: Your CircleCI Personal API token. - Service monday: Your Monday.com Personal API Token.
pgpPassPhrase String: Field usage depends on service value: - Service azure_blob_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The PGP passphrase used to create the key. Must be populated if use_pgp_encryption_options is set to true.
pgpSecretKey String: Field usage depends on service value: - Service azure_blob_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service ftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service gcs: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service s3: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service sftp: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true. - Service wasabi_cloud_storage: The contents of your PGP secret key file. Must be populated if use_pgp_encryption_options is set to true.
phoneNumber String: Field usage depends on service value: - Service itunes_connect: Register the number on AppleId Account Page for 2FA
planType String: Field usage depends on service value: - Service justcall: Your JustCall Plan Type.
port Number: Field usage depends on service value: - Service aurora: The port number. - Service aurora_postgres: The port number. - Service aveva_pi: Port number at which the AF Server is running - Service azure_postgres: The port number. - Service azure_sql_db: The port number. - Service azure_sql_managed_db: The port number. - Service clarity: The port number. - Service cockroachdb: The port number. - Service databricks_db: The port of your SQL warehouse. - Service db2i_hva: The port number. - Service db2i_sap_hva: The port number. - Service documentdb: Port of the primary node. Ignored if hosts value is provided. - Service dynamics_365_fo: The port number. - Service ehr: The port number. - Service elastic_cloud: The port number. - Service es_self_hosted: The port number. - Service ftp: FTP port. - Service google_cloud_mysql: The port number. - Service google_cloud_postgresql: The port number. - Service google_cloud_sqlserver: The port number. - Service hana_sap_hva_b1: The port number. - Service hana_sap_hva_ecc: The port number. - Service hana_sap_hva_ecc_netweaver: The port number. - Service hana_sap_hva_s4: The port number. - Service hana_sap_hva_s4_netweaver: The port number. - Service heroku_postgres: The port number. - Service jira: The Jira service host port. - Service magento_mysql: The port number. - Service magento_mysql_rds: The port number. - Service maria: The port number. - Service maria_azure: The port number. - Service maria_rds: The port number. - Service mysql: The port number. - Service mysql_azure: The port number. - Service mysql_rds: The port number. - Service netsuite_suiteanalytics: The NetSuite service host port. - Service opendistro: The port number. - Service opensearch: The port number. - Service oracle: The port number. - Service oracle_ebs: The port number. - Service oracle_hva: The port number. - Service oracle_rac: The port number. - Service oracle_rds: The port number. - Service oracle_sap_hva: The port number. - Service postgres: The port number. - Service postgres_rds: The port number. - Service redshift_db: Port number - Service sap_hana: The SAP HANA port number. - Service sap_s4hana: The SAP S/4 port number. - Service sftp: SFTP port. - Service snowflake_db: The Snowflake optional port number. - Service splunk: The Splunk service host port. - Service sql_server: The port number. - Service sql_server_hva: The port number. - Service sql_server_rds: The port number. - Service sql_server_sap_ecc_hva: The port number.
postClickAttributionWindowSize String: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on clicks. Default value: DAY_30
prebuiltReport String: Field usage depends on service value: - Service facebook: The name of report of which connector will sync the data. Possible prebuilt_report values. - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data.
prefix String: Field usage depends on service value: - Service aws_cloudtrail: If prefix is present when configuring the bucket. - Service aws_cost_report: Folder path to the aws_cost_report files within the bucket. - Service aws_inventory: The prefix if you used one when configuring the bucket. - Service azure_blob_storage: All files and folders under this folder path will be searched for files to sync. - Service box: All files and folders under this folder path will be searched for files to sync. - Service cloudfront: The name of the CloudFront folder in the bucket. - Service dropbox: All files and folders under this folder path will be searched for files to sync. - Service ftp: All files and folders under this folder path will be searched for files to sync. - Service gcs: All files and folders under this folder path will be searched for files to sync. - Service google_drive: 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 - Service kinesis: Folder path to the Kinesis files within the bucket. - Service marin: Folder path to the Marin manifest file. - Service microsoft_dynamics_365_fo: Folder name in which the exported dynamics 365 data resides. - Service s3: All files and folders under this folder path will be searched for files to sync. - Service segment: Folder path to the Segment files within the bucket. Must be populated if sync_type is set to S3. - Service sftp: All files and folders under this folder path will be searched for files to sync. - Service share_point: All files and folders under this folder path link will be searched for files to sync. This can be any shared folder link. - Service wasabi_cloud_storage: All files and folders under this folder path will be searched for files to sync.
primaryKey String: Field usage depends on service value: - Service care_quality_commission: Your Care Quality Commission primary key.
primaryKeys List<String>: Field usage depends on service value: - Service workday: Primary Keys
privateKey String: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS REST API private key. - Service adobe_analytics: The complete contents of your private key file including the start and end tags (----BEGIN PRIVATE KEY---- to ----END PRIVATE KEY----). - Service adp_workforce_now: Private Key. - Service anaplan: The contents of your private key file. Must be populated if auth_mode is set to Certificate. - Service apple_search_ads: The contents of your secret key file. Must be populated if is_auth2_enabled is set to false. - Service braintree: The contents of your secret key file. - Service braintree_sandbox: The contents of your secret key file. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud private key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud private key. - Service qualtrics: Your private key - Service salesforce: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service salesforce_sandbox: Provide content of the .key private key (only when authentication_method = ADVANCED). - Service snowflake_db: Private access key. The field should be specified if authentication type is KEY_PAIR.
privateToken String: Field usage depends on service value: - Service eventbrite: Your Eventbrite private token.
product String: Field usage depends on service value: - Service webconnex: Your Webconnex product.
profiles List<String>: Field usage depends on service value: - Service amazon_ads: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SpecificProfiles. - Service google_analytics: Specific User Profile IDs to sync. Must be populated if syncMode is set to SpecificAccounts. - Service google_analytics_mcf: Specific User Profile IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
profilesAmazonDsp String: Field usage depends on service value: - Service amazon_dsp: Comma-separated list of your Amazon DSP profiles.
projectAccessToken String: Field usage depends on service value: - Service rollbar: Your Rollbar project access token.
projectCredentials List<Property Map>: Field usage depends on service value: - Service amplitude: * Project(s)
projectId String: Field usage depends on service value: - Service bigquery_db: BigQuery project ID - Service google_analytics_360: The project ID. - Service google_analytics_4_export: The Project ID. - Service mixpanel: Project ID
projectIds String: Field usage depends on service value: - Service sentry: Your Sentry project IDs.
projectKey String: Field usage depends on service value: - Service commercetools: Your commercetools project key.
projects List<String>: Field usage depends on service value: - Service asana: Specific Project IDs to sync. Must be populated if syncMode is set to SpecificProjects. - Service jira: Specific projects to sync. Must be populated if syncMode is set to CUSTOM.
properties List<String>: Field usage depends on service value: - Service google_analytics_4: The array of strings in the properties/{id} format where id is a Google Analytics 4 property identifier. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS.
propertyId String: Field usage depends on service value: - Service cloudbeds: Your Cloudbeds property IDs.
publicKey String: Field usage depends on service value: - Service aurora: Public Key - Service aurora_postgres: Public Key - Service azure_blob_storage: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_cosmos_for_mongo: Public Key - Service azure_postgres: Public Key - Service azure_service_bus: Public key generated by Fivetran to be copied into the host-machine's authorized keys file. - Service azure_sql_db: Public Key. - Service azure_sql_managed_db: Public Key. - Service braintree: The contents of your PEM certificate file. - Service braintree_sandbox: The contents of your PEM certificate file. - Service clarity: Public Key. - Service cockroachdb: Public Key - Service db2i_hva: Public Key - Service db2i_sap_hva: Public Key - Service documentdb: Public Key - Service dynamics_365_fo: Public Key. - Service ehr: Public Key. - Service elastic_cloud: Public Key - Service es_self_hosted: Public Key - Service google_cloud_mysql: Public Key - Service google_cloud_postgresql: Public Key - Service google_cloud_sqlserver: Public Key. - Service hana_sap_hva_b1: Public Key - Service hana_sap_hva_ecc: Public Key - Service hana_sap_hva_ecc_netweaver: Public Key - Service hana_sap_hva_s4: Public Key - Service hana_sap_hva_s4_netweaver: Public Key - Service heroku_postgres: Public Key - Service magento_mysql: Public Key - Service magento_mysql_rds: Public Key - Service maria: Public Key - Service maria_azure: Public Key - Service maria_rds: Public Key - Service mongo: Public Key - Service mongo_sharded: Public Key - Service mysql: Public Key - Service mysql_azure: Public Key - Service mysql_rds: Public Key - Service opendistro: Public Key - Service opensearch: Public Key - Service oracle: Public Key - Service oracle_ebs: Public Key - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud public key. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud public key. - Service oracle_hva: Public Key - Service oracle_rac: Public Key - Service oracle_rds: Public Key - Service oracle_sap_hva: Public Key - Service partnerstack_vendor: Your PartnerStack Vendor Public key. - Service postgres: Public Key - Service postgres_rds: Public Key - Service sap_hana: Public Key - Service sap_s4hana: Public Key - Service sftp: Public Key - Service sql_server: Public Key. - Service sql_server_hva: Public Key. - Service sql_server_rds: Public Key. - Service sql_server_sap_ecc_hva: Public Key.
publicationName String: Field usage depends on service value: - Service aurora_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service azure_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service google_cloud_postgresql: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service heroku_postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT". - Service postgres_rds: Publication name. Specify only for "updated_method": "WAL_PGOUTPUT".
publisherId String: Field usage depends on service value: - Service skimlinks: Your Skimlinks publisher ID.
pullArchivedCampaigns Boolean: Field usage depends on service value: - Service outbrain: Include or ignore results from archived campaigns
pythonVersion String
queryId String: Field usage depends on service value: - Service google_display_and_video_360: The ID of the query whose configuration you want to reuse. This is a required parameter when config_method is set to REUSE_EXISTING.
queryParamValue String: Field usage depends on service value: - Service alchemer: Your Alchemer API key. - Service birdeye: Your Birdeye query-param-value.
quotaProjectId String: Field usage depends on service value: - Service bigquery_db: Specify a different project ID to account for quota and billing of Fivetran query workload
quoteChar String: Field usage depends on service value: - Service azure_blob_storage: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service gcs: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service google_drive: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service s3: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service sftp: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. - Service share_point: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
quoteCharacterEnabled Boolean: Field usage depends on service value: - Service azure_blob_storage: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service gcs: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service google_drive: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service s3: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service sftp: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. - Service share_point: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
rateLimitPlan String: Field usage depends on service value: - Service vimeo: Your Vimeo rate limit plan.
refreshToken String: Field usage depends on service value: - Service ironsource: Your Ironsource Client Secret.
refreshTokenExpiresAt String: Field usage depends on service value: - Service pinterest_ads: The expiration date of the refresh token. Unix timestamp in seconds
region String: Field usage depends on service value: - Service algolia: Your Algolia analytics region. - Service amazon_ads: The region used by the Amazon Ads profile. - Service amazon_selling_partner: The region used by the Amazon Selling Partner profile. - Service anaplan: Your Anaplan account region - Service atlassian_ops_genie: Your company's Osgenie region (usually company.opsgenie.com) - Service awin: Your Awin Region. - Service aws_lambda: The AWS region code for the DynamoDB instance. - Service bigin_by_zoho_crm: Your Bigin by Zoho CRM Region - Service concur: The region. - Service cvent: Your Cvent region. - Service everflow: Your Everflow region. - Service exact_online: Your Exact Online region. - Service getfeedback: Your GetFeedback region. - Service happyfox: Your HappyFox region. - Service keypay: Your KeyPay region. - Service medallia_agile_research: Your Medallia Agile region. - Service messagebird: Your MessageBird Account region. - Service mixpanel: Data Region - Service navan: Your Navan region. - Service on24: Your ON24 region. - Service pendo: The Pendo account region. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Region. - Service ringover: Your Ringover region. - Service samsara: The region of your Samsara account. For instance, if your region is EUROPE, provide eu.samsara in the Region field. If your region is not in Europe, provide samsara. - Service snyk: Your Snyk region. - Service talkdesk: Your Talkdesk region (".com",".eu","ca.com") - Service totango: Your Totango region. - Service transcend: Your Transcend region. - Service vonage_contact_center: Your Vonage Contact Center region. - Service wasabi_cloud_storage: The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: US_EAST_1. - Service workday_strategic_sourcing: Your Workday Strategic Sourcing Region. - Service zoho_books: Your Zoho Books application host region. - Service zoho_campaigns: Your Zoho Campaigns application host region. - Service zoho_desk: Your Zoho Desk domain. - Service zoho_inventory: Your Zoho Inventory application host region.
regionApiUrl String: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution API URL region.
regionAuthUrl String: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution auth URL region.
regionTokenUrl String: Field usage depends on service value: - Service amazon_attribution: Your Amazon Attribution token URL region.
regionUrl String: Field usage depends on service value: - Service playvox_workforce_management: Your Playvox Workforce Management region URL.
replicaId Number: Field usage depends on service value: - Service aurora: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service google_cloud_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service magento_mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service maria_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_azure: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group. - Service mysql_rds: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
replicationSlot String: Field usage depends on service value: - Service aurora_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service azure_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service google_cloud_postgresql: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service heroku_postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT". - Service postgres_rds: Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT".
reportConfigs List<Property Map>: Field usage depends on service value: - Service yahoo_dsp: Specify the reports you want to sync. This is optional.
reportConfigurationIds List<String>: Field usage depends on service value: - Service double_click_campaign_manager: You can select only one Floodlight Configuration ID per account.
reportFormatType String: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
reportGranularity String: Field usage depends on service value: - Service pinterest_ads: Granularity at which reports will be
reportKeys String: Field usage depends on service value: - Service rakutenadvertising: Your Rakuten Advertising report keys.
reportLists List<Property Map>: Field usage depends on service value: - Service spotify_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
reportServiceApiKey String: Field usage depends on service value: - Service adyen: Your Report Service API key.
reportSuites List<String>
reportTimezone String: Field usage depends on service value: - Service criteo: Report Timezone
reportType String: Field usage depends on service value: - Service adroll: The report type you want. Default value: ALL_ADS. - Service double_click_campaign_manager: Type of reporting data to sync. Default value: STANDARD. - Service google_display_and_video_360: The type of the report to create. This is a required parameter when config_method is set to CREATE_NEW. - Service youtube_analytics: The name of report of which connector will sync the data.
reportUrl String: Field usage depends on service value: - Service workday: URL for a live custom report.
reports List<Property Map>: Field usage depends on service value: - Service google_ads: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_analytics_4: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. - Service google_search_ads_360: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service google_search_console: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. - Service workday: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
reportsLinkedinAds List<String>: Field usage depends on service value: - Service linkedin_ads: Specific analytics reports to sync. Must be populated if adAnalytics is set to 'SpecificReports'.
repositories List<String>: Field usage depends on service value: - Service github: Specific Repository IDs to sync. Must be populated if syncMode is set to SpecificRepositories.
resourceToken String: Field usage depends on service value: - Service cosmos: A token that provides access to a specific Azure Cosmos DB resource. Required for the RESOURCE_TOKEN data access method.
resourceUrl String: Field usage depends on service value: - Service dynamics_365: URL at which Dynamics 365 is accessed
restApiLimit Number: Field usage depends on service value: - Service pardot: The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
rfcLibraryPath String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service hana_sap_hva_s4_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files. - Service oracle_sap_hva_netweaver: Directory path containing the SAP NetWeaver RFC SDK library files.
role String: Field usage depends on service value: - Service netsuite_suiteanalytics: The NetSuite Role ID for connection. - Service snowflake_db: Snowflake Connector role name
roleArn String: Field usage depends on service value: - Service appsflyer: S3 Role ARN - Service aws_cloudtrail: The Role ARN required for authentication. - Service aws_cost: The Role ARN required for authentication. - Service aws_cost_report: The Role ARN required for authentication. - Service aws_inventory: The Role ARN required for authentication. - Service aws_lambda: The Role ARN required for authentication. - Service aws_msk: If sasl_mechanism is set to IAM, enter your Role ARN - Service cloudfront: The Role ARN required for authentication. - Service dynamodb: Role ARN - Service heap: The Role ARN required for authentication. - Service kinesis: The Role ARN required for authentication. - Service s3: The Role ARN required for authentication. Required for connector creation when syncing using private bucket. - Service segment: The Role ARN required for authentication. Must be populated if sync_type is set to S3.
rollbackWindow Number: Field usage depends on service value: - Service appsflyer: Rollback window
rollbackWindowSize Number: Field usage depends on service value: - Service bingads: A period of time in days during which a conversion is recorded.
s3Bucket String: Field usage depends on service value: - Service webhooks: The S3 bucket name. Required if bucket_service is set to S3.
s3ExportBucket String: Field usage depends on service value: - Service braze: Your S3 user export bucket. Required if AWS_S3 is the export_storage_type
s3ExportExternalId String: Field usage depends on service value: - Service braze: This is the same as your group_id, used if export_storage_type is AWS_S3
s3ExportFolder String: Field usage depends on service value: - Service braze: Your S3 user export folder name. Required if AWS_S3 is the export_storage_type
s3ExportRoleArn String: Field usage depends on service value: - Service braze: The Role ARN required for authentication required if AWS_S3 is the export_storage_type
s3RoleArn String: Field usage depends on service value: - Service adjust: Used if the export_storage_type is AWS_S3, the Role ARN required for authentication. - Service webhooks: The Role ARN required for authentication. Required if bucket_service is set to S3.
s3bucket String: Field usage depends on service value: - Service adobe_analytics_data_feed: The S3 bucket name. - Service braze: Your S3 bucket required if AWS_S3 is the cloud_storage_type - Service sailthru: Name of the bucket configured to receive sailthru connect data.
s3externalId String: Field usage depends on service value: - Service braze: 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 - Service sailthru: The external ID is a string that designates who can assume the role.
s3folder String: Field usage depends on service value: - Service braze: Your S3 folder name required if AWS_S3 is the cloud_storage_type
s3path String: Field usage depends on service value: - Service sailthru: Copy and use this to configure Sailthru Connect in your sailthru account.
s3roleArn String: Field usage depends on service value: - Service adobe_analytics_data_feed: The Role ARN required for authentication. - Service braze: The Role ARN required for authentication required if AWS_S3 is the cloud_storage_type - Service sailthru: Role ARN of the IAM role created for Fivetran.
salesAccountSyncMode String: Field usage depends on service value: - Service itunes_connect: Whether to sync all sales accounts or specific sales accounts.
salesAccounts List<String>: Field usage depends on service value: - Service itunes_connect: Specific sales account to sync. Must be populated if sales_account_sync_mode is set to SpecificSalesAccounts.
salesforceSecurityToken String: Field usage depends on service value: - Service pardot: The Pardot user's Salesforce SSO Account Security Token.
sandboxAccount String: Field usage depends on service value: - Service gocardless: Your GoCardless account type.
sapSchema String: Field usage depends on service value: - Service db2i_hva: The SAP schema. - Service db2i_sap_hva: SAP schema name. - Service sql_server_hva: SAP Schema Name. Required only for High-Volume Agent SAP ECC connector. - Service sql_server_sap_ecc_hva: SAP Schema Name.
sapSourceSchema String: Field usage depends on service value: - Service hana_sap_hva_b1: The schema name where the HANA tables reside. - Service hana_sap_hva_ecc: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_ecc_netweaver: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4: The Hana schema name where the SAP tables reside. - Service hana_sap_hva_s4_netweaver: The Hana schema name where the SAP tables reside.
sapUser String: Field usage depends on service value: - Service oracle_sap_hva: The Oracle schema name where the SAP tables reside.
saslMechanism String: Field usage depends on service value: - Service apache_kafka: SASL Mechanism - Service aws_msk: If security_protocol is set to SASL, enter the SASL Mechanism
saslPlainKey String: Field usage depends on service value: - Service apache_kafka: API Key
saslPlainSecret String: Field usage depends on service value: - Service apache_kafka: API Secret
saslScram256Key String: Field usage depends on service value: - Service apache_kafka: API Key
saslScram256Secret String: Field usage depends on service value: - Service apache_kafka: API Secret
saslScram512Key String: Field usage depends on service value: - Service apache_kafka: API Key - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
saslScram512Secret String: Field usage depends on service value: - Service apache_kafka: API Secret - Service aws_msk: If sasl_mechanism is set to SCRAM_SHA_512, enter your secret's saslScram512Key.
schemaRegistryCredentialsSource String: Field usage depends on service value: - Service apache_kafka: Schema Registry Credentials source - Service aws_msk: Schema Registry Credentials source - Service confluent_cloud: Schema Registry Credentials source
schemaRegistryKey String: Field usage depends on service value: - Service apache_kafka: Schema Registry Key - Service aws_msk: Schema Registry Key - Service azure_service_bus: The key used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Key
schemaRegistrySecret String: Field usage depends on service value: - Service apache_kafka: Schema Registry Secret - Service aws_msk: Schema Registry Secret - Service azure_service_bus: The secret used to access the schema registry. Required for the avro and protobuf message types - Service confluent_cloud: Schema Registry Secret
schemaRegistryUrls List<String>: Field usage depends on service value: - Service apache_kafka: Your schema registry URLs - Service aws_msk: Your schema registry URLs - Service azure_service_bus: The comma-separated list of schema registry servers in the server:port format - Service confluent_cloud: Your schema registry URLs
scope String: Field usage depends on service value: - Service ebay: Your eBay scopes.
scopes String: Field usage depends on service value: - Service cornerstone: Your Cornerstone scopes.
seats List<String>: Field usage depends on service value: - Service yahoo_dsp: Specific Seats to sync. Must be populated if sync_mode_seat is set to SPECIFIC_SEATS.
secret String: Field usage depends on service value: - Service appcues: Your Appcues Secret. - Service buildium: Your Buildium API secret. - Service canvas_data_2_by_instructure: Your Canvas Data 2 by Instructure secret. - Service loopio: Your Loopio Secret. - Service mode: Your Mode Secret. - Service playvox_workforce_management: Your Playvox Workforce Management client secret. - Service twilio: The Twilio API secret - Service uservoice: The UserVoice API secret. - Service venminder: Your Venminder secret. - Service vts: Your VTS secret.
secretKey String: Field usage depends on service value: - Service afterpay: Your Afterpay Secret Key. - Service appsflyer: Your AWS secret key. - Service bigquery_db: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service checkr: Your Checkr secret key. - Service ezofficeinventory: Your EZOfficeInventory API secret key. - Service gcs: Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket. - Service ironsource: Your Ironsource Client ID. - Service line_ads: Your LINE Ads secret key. - Service mailjet: Your Mailjet secret key. - Service partnerstack_vendor: Your PartnerStack Vendor Secret key. - Service paypal: Client Secret of your PayPal client application. - Service paypal_sandbox: Client Secret of your PayPal client application. - Service phoenix_ads: Your Phoenix Ads Secret key. - Service retailnext: Your RetailNext secret key. - Service statsig: Your Statsig secret key. - Service yotpo: Your Yotpo Secret key
secrets String: Field usage depends on service value: - Service aws_lambda: The secrets that should be passed to the function at runtime. - Service azure_function: The secrets that should be passed to the function at runtime. - Service google_cloud_function: The secrets that should be passed to the function at runtime.
secretsLists List<Property Map>: Field usage depends on service value: - Service aws_lambda: List of Secrets that should be passed to the function at runtime. - Service azure_function: The list of secrets that should be passed to the function at runtime. - Service google_cloud_function: The list of secrets that should be passed to the function at runtime.
securityProtocol String: Field usage depends on service value: - Service apache_kafka: Security protocol for Kafka interaction. - Service aws_msk: The security protocol for Kafka interaction. - Service confluent_cloud: Security protocol for Confluent Cloud interaction. - Service heroku_kafka: Security protocol for Heroku Kafka interaction.
segments List<String>: Field usage depends on service value: - Service google_analytics: 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.
selectedEventTypes List<String>: Field usage depends on service value: - Service salesforce_marketing_cloud: Select the event types to be synced.
selectedExports List<String>: Field usage depends on service value: - Service anaplan: 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.
senderId String: Field usage depends on service value: - Service sage_intacct: Your Sender ID
senderPassword String: Field usage depends on service value: - Service sage_intacct: Your Sender Password
server String: Field usage depends on service value: - Service castor_edc: Your Castor EDC Server.
serverAddress String: Field usage depends on service value: - Service tableau_source: Your Tableau Source server address.
serverRegion String: Field usage depends on service value: - Service clockify: Your Clockify server region.
serverUrl String: Field usage depends on service value: - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence Instance URL. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud Instance URL. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud Instance URL.
serverVariable String: Field usage depends on service value: - Service myosh: Your myosh server variable.
servers List<String>: Field usage depends on service value: - Service apache_kafka: Comma-separated list of Kafka servers in the format server:port. - Service aws_msk: Comma-separated list of Kafka servers in the server:port format. - Service confluent_cloud: Comma-separated list of Confluent Cloud servers in the format server:port. - Service heroku_kafka: Comma-separated list of Heroku Kafka servers in the format server:port.
serviceAccount String: Field usage depends on service value: - Service google_drive: Share the folder with the email address
serviceAccountEmail String: Field usage depends on service value: - Service google_cloud_function: Provide Invoker role to this service account.
serviceAccountKey String: Field usage depends on service value: - Service firebase: The contents of your service account key file. Required for authentication.
serviceAccountSecret String: Field usage depends on service value: - Service mixpanel: Service Account Secret
serviceAccountUsername String: Field usage depends on service value: - Service mixpanel: Service Account Username
serviceAuthentication String: Field usage depends on service value: - Service dsv: A base64 encoded variant of your username:password string. Required for authentication.
serviceName String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service. - Service walmart_marketplace: Your Walmart Marketplace service name.
serviceVersion String
sftpHost String: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP host. - Service salesforce_marketing_cloud: Host
sftpIsKeyPair Boolean: Field usage depends on service value: - Service adobe_analytics_data_feed: Log in with key pair or password - Service salesforce_marketing_cloud: Set this field if you use a key pair for logging into your SFTP server. Don't set it if you use a username and password
sftpPassword String: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP password required if sftp_is_key_pair is false - Service salesforce_marketing_cloud: Password
sftpPort Number: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP port. - Service salesforce_marketing_cloud: Port
sftpPublicKey String: Field usage depends on service value: - Service adobe_analytics_data_feed: Public Key - Service salesforce_marketing_cloud: Public Key
sftpUser String: Field usage depends on service value: - Service adobe_analytics_data_feed: SFTP user. - Service salesforce_marketing_cloud: User
shareUrl String: Field usage depends on service value: - Service share_point: Your SharePoint folder URL. You can find the folder URL by following the steps mentioned here.
sheetId String: Field usage depends on service value: - Service google_sheets: 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.
shop String: Field usage depends on service value: - Service shopify: The Shopify shop name. Can be found in the URL before .myshopify.com.
shopDomain String: Field usage depends on service value: - Service triple_whale: Your Triple Whale shop domain.
shortCode String: Field usage depends on service value: - Service salesforce_commerce_cloud: The Salesforce eight-character string assigned to a realm for routing purposes.
shouldSyncEventsWithDeletedProfiles Boolean: Field usage depends on service value: - Service klaviyo: Sync events linked to deleted profiles
showRecordsWithNoMetrics Boolean: Field usage depends on service value: - Service apple_search_ads: Turn the toggle on if you want the reports to also return records without metrics.
sid String: Field usage depends on service value: - Service twilio: The Twilio API key SID
signerPublicKey String: Field usage depends on service value: - Service azure_blob_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service ftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service gcs: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service s3: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service sftp: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed. - Service wasabi_cloud_storage: The contents of the signer's public key file. Must be populated if use_pgp_encryption_options is set to true and PGP encrypted files are signed.
siteAddress String: Field usage depends on service value: - Service teamwork: Your Teamwork site address.
siteId String: Field usage depends on service value: - Service microsoft_lists: The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the id field in the Graph API response for sites. - Service salesforce_commerce_cloud: The name of the site from which you want to sync data.
siteName String: Field usage depends on service value: - Service microsoft_lists: The Name of the SharePoint site. The Site Name is the name field in the Graph API response for sites. - Service tableau_source: Your Tableau Source site name.
siteUrls List<String>: Field usage depends on service value: - Service google_search_console: Specific Site URLs to sync. Must be populated if sync_mode is set to SpecificSites.
skipAfter Number: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service box: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service dropbox: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service email: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service ftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service gcs: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service google_drive: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination. - Service sftp: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service share_point: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. - Service wasabi_cloud_storage: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
skipBefore Number: Field usage depends on service value: - Service aws_cost_report: Enter 1 or greater - Service azure_blob_storage: We will skip over the number of lines specified before syncing data. - Service box: We will skip over the number of lines specified before syncing data. - Service dropbox: We will skip over the number of lines specified before syncing data. - Service email: We will skip over the number of lines specified before syncing data. - Service ftp: We will skip over the number of lines specified before syncing data. - Service gcs: We will skip over the number of lines specified before syncing data. - Service google_drive: We will skip over the number of lines specified before syncing data. - Service kinesis: Enter 1 or greater - Service s3: We will skip over the number of lines specified before syncing data. - Service sftp: We will skip over the number of lines specified before syncing data. - Service share_point: We will skip over the number of lines specified before syncing data. - Service wasabi_cloud_storage: We will skip over the number of lines specified before syncing data.
skipEmptyReports Boolean: Field usage depends on service value: - Service google_ads: Toggles the "Skip empty reports" feature. Enabled by default
sncCertificate String
sncCertificateSource String
sncFivetranName String
sncLibraryPath String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Path to the external security product's library. - Service hana_sap_hva_s4_netweaver: Path to the external security product's library.
sncMode String
sncMyName String
sncName String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Client SNC name. - Service hana_sap_hva_s4_netweaver: Client SNC name.
sncPartnerName String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Communication partner's SNC name. - Service hana_sap_hva_s4_netweaver: Communication partner's SNC name.
sncSourceName String
soapUri String: Field usage depends on service value: - Service marketo: Marketo SOAP API Endpoint.
socialDataSyncTimeframe String: Field usage depends on service value: - Service linkedin_company_pages: The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: SIX .
source String: Field usage depends on service value: - Service adobe_analytics_data_feed: The data source.
storeHash String: Field usage depends on service value: - Service big_commerce: The BigCommerce store hash.
storeId String: Field usage depends on service value: - Service reviewsio: Your REVIEWS.io store ID
subDomain String: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS subdomain. - Service activecampaign: Your ActiveCampaign sub-domain. - Service acumatica: Your Acumatica subdomain. - Service ada: Your Ada sub-domain. - Service alchemer: Your Alchemer sub-domain. - Service atlassian_jira_align: Your Jira Align base URL. - Service azure_boards: Your Azure Boards Organization Name. - Service azure_devops: Your Azure Organization Name - Service betterworks: Your Betterworks subdomain. - Service bubble: Your Bubble subdomain. - Service buildium: Your Buildium subdomain. - Service canvas_by_instructure: Your Canvas by Instructure domain. - Service chargebee_product_catalog_1: Your Chargebee Product Catalog 1 subdomain. - Service chargebee_product_catalog_2: Your Chargebee subdomain. - Service checkr: Your Checkr subdomain. - Service clubspeed: Your Clubspeed subdomain. - Service collibra: Your collibra subdomain. - Service compliance_checkpoint: Your Compliance Checkpoint subdomain. - Service concord: Your Concord Sub Domain. - Service contrast_security: Your Contrast Security subdomain. - Service customerio: Your Customer.io region-specific Subdomain. - Service dbt_cloud: Your dbt Cloud API server region. - Service deputy: Your Deputy subdomain. - Service docebo: Your Docebo subdomain. - Service drata: Your Drata sub_domain. - Service eventsforce: Your Eventsforce subdomain. - Service ezofficeinventory: Your EZOfficeInventory Subdomain. - Service fountain: Your Fountain subdomain. - Service freshchat: Your Freshchat Sub Domain - Service gainsight_customer_success: The subdomain of your Gainsight account. - Service gainsight_product_experience: Your Gainsight Product Experience subdomain. - Service genesys: Your Genesys subdomain. - Service green_power_monitor: Your GreenPowerMonitor subdomain. - Service infobip: Your Infobip sub_domain. - Service insightly: Your company's Insightly subdomain name. - Service instructure: The Sub domain in which your Instructure account is hosted. - Service jamf: Your Jamf subdomain. - Service kandji: Your Kandji Subdomain. - Service khoros_care: Your Khoros Care subDomain. - Service looker_source: Your looker SubDomain name. - Service lucca: Your Lucca subdomain. - Service mailgun: Your Mailgun subdomain. - Service matomo: Your Matomo subdomain. - Service maxio_chargify: Enter Your Subdomain. - Service myosh: Your myosh subdomain. - Service namely: Your Namely subdomain. - Service nylas: Your Nylas subdomain. - Service okta: Your Okta subdomain. - Service picqer: Your Picqer subdomain. - Service pinpoint: Your Pinpoint sub domain name. - Service piwik_pro: Your Piwik PRO subdomain. - Service playvox: Your Playvox Subdomain. - Service posthog: Your PostHog data region (app or eu). - Service recurly: Your company's Recurly subdomain. - Service reltio: Your Reltio subdomain. - Service revel: Your Revel Systems subDomain. - Service rundeck: Your Rundeck subdomain. - Service sage_hr: Your Sage HR subdomain. - Service salesforce_marketing_cloud: Your Salesforce Marketing Cloud subdomain. - Service salsify: Your Salsify Organization ID. - Service sap_success_factors: Your SAP SuccessFactors Subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service starrez: Your StarRez subdomain - Service sugarcrm: Your SugarCRM subdomain. - Service tableau_source: Your Tableau Source subdomain. - Service tempo: Your Tempo subdomain. - Service testrail: Your TestRail subdomain. - Service thinkific: Your Thinkific subdomain. - Service totango: Your Totango Subdomain. - Service tymeshift: Your Tymeshift subdomain. - Service upland: Your Upland Software subDomain. - Service wordpress: Your WordPress subdomain. - Service workable: Your Workable Subdomain. - Service wrike: Your Wrike Subdomain.
subdomain String: Field usage depends on service value: - Service bamboohr: The subdomain used to access your account. If you access BambooHR at 'https://mycompany.bamboohr.com', then the subdomain is 'mycompany'. - Service datadog: Your Datadog subdomain. - Service ebay: Your eBay environment. - Service freshdesk: Your company's freshdesk subdomain (usually company.freshdesk.com). - Service freshsales: Your Freshsales domain. - Service freshservice: Your company's freshservice subdomain (usually company.freshservice.com). - Service freshsuccess: Your Freshsuccess subdomain. - Service gorgias: Your Gorgias subdomain. - Service jama_software: Your Jama Software subdomain. - Service klarna: Your Klarna subdomain. - Service learnupon: Your Learnupon subdomain. - Service maxio_saasoptics: Your Maxio SaaSOptics subdomain. - Service medallia: Medallia subdomain - Service packiyo: Your Packiyo subdomain. - Service qmatic_data_connect: Your Qmatic Data Connect subdomain. - Service sana: Your Sana subdomain. - Service skillstx: Your SkillsTX subdomain. - Service smarthr: Your SmartHR subdomain. - Service sonarqube: Your Sonarqube subdomain. - Service toast: Your Toast domain. - Service vts: Your VTS Subdomain. - Service zendesk_chat: Your Zendesk domain.
subscriberName String: Field usage depends on service value: - Service azure_service_bus: 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
subscription String: Field usage depends on service value: - Service retailnext: Your RetailNext subscription.
subscriptionKey String: Field usage depends on service value: - Service dsv: Your DSV subscription key.
supportConnectedAccountsSync Boolean: Field usage depends on service value: - Service stripe: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts. - Service stripe_test: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.
supportNestedColumns Boolean: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
surveyIds String: Field usage depends on service value: - Service qualaroo: Array of Qualaroo Survey IDs.
swipeAttributionWindow String: Field usage depends on service value: - Service snapchat_ads: The time period to attribute conversions based on swipes. Default value: DAY_28
syncDataLocker Boolean: Field usage depends on service value: - Service appsflyer: Sync AppsFlyer Data Locker. Default value is true, set it to false to sync AppsFlyer data using only webhooks.
syncFormat String: Field usage depends on service value: - Service webhooks: The webhooks sync format. Default value: Unpacked. Unpacked messages must be valid JSON.
syncFormulaFields Boolean: Field usage depends on service value: - Service financial_force: Enable this option to sync formula fields directly (default value = false) - Service salesforce: Enable this option to sync formula fields directly (default value = false) - Service salesforce_sandbox: Enable this option to sync formula fields directly (default value = false)
syncMetadata Boolean: Field usage depends on service value: - Service facebook_ads: Parameter defining whether to enable or disable metadata synchronisation. Default value: TRUE.
syncMethod String: Field usage depends on service value: - Service aws_lambda: Sync Method
syncMode String: Field usage depends on service value: - Service adroll: Whether to sync all advertisables or specific advertisables. Default value: AllAdvertisables. - Service amazon_ads: Option to select connector should sync all profiles or specific profiles. - Service anaplan: Whether to sync all exports or specific exports. - Service apple_search_ads: Sync Mode - Service asana: Whether to sync all projects or specific projects. - Service bingads: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service double_click_campaign_manager: Whether to sync all user profiles or specific ones. Default value: AllAccounts. - Service dynamodb: Which packed mode setting to use. Default value: UsePackedModeOnly. - Service facebook: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_ad_account: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service facebook_ads: Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. - Service facebook_pages: Whether to sync all accounts or specific accounts. Default value: AllPages. - Service github: Whether to sync all repositories or specific repositories. - Service google_ads: Whether to sync all accounts or specific accounts. - Service google_analytics: Whether to sync all accounts or specific accounts. - Service google_analytics_4: Whether to sync all accounts or specific accounts. - Service google_analytics_mcf: Whether to sync all accounts or specific accounts. Default value: ALL_ACCOUNTS - Service google_search_console: Whether to sync all sites or specific sites. - Service instagram_business: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service iterable: Events Sync Mode. - Service jira: Whether to sync all projects or specific projects. - Service linkedin_ads: Whether to sync all accounts or specific accounts. Default value: AllAccounts - Service pendo: Whether to sync all App IDs or specific App IDs. Default value: AllAppIds. - Service pinterest_ads: Whether to sync all advertisers or specific advertisers. - Service reddit_ads: Whether to sync all accounts or specific accounts. - Service salesforce_marketing_cloud: Select the sync mode. - Service snapchat_ads: Whether to sync all organizations or specific organizations. Default value: AllOrganizations. - Service spotify_ads: Whether to sync all ad accounts or specific ad accounts. - Service taboola: Whether to sync all accounts or specific accounts. - Service the_trade_desk: Whether to sync all accounts or specific accounts. - Service tiktok_ads: Whether to sync all advertiser accounts or specific accounts. - Service twilio: Whether to sync all accounts or specific accounts. - Service twitter: Whether to sync all accounts or specific accounts. Default value: AllAccounts. - Service twitter_ads: Whether to sync all accounts or specific accounts. - Service walmart_dsp: Whether to sync all accounts or specific accounts. - Service yahoo_gemini: Whether to sync all accounts or specific accounts. Default value: SpecificAccounts. - Service zuora: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both. - Service zuora_sandbox: Select Zuora Billing to sync exclusively Zuora Billing related records. Choose Zuora Revenue for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for Both.
syncModeAdvertiser String: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all advertisers or specific advertisers. Default value: ALL_ADVERTISERS.
syncModeSeat String: Field usage depends on service value: - Service yahoo_dsp: Whether to sync all seats or specific seats. Default value: ALL_SEATS.
syncMultipleAccounts Boolean: Field usage depends on service value: - Service reddit_ads: 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
syncPackMode String: Field usage depends on service value: - Service cosmos: 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 Azure Cosmos DB Sync Pack Mode Options documentation. - Service documentdb: Indicates whether synced data will be packed into a single entry(column), or unpacked with one layer of nested fields.
syncPullApi Boolean: Field usage depends on service value: - Service appsflyer: These options are for Appsflyer's Pull API, and are only necessary for syncing events from Pull API.
syncType String: Field usage depends on service value: - Service apache_kafka: Kafka sync type. Unpacked messages must be valid JSON. - Service aws_msk: The sync type. Unpacked messages must be valid JSON. - Service azure_event_hub: Sync type. Unpacked messages must be valid JSON. - Service azure_service_bus: 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 - Service confluent_cloud: Kafka sync type. Unpacked messages must be valid JSON. - Service heroku_kafka: Heroku Kafka sync type. Unpacked messages must be valid JSON. - Service segment: The Segment connector sync type.
sysnr String
systemId String: Field usage depends on service value: - Service hana_sap_hva_ecc_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID. - Service hana_sap_hva_s4_netweaver: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
tableId String: Field usage depends on service value: - Service pigment: Your Pigment table ID.
tableName String: Field usage depends on service value: - Service airtable: Name of table in Airtable
tablesWithoutAccessUpdatedAt String: Field usage depends on service value: - Service hubspot: Timestamp to indicate when tables without access was updated
targetEntityId String: Field usage depends on service value: - Service culture_amp: Your Culture Amp Target entity ID.
targetHost String: Field usage depends on service value: - Service d2l_brightspace: Your D2L Brightspace target host.
tdeCertificate String: Field usage depends on service value: - Service sql_server_hva: Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Certificate used to protect a database encryption key
tdeCertificateName String: Field usage depends on service value: - Service sql_server_hva: Name of the Certificate used to protect a database encryption key - Service sql_server_sap_ecc_hva: Name of the Certificate used to protect a database encryption key
tdePassword String: Field usage depends on service value: - Service sql_server_hva: Password of the TDE private key - Service sql_server_sap_ecc_hva: Password of the TDE private key
tdePrivateKey String: Field usage depends on service value: - Service sql_server_hva: Private key associated with the TDE certificate - Service sql_server_sap_ecc_hva: Private key associated with the TDE certificate
teamId String: Field usage depends on service value: - Service asana: Team ID
technicalAccountId String: Field usage depends on service value: - Service adobe_analytics: Technical Account ID from the Service Account (JWT) credentials of your Adobe Project.
templateLabels List<String>: Field usage depends on service value: - Service mandrill: Provide the labels to filter the templates
tenant String: Field usage depends on service value: - Service microsoft_entra_id: Your Microsoft Entra ID Tenant. - Service microsoft_power_bi: Your Microsoft Power BI tenant. - Service microsoft_teams: Your Microsoft Teams Tenant. - Service unicommerce: Your uniware tenant. - Service workday: Workday tenant name - Service workday_financial_management: Workday tenant name - Service workday_hcm: Workday tenant name
tenantAppUrl String: Field usage depends on service value: - Service planful: Your Planful tenant app URL.
tenantCode String: Field usage depends on service value: - Service deposco: Your Deposco tenant code.
tenantConfigs List<Property Map>: Field usage depends on service value: - Service reltio: * tenant(s)
tenantId String: Field usage depends on service value: - Service azure_sql_db: Azure AD tenant ID. - Service azure_sql_managed_db: Azure AD tenant ID. - Service business_central: Tenant ID of your Business Central application - Service crowddev: Your crowd.dev Tenant ID. - Service reltio: Your Reltio tenant ID. - Service servicetitan: Your ServiceTitan tenant ID. - Service visma: Your Visma tenant ID.
tenantName String: Field usage depends on service value: - Service mambu: Your Mambu tenant name.
tenantUrl String: Field usage depends on service value: - Service ivanti: Your Ivanti Tenant URL. - Service playvox_workforce_management: Your Playvox Workforce Management tenant URL. - Service reltio: Your Reltio tenant URL.
testTableName String: Field usage depends on service value: - Service sap_hana: testTableName - Service sap_s4hana: testTableName
timeZone String: Field usage depends on service value: - Service pardot: The time zone configured in your Pardot instance. An empty value defaults to UTC+00:00.
timeframeMonths String: Field usage depends on service value: - Service adobe_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector has been created. Default value: TWELVE . - Service adroll: 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. - Service apple_search_ads: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service bingads: 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. - Service criteo: 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. NOTE: The greater number of months means the initial sync will take more time. - Service double_click_campaign_manager: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service double_click_publishers: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service facebook: 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. - Service facebook_ads: 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. - Service google_ads: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: TWELVE. - Service google_analytics: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_4: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: TWELVE. - Service google_analytics_mcf: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: TWELVE. - Service google_display_and_video_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service google_search_ads_360: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service google_search_console: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. - Service instagram_business: 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. - Service itunes_connect: Historical sync time frame in months. - Service linkedin_ads: 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. - Service outbrain: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service pinterest_ads: 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. - Service reddit_ads: 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. - Service snapchat_ads: 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. - Service spotify_ads: 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: SIX. - Service taboola: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. - Service the_trade_desk: 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. - Service tiktok_ads: 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. - Service twitter: 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. - Service twitter_ads: Historical sync timeframe in months. - Service walmart_dsp: 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. - Service yahoo_dsp: Number of monthsworth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value:THREE. - Service yahoo_gemini: 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`.
timezone String: Field usage depends on service value: - Service rokt: Your Rokt timezone.
timezoneMode String: Field usage depends on service value: - Service apple_search_ads: Determines whether to use UTC or the users timezone from the apple account
tns String: Field usage depends on service value: - Service oracle_hva: Single-tenant database: The database's SID. Multi-tenant database: The database's TNS. - Service oracle_sap_hva: Single-tenant database: The database SID. Multi-tenant database: The database TNS.
toastId String: Field usage depends on service value: - Service toast: Your Toast Restaurant External ID.
token String: Field usage depends on service value: - Service khoros_communities: Your Khoros Communities token. - Service matomo: Your Matomo auth token. - Service mode: Your Mode Token. - Service oracle_moat_analytics: Your Oracle Moat Analytics Token. - Service shareasale: Your ShareASale token. - Service solarwinds_service_desk: Your SolarWinds Service Desk token.
tokenAuthenticatedContainer String: Field usage depends on service value: - Service cosmos: The container name. Required for the RESOURCE_TOKEN data access method.
tokenAuthenticatedDatabase String: Field usage depends on service value: - Service cosmos: The database name. Required for the RESOURCE_TOKEN data access method.
tokenId String: Field usage depends on service value: - Service chargedesk: Your ChargeDesk token ID. - Service mux: Your Mux token ID
tokenKey String: Field usage depends on service value: - Service netsuite_suiteanalytics: Token ID - Service on24: Your ON24 token key. - Service proofpoint_security_awareness: Your Proofpoint Security Awareness Token Key.
tokenSecret String: Field usage depends on service value: - Service netsuite_suiteanalytics: Token Secret - Service on24: Your ON24 token secret.
tokenSecretKey String: Field usage depends on service value: - Service mux: Your Mux token secret key
tokenUrlRegion String: Field usage depends on service value: - Service amazon_dsp: Your Amazon DSP token URL region.
topics List<String>: Field usage depends on service value: - Service azure_service_bus: The comma-separated list of topics which should be synced. Required if you do not have manage permissions
trustStoreType String: Field usage depends on service value: - Service heroku_kafka: Trust Store Type
trustedCert String: Field usage depends on service value: - Service apache_kafka: Kafka trusted certificate. - Service heroku_kafka: Heroku Kafka trusted certificate. Required for TLS security protocol.
truststore String: Field usage depends on service value: - Service aws_msk: If security_protocol is set to TLS, add the Truststore File as Base64 encoded string.
tunnelHost String: Field usage depends on service value: - Service aurora: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service aurora_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_cosmos_for_mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service azure_sql_managed_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service clarity: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service cockroachdb: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service db2i_hva: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service db2i_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service documentdb: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation. - Service dynamics_365_fo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service ehr: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service elastic_cloud: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service es_self_hosted: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service google_cloud_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_postgresql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service google_cloud_sqlserver: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_b1: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_ecc_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service hana_sap_hva_s4_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service heroku_postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service magento_mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service maria_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mongo_sharded: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_azure: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service mysql_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service opendistro: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service opensearch: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). - Service oracle: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_ebs: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rac: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service oracle_sap_hva_netweaver: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service postgres_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_hana_db: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sap_s4hana: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sftp: Tunnel host address, specify only to connect via SSH tunnel. - Service sql_server: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_rds: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). - Service sql_server_sap_ecc_hva: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
tunnelPort Number: Field usage depends on service value: - Service aurora: SSH port, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH port, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH port, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH port, specify only to connect via an SSH tunnel. - Service clarity: SSH port, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH port, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service documentdb: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH port, specify only to connect via an SSH tunnel. - Service ehr: SSH port, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH port, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH port, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH port, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH port, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH port, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH port, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service maria: SSH port, specify only to connect via an SSH tunnel. - Service maria_azure: SSH port, specify only to connect via an SSH tunnel. - Service maria_rds: SSH port, specify only to connect via an SSH tunnel. - Service mongo: SSH port, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH port, specify only to connect via an SSH tunnel. - Service mysql: SSH port, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH port, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH port, specify only to connect via an SSH tunnel. - Service opendistro: SSH port, specify only to connect using an SSH tunnel. - Service opensearch: SSH port, specify only to connect using an SSH tunnel. - Service oracle: SSH port, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH port, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH port, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH port, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH port, specify only to connect via an SSH tunnel. - Service postgres: SSH port, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana: SSH port, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH port, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH port, specify only to connect via an SSH tunnel. - Service sftp: Tunnel port, specify only to connect via SSH tunnel. - Service sql_server: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH port, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH port, specify only to connect via an SSH tunnel.
tunnelUser String: Field usage depends on service value: - Service aurora: SSH user, specify only to connect via an SSH tunnel. - Service aurora_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_cosmos_for_mongo: SSH user, specify only to connect via an SSH tunnel. - Service azure_postgres: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_db: SSH user, specify only to connect via an SSH tunnel. - Service azure_sql_managed_db: SSH user, specify only to connect via an SSH tunnel. - Service clarity: SSH user, specify only to connect via an SSH tunnel. - Service cockroachdb: SSH user, specify only to connect via an SSH tunnel. - Service db2i_hva: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service db2i_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service documentdb: SSH user, specify only to connect via an SSH tunnel. Required for connector creation. - Service dynamics_365_fo: SSH user, specify only to connect via an SSH tunnel. - Service ehr: SSH user, specify only to connect via an SSH tunnel. - Service elastic_cloud: SSH user, specify only to connect using an SSH tunnel. - Service es_self_hosted: SSH user, specify only to connect using an SSH tunnel. - Service google_cloud_mysql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_postgresql: SSH user, specify only to connect via an SSH tunnel. - Service google_cloud_sqlserver: SSH user, only specify when connecting via an SSH tunnel. - Service hana_sap_hva_b1: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_ecc_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4: SSH user, specify only to connect via an SSH tunnel. - Service hana_sap_hva_s4_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service heroku_postgres: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql: SSH user, specify only to connect via an SSH tunnel. - Service magento_mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service maria: SSH user, specify only to connect via an SSH tunnel. - Service maria_azure: SSH user, specify only to connect via an SSH tunnel. - Service maria_rds: SSH user, specify only to connect via an SSH tunnel. - Service mongo: SSH user, specify only to connect via an SSH tunnel. - Service mongo_sharded: SSH user, specify only to connect via an SSH tunnel. - Service mysql: SSH user, specify only to connect via an SSH tunnel. - Service mysql_azure: SSH user, specify only to connect via an SSH tunnel. - Service mysql_rds: SSH user, specify only to connect via an SSH tunnel. - Service opendistro: SSH user, specify only to connect using an SSH tunnel. - Service opensearch: SSH user, specify only to connect using an SSH tunnel. - Service oracle: SSH user, specify only to connect via an SSH tunnel. - Service oracle_ebs: SSH user, specify only to connect via an SSH tunnel. - Service oracle_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rac: SSH user, specify only to connect via an SSH tunnel. - Service oracle_rds: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva: SSH user, specify only to connect via an SSH tunnel. - Service oracle_sap_hva_netweaver: SSH user, specify only to connect via an SSH tunnel. - Service postgres: SSH user, specify only to connect via an SSH tunnel. - Service postgres_rds: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana: SSH user, specify only to connect via an SSH tunnel. - Service sap_hana_db: SSH user, specify only to connect via an SSH tunnel. - Service sap_s4hana: SSH user, specify only to connect via an SSH tunnel. - Service sftp: Tunnel user, specify only to connect via SSH tunnel. - Service sql_server: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_hva: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_rds: SSH user, specify only to connect via an SSH tunnel. - Service sql_server_sap_ecc_hva: SSH user, specify only to connect via an SSH tunnel.
typeName String: Field usage depends on service value: - Service akamai: Your Akamai type name. - Service bubble: Your Bubble type name.
uniqueId String
updateConfigOnEachSync Boolean: Field usage depends on service value: - Service google_display_and_video_360: 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.
updateMethod String: Field usage depends on service value: - Service aurora: 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. - Service aurora_postgres: 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. - Service azure_postgres: 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. - Service azure_sql_db: (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. - Service azure_sql_managed_db: (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. - Service clarity: (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. - Service dynamics_365_fo: Update Method - Service ehr: (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. - Service google_cloud_mysql: 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. - Service google_cloud_postgresql: 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. - Service google_cloud_sqlserver: (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. - Service heroku_postgres: 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. - Service magento_mysql: 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. - Service magento_mysql_rds: 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. - Service maria: 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. - Service maria_azure: 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. - Service maria_rds: 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. - Service mysql: 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. - Service mysql_azure: 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. - Service mysql_rds: 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. - Service oracle: 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. - Service oracle_ebs: 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. - Service oracle_hva: 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. - Service oracle_rac: 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. - Service oracle_rds: 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. - Service oracle_sap_hva: 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. - Service postgres: 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. - Service postgres_rds: 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. - Service redshift_db: Default value: Teleport - Service snowflake_db: Default value: Teleport - Service sql_server: (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. - Service sql_server_hva: (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. - Service sql_server_rds: (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. - Service sql_server_sap_ecc_hva: (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.
uri String: Field usage depends on service value: - Service cosmos: Cosmos resource instance address.
urlFormat String: Field usage depends on service value: - Service fountain: Your Fountain URL format.
useApiKeys Boolean: Field usage depends on service value: - Service mandrill: Whether to use multiple API keys for interaction.
useCustomerBucket Boolean: Field usage depends on service value: - Service appsflyer: Use Custom Bucket. Set it to 'true' if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket.
useOracleRac Boolean: Field usage depends on service value: - Service oracle_hva: Default value: false. Set to true if you're using a RAC instance. - Service oracle_sap_hva: Default value: false. Set to true if you're using a RAC instance.
usePgpEncryptionOptions Boolean: Field usage depends on service value: - Service azure_blob_storage: Set to true if files present in the Azure Blob Storage container are encrypted using PGP. Default value: false. - Service ftp: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service gcs: Set to true if files are encrypted using PGP in the GCS bucket. Default value: false. - Service s3: Set to true if files are encrypted using PGP in the S3 bucket. Default value: false. - Service sftp: Set to true if files present in SFTP server are encrypted using PGP. Default value: false. - Service wasabi_cloud_storage: Set to true if files are encrypted using PGP in the Wasabi Cloud Storage bucket. Default value: false.
useServiceAccount Boolean: Field usage depends on service value: - Service bigquery_db: BigQuery use service account; default is false
useTemplateLabels Boolean: Field usage depends on service value: - Service mandrill: Use template labels to filter templates for sync
useWebhooks Boolean: Field usage depends on service value: - Service github: Set to true to capture deletes. - Service xero: Updates to few fields like sent_to_contact in Invoice table might be missed if you don't enable this.
useWorkspace Boolean: Field usage depends on service value: - Service bigquery_db: Create and drop tables in a query results dataset. Default is false - Service snowflake_db: Choose a database and schema to create temporary tables for syncs.
user String: Field usage depends on service value: - Service aurora: The user name. - Service aurora_postgres: The user name. - Service azure_cosmos_for_mongo: Username for source database access. - Service azure_postgres: The user name. - Service azure_sql_db: The user name. For Azure Databases, the format must be user@domain. - Service azure_sql_managed_db: The user name. For Azure Databases, the format must be user@domain. - Service clarity: The user name. For Azure Databases, the format must be user@domain. - Service cockroachdb: The user name. - Service db2i_hva: The user name. - Service db2i_sap_hva: The username. - Service documentdb: The user name. - Service dynamics_365_fo: The user name. The format must be user@domain. - Service ehr: The user name. For Azure Databases, the format must be user@domain. - Service elastic_cloud: The user name. - Service es_self_hosted: The user name. - Service ftp: FTP user. - Service google_cloud_mysql: The user name. - Service google_cloud_postgresql: The user name. - Service google_cloud_sqlserver: The user name. For Azure Databases, the format must be user@domain. - Service hana_sap_hva_b1: The username. - Service hana_sap_hva_ecc: The username. - Service hana_sap_hva_ecc_netweaver: The username. - Service hana_sap_hva_s4: The username. - Service hana_sap_hva_s4_netweaver: The username. - Service heroku_postgres: The user name. - Service jira: The Jira username. - Service magento_mysql: The user name. - Service magento_mysql_rds: The user name. - Service maria: The user name. - Service maria_azure: The user name. - Service maria_rds: The user name. - Service marin: The Marin username. - Service mongo: The user name. - Service mongo_sharded: The user name. - Service mysql: The user name. - Service mysql_azure: The user name. - Service mysql_rds: The user name. - Service opendistro: The user name. - Service opensearch: The user name. - Service oracle: The user name. - Service oracle_ebs: The user name. - Service oracle_hva: The user name. - Service oracle_rac: The user name. - Service oracle_rds: The user name. - Service oracle_sap_hva: The username. - Service oracle_sap_hva_netweaver: The username. - Service outbrain: The username or email of the Outbrain user. - Service postgres: The user name. - Service postgres_rds: The user name. - Service redshift_db: The Redshift username. - Service sap_hana: Your SAP HANA user name. - Service sap_s4hana: Your SAP S/4 user name. - Service sftp: SFTP user. - Service snowflake_db: The Snowflake username. - Service splunk: The Splunk username. - Service sql_server: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_hva: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_rds: The user name. For Azure Databases, the format must be user@domain. - Service sql_server_sap_ecc_hva: The user name. For Azure Databases, the format must be user@domain.
userId String: Field usage depends on service value: - Service coassemble: Your Coassemble user ID. - Service gmail: Your Gmail user ID. - Service hibob: Your HiBob Service User Token. - Service marketo: Marketo SOAP API User Id. - Service okendo: Your Okendo user ID. - Service playvox: Your Playvox User ID. - Service sage_intacct: User ID - Service vimeo: Your Vimeo user ID.
userKey String
userName String: Field usage depends on service value: - Service workday: Workday username.
userProfiles List<String>: Field usage depends on service value: - Service double_click_campaign_manager: IDs of specific User Profiles to sync. Must be populated if sync_mode is set to SpecificAccounts.
userToken String: Field usage depends on service value: - Service hibob: Your HiBob Service User ID. - Service konnect_insights: Your Konnect Insights User Token. - Service sonarqube: Your Sonarqube user token.
username String: Field usage depends on service value: - Service absorb_lms: Your Absorb LMS username. - Service adobe_commerce: Your Adobe Commerce username. - Service akeneo: Your Akeneo username. - Service anaplan: Your Anaplan user ID. Must be populated if auth_mode is set to Basic. - Service appfigures: Your Appfigures Username. - Service aveva_pi: Username for the user to authenticate as with the AF Server - Service ceridian_dayforce: Your Ceridian Dayforce Username. - Service churnzero: Your ChurnZero username. - Service cin7: Your Cin7 API Username. - Service collibra: Your collibra username. - Service compliance_checkpoint: Your Compliance Checkpoint account username. - Service concur: The SAP Concur username. - Service confluence: Your Confluence username. - Service contrast_security: Your Contrast Security API Username. - Service dcl_logistics: Your DCL Logistics username. - Service deposco: Your Deposco username. - Service github: Login of your GitHub profile. - Service gladly: Your Gladly Username. - Service globalmeet: Your GlobalMeet Username. - Service gorgias: Your Gorgias username. - Service green_power_monitor: Your GreenPowerMonitor username. - Service guru: Your Guru username. - Service hilti_ontrack: Your Hilti On!Track username. - Service impact: Your Impact Account SID - Service integral_ad_science: Your integral_ad_science username. - Service itunes_connect: Your Apple ID - Service jamf: Your Jamf username. - Service khoros_care: Your Khoros Care username. - Service kissmetrics: Your Kissmetrics API Username. - Service klarna: Your Klarna Username. - Service learnupon: Your Learnupon username. - Service lessonly: Your Lessonly username. - Service mailgun: Your Mailgun API username. - Service myosh: Your myosh username. - Service oracle_business_intelligence_publisher: The Oracle Business Intelligence username. - Service oracle_fusion_cloud_apps_crm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_fscm: The Oracle Fusion Cloud username. - Service oracle_fusion_cloud_apps_hcm: The Oracle Fusion Cloud username. - Service partnerize: Your Partnerize account's username. - Service pingdom: Your Pingdom Username. - Service podio: Your Podio account username. - Service qmatic_data_connect: Your Qmatic Data Connect username. - Service quorum: Your Quorum username . - Service revx: Your RevX Username. - Service rtb_house: Your RTB House username. - Service sap_business_by_design: The SAP Business ByDesign username. - Service scorm: Your Scorm App ID. - Service servicenow: Your ServiceNow User ID (username). - Service shiphero: Your ShipHero username. - Service shipstation: Your ShipStation username. - Service shopware: Your Shopware username. - Service splash: Your Splash username. - Service starrez: Your StarRez API username - Service stickyio: Your sticky.io username . - Service stylight: Your Stylight Username. - Service sugarcrm: Your SugarCRM username. - Service teamwork: Your Teamwork username. - Service testrail: Your TestRail username. - Service ukg_pro: Your UKG Pro username. - Service unicommerce: Your uniware login username. - Service upland: Your Upland Software Username. - Service veevavault: Your Veeva Vault username. - Service when_i_work: Your When I Work username. - Service wherefour: Your Wherefour username. - Service workday_financial_management: Workday username. - Service workday_hcm: Username of your Workday Integration System User account - Service xandr: Your Xandr username. - Service younium: Your Younium username.
version String: Field usage depends on service value: - Service criteo_retail_media: Your Criteo Retail Media version.
viewAttributionWindow String: Field usage depends on service value: - Service facebook: Time period to attribute conversions based on views. Possible view_attribution_window values. - Service pinterest_ads: The number of days to use as the conversion attribution window for a 'view' action. - Service snapchat_ads: The time period to attribute conversions based on views. Default value: DAY_1
viewId String: Field usage depends on service value: - Service pigment: Your Pigment view ID.
viewThroughAttributionWindowSize String: Field usage depends on service value: - Service linkedin_ads: The time period to attribute conversions based on views. Default value: DAY_7
webServiceApiKey String: Field usage depends on service value: - Service adyen: Your Adyen Web Service API key.
webhookEndpoint String: Field usage depends on service value: - Service appsflyer: Webhook Url
webhookKey String: Field usage depends on service value: - Service xero: Webhook Key
webhookUrl String: Field usage depends on service value: - Service branch: Webhook URL - Service pipedrive: The registered URL for webhooks in your Pipedrive dashboard. - Service segment: Webhook URL. - Service xero: (ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO.
wordPressSiteIdOrWoocommerceDomainName String: Field usage depends on service value: - Service woocommerce: The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance.
workplaceId String: Field usage depends on service value: - Service moloco: Your Moloco workplace ID.
workspace String: Field usage depends on service value: - Service mode: Your Mode Workspace.
workspaceName String: Field usage depends on service value: - Service bigquery_db: Workspace Dataset Name - Service snowflake_db: The name of the database where the temporary tables will be created.
workspaceSameAsSource Boolean: Field usage depends on service value: - Service bigquery_db: Use the source dataset as the workspace dataset
workspaceSchema String: Field usage depends on service value: - Service snowflake_db: The name of the schema that belongs to the workspace database where the temporary tables will be created.
wsCertificate String: Field usage depends on service value: - Service adp_workforce_now: Web Services Certificate.
xApiKey String: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X API key.
xKey String: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research key.
xMasterKey String: Field usage depends on service value: - Service medallia_agile_research: Your Medallia Agile Research master key.
xUserEmail String: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Email.
xUserToken String: Field usage depends on service value: - Service workday_strategic_sourcing: Your Workday Strategic Sourcing X User Token.

GetConnectorConfigAccountsRedditAd

Name string: Field usage depends on service value: - Service reddit_ads: Reddit username of the additional linked account.

Name string: Field usage depends on service value: - Service reddit_ads: Reddit username of the additional linked account.

name String: Field usage depends on service value: - Service reddit_ads: Reddit username of the additional linked account.

name string: Field usage depends on service value: - Service reddit_ads: Reddit username of the additional linked account.

name str: Field usage depends on service value: - Service reddit_ads: Reddit username of the additional linked account.

name String: Field usage depends on service value: - Service reddit_ads: Reddit username of the additional linked account.

GetConnectorConfigAdobeAnalyticsConfiguration

CalculatedMetrics List<string>: Field usage depends on service value: - Service adobe_analytics: The calculated_metrics that you want to sync.
Elements List<string>: Field usage depends on service value: - Service adobe_analytics: The elements that you want to sync.
Metrics List<string>: Field usage depends on service value: - Service adobe_analytics: The metrics that you want to sync.
ReportSuites List<string>: Field usage depends on service value: - Service adobe_analytics: Specific report suites to sync. Must be populated if sync_mode is set to SpecificReportSuites.
Segments List<string>: Field usage depends on service value: - Service adobe_analytics: The segments that you want to sync.
SyncMode string: Field usage depends on service value: - Service adobe_analytics: Whether to sync all report suites or specific report suites. Default value: AllReportSuites .
Table string: Field usage depends on service value: - Service adobe_analytics: The table name unique within the schema to which connector will sync the data. Required for connector creation.

CalculatedMetrics []string: Field usage depends on service value: - Service adobe_analytics: The calculated_metrics that you want to sync.
Elements []string: Field usage depends on service value: - Service adobe_analytics: The elements that you want to sync.
Metrics []string: Field usage depends on service value: - Service adobe_analytics: The metrics that you want to sync.
ReportSuites []string: Field usage depends on service value: - Service adobe_analytics: Specific report suites to sync. Must be populated if sync_mode is set to SpecificReportSuites.
Segments []string: Field usage depends on service value: - Service adobe_analytics: The segments that you want to sync.
SyncMode string: Field usage depends on service value: - Service adobe_analytics: Whether to sync all report suites or specific report suites. Default value: AllReportSuites .
Table string: Field usage depends on service value: - Service adobe_analytics: The table name unique within the schema to which connector will sync the data. Required for connector creation.

calculatedMetrics List<String>: Field usage depends on service value: - Service adobe_analytics: The calculated_metrics that you want to sync.
elements List<String>: Field usage depends on service value: - Service adobe_analytics: The elements that you want to sync.
metrics List<String>: Field usage depends on service value: - Service adobe_analytics: The metrics that you want to sync.
reportSuites List<String>: Field usage depends on service value: - Service adobe_analytics: Specific report suites to sync. Must be populated if sync_mode is set to SpecificReportSuites.
segments List<String>: Field usage depends on service value: - Service adobe_analytics: The segments that you want to sync.
syncMode String: Field usage depends on service value: - Service adobe_analytics: Whether to sync all report suites or specific report suites. Default value: AllReportSuites .
table String: Field usage depends on service value: - Service adobe_analytics: The table name unique within the schema to which connector will sync the data. Required for connector creation.

calculatedMetrics string[]: Field usage depends on service value: - Service adobe_analytics: The calculated_metrics that you want to sync.
elements string[]: Field usage depends on service value: - Service adobe_analytics: The elements that you want to sync.
metrics string[]: Field usage depends on service value: - Service adobe_analytics: The metrics that you want to sync.
reportSuites string[]: Field usage depends on service value: - Service adobe_analytics: Specific report suites to sync. Must be populated if sync_mode is set to SpecificReportSuites.
segments string[]: Field usage depends on service value: - Service adobe_analytics: The segments that you want to sync.
syncMode string: Field usage depends on service value: - Service adobe_analytics: Whether to sync all report suites or specific report suites. Default value: AllReportSuites .
table string: Field usage depends on service value: - Service adobe_analytics: The table name unique within the schema to which connector will sync the data. Required for connector creation.

calculated_metrics Sequence[str]: Field usage depends on service value: - Service adobe_analytics: The calculated_metrics that you want to sync.
elements Sequence[str]: Field usage depends on service value: - Service adobe_analytics: The elements that you want to sync.
metrics Sequence[str]: Field usage depends on service value: - Service adobe_analytics: The metrics that you want to sync.
report_suites Sequence[str]: Field usage depends on service value: - Service adobe_analytics: Specific report suites to sync. Must be populated if sync_mode is set to SpecificReportSuites.
segments Sequence[str]: Field usage depends on service value: - Service adobe_analytics: The segments that you want to sync.
sync_mode str: Field usage depends on service value: - Service adobe_analytics: Whether to sync all report suites or specific report suites. Default value: AllReportSuites .
table str: Field usage depends on service value: - Service adobe_analytics: The table name unique within the schema to which connector will sync the data. Required for connector creation.

calculatedMetrics List<String>: Field usage depends on service value: - Service adobe_analytics: The calculated_metrics that you want to sync.
elements List<String>: Field usage depends on service value: - Service adobe_analytics: The elements that you want to sync.
metrics List<String>: Field usage depends on service value: - Service adobe_analytics: The metrics that you want to sync.
reportSuites List<String>: Field usage depends on service value: - Service adobe_analytics: Specific report suites to sync. Must be populated if sync_mode is set to SpecificReportSuites.
segments List<String>: Field usage depends on service value: - Service adobe_analytics: The segments that you want to sync.
syncMode String: Field usage depends on service value: - Service adobe_analytics: Whether to sync all report suites or specific report suites. Default value: AllReportSuites .
table String: Field usage depends on service value: - Service adobe_analytics: The table name unique within the schema to which connector will sync the data. Required for connector creation.

GetConnectorConfigAppIdsAppsflyer

AppId string: Field usage depends on service value: - Service appsflyer: Your App ID

AppId string: Field usage depends on service value: - Service appsflyer: Your App ID

appId String: Field usage depends on service value: - Service appsflyer: Your App ID

appId string: Field usage depends on service value: - Service appsflyer: Your App ID

app_id str: Field usage depends on service value: - Service appsflyer: Your App ID

appId String: Field usage depends on service value: - Service appsflyer: Your App ID

GetConnectorConfigCustomPayload

Key string: Field usage depends on service value: - Service aws_lambda: Payload Key - Service azure_function: Payload Key - Service google_cloud_function: Payload Key
Value string: Field usage depends on service value: - Service aws_lambda: Payload Value - Service azure_function: Payload Value - Service google_cloud_function: Payload Value

Key string: Field usage depends on service value: - Service aws_lambda: Payload Key - Service azure_function: Payload Key - Service google_cloud_function: Payload Key
Value string: Field usage depends on service value: - Service aws_lambda: Payload Value - Service azure_function: Payload Value - Service google_cloud_function: Payload Value

key String: Field usage depends on service value: - Service aws_lambda: Payload Key - Service azure_function: Payload Key - Service google_cloud_function: Payload Key
value String: Field usage depends on service value: - Service aws_lambda: Payload Value - Service azure_function: Payload Value - Service google_cloud_function: Payload Value

key string: Field usage depends on service value: - Service aws_lambda: Payload Key - Service azure_function: Payload Key - Service google_cloud_function: Payload Key
value string: Field usage depends on service value: - Service aws_lambda: Payload Value - Service azure_function: Payload Value - Service google_cloud_function: Payload Value

key str: Field usage depends on service value: - Service aws_lambda: Payload Key - Service azure_function: Payload Key - Service google_cloud_function: Payload Key
value str: Field usage depends on service value: - Service aws_lambda: Payload Value - Service azure_function: Payload Value - Service google_cloud_function: Payload Value

key String: Field usage depends on service value: - Service aws_lambda: Payload Key - Service azure_function: Payload Key - Service google_cloud_function: Payload Key
value String: Field usage depends on service value: - Service aws_lambda: Payload Value - Service azure_function: Payload Value - Service google_cloud_function: Payload Value

GetConnectorConfigCustomReport

AddMetricVariants bool: Field usage depends on service value: - Service snapchat_ads: Add fields for separate "swipe-up" and "view" variants of selected metrics
Aggregate string: Field usage depends on service value: - Service tiktok_ads: Time aggregation of report
BaseMetricsFields List<string>: Field usage depends on service value: - Service snapchat_ads: List of Core, Additional and Conversion Metrics Stats Fields.
Breakdown string: Field usage depends on service value: - Service snapchat_ads: Sets Breakdown on custom report.
Breakout string: Field usage depends on service value: - Service snapchat_ads: Sets Breakout on custom report.
ConversionsReportIncluded bool: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: false
CustomEventsIncluded bool: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether the custom events are included in event conversions report. Default value: false
Dimension string: Field usage depends on service value: - Service snapchat_ads: Sets Dimension on custom report.
Dimensions List<string>: Field usage depends on service value: - Service tiktok_ads: Dimensions to synced
EventNames List<string>: Field usage depends on service value: - Service reddit_ads: The list of events the conversion data will be synchronised for
Granularity string: Field usage depends on service value: - Service snapchat_ads: Sets Granularity on custom report.
Level string: Field usage depends on service value: - Service reddit_ads: Level of custom report.
Metrics List<string>: Field usage depends on service value: - Service tiktok_ads: Metrics to be synced
ReportFields List<string>: Field usage depends on service value: - Service reddit_ads: The list of fields included in custom report
ReportName string: Field usage depends on service value: - Service reddit_ads: The table name within the schema to which connector syncs the data of the specific report. - Service snapchat_ads: Custom report name (must be unique)
ReportType string: Field usage depends on service value: - Service tiktok_ads: Type of report to be generated
Segmentation string: Field usage depends on service value: - Service reddit_ads: Level of custom report.
SkAdMetricsFields List<string>: Field usage depends on service value: - Service snapchat_ads: List of SKAd Metrics fields in custom report.
TableName string: Field usage depends on service value: - Service tiktok_ads: Destination Table name of report
TimeZone string: Field usage depends on service value: - Service reddit_ads: The specific time zone to sync report data if useAccountTimeZone set to false.
TimeZoneMode string: Field usage depends on service value: - Service reddit_ads: When this parameter is set to ACCOUNT, connector will use account related time zone to sync report data. Default value: ACCOUNT. Possible values: ACCOUNT, USER

AddMetricVariants bool: Field usage depends on service value: - Service snapchat_ads: Add fields for separate "swipe-up" and "view" variants of selected metrics
Aggregate string: Field usage depends on service value: - Service tiktok_ads: Time aggregation of report
BaseMetricsFields []string: Field usage depends on service value: - Service snapchat_ads: List of Core, Additional and Conversion Metrics Stats Fields.
Breakdown string: Field usage depends on service value: - Service snapchat_ads: Sets Breakdown on custom report.
Breakout string: Field usage depends on service value: - Service snapchat_ads: Sets Breakout on custom report.
ConversionsReportIncluded bool: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: false
CustomEventsIncluded bool: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether the custom events are included in event conversions report. Default value: false
Dimension string: Field usage depends on service value: - Service snapchat_ads: Sets Dimension on custom report.
Dimensions []string: Field usage depends on service value: - Service tiktok_ads: Dimensions to synced
EventNames []string: Field usage depends on service value: - Service reddit_ads: The list of events the conversion data will be synchronised for
Granularity string: Field usage depends on service value: - Service snapchat_ads: Sets Granularity on custom report.
Level string: Field usage depends on service value: - Service reddit_ads: Level of custom report.
Metrics []string: Field usage depends on service value: - Service tiktok_ads: Metrics to be synced
ReportFields []string: Field usage depends on service value: - Service reddit_ads: The list of fields included in custom report
ReportName string: Field usage depends on service value: - Service reddit_ads: The table name within the schema to which connector syncs the data of the specific report. - Service snapchat_ads: Custom report name (must be unique)
ReportType string: Field usage depends on service value: - Service tiktok_ads: Type of report to be generated
Segmentation string: Field usage depends on service value: - Service reddit_ads: Level of custom report.
SkAdMetricsFields []string: Field usage depends on service value: - Service snapchat_ads: List of SKAd Metrics fields in custom report.
TableName string: Field usage depends on service value: - Service tiktok_ads: Destination Table name of report
TimeZone string: Field usage depends on service value: - Service reddit_ads: The specific time zone to sync report data if useAccountTimeZone set to false.
TimeZoneMode string: Field usage depends on service value: - Service reddit_ads: When this parameter is set to ACCOUNT, connector will use account related time zone to sync report data. Default value: ACCOUNT. Possible values: ACCOUNT, USER

addMetricVariants Boolean: Field usage depends on service value: - Service snapchat_ads: Add fields for separate "swipe-up" and "view" variants of selected metrics
aggregate String: Field usage depends on service value: - Service tiktok_ads: Time aggregation of report
baseMetricsFields List<String>: Field usage depends on service value: - Service snapchat_ads: List of Core, Additional and Conversion Metrics Stats Fields.
breakdown String: Field usage depends on service value: - Service snapchat_ads: Sets Breakdown on custom report.
breakout String: Field usage depends on service value: - Service snapchat_ads: Sets Breakout on custom report.
conversionsReportIncluded Boolean: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: false
customEventsIncluded Boolean: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether the custom events are included in event conversions report. Default value: false
dimension String: Field usage depends on service value: - Service snapchat_ads: Sets Dimension on custom report.
dimensions List<String>: Field usage depends on service value: - Service tiktok_ads: Dimensions to synced
eventNames List<String>: Field usage depends on service value: - Service reddit_ads: The list of events the conversion data will be synchronised for
granularity String: Field usage depends on service value: - Service snapchat_ads: Sets Granularity on custom report.
level String: Field usage depends on service value: - Service reddit_ads: Level of custom report.
metrics List<String>: Field usage depends on service value: - Service tiktok_ads: Metrics to be synced
reportFields List<String>: Field usage depends on service value: - Service reddit_ads: The list of fields included in custom report
reportName String: Field usage depends on service value: - Service reddit_ads: The table name within the schema to which connector syncs the data of the specific report. - Service snapchat_ads: Custom report name (must be unique)
reportType String: Field usage depends on service value: - Service tiktok_ads: Type of report to be generated
segmentation String: Field usage depends on service value: - Service reddit_ads: Level of custom report.
skAdMetricsFields List<String>: Field usage depends on service value: - Service snapchat_ads: List of SKAd Metrics fields in custom report.
tableName String: Field usage depends on service value: - Service tiktok_ads: Destination Table name of report
timeZone String: Field usage depends on service value: - Service reddit_ads: The specific time zone to sync report data if useAccountTimeZone set to false.
timeZoneMode String: Field usage depends on service value: - Service reddit_ads: When this parameter is set to ACCOUNT, connector will use account related time zone to sync report data. Default value: ACCOUNT. Possible values: ACCOUNT, USER

addMetricVariants boolean: Field usage depends on service value: - Service snapchat_ads: Add fields for separate "swipe-up" and "view" variants of selected metrics
aggregate string: Field usage depends on service value: - Service tiktok_ads: Time aggregation of report
baseMetricsFields string[]: Field usage depends on service value: - Service snapchat_ads: List of Core, Additional and Conversion Metrics Stats Fields.
breakdown string: Field usage depends on service value: - Service snapchat_ads: Sets Breakdown on custom report.
breakout string: Field usage depends on service value: - Service snapchat_ads: Sets Breakout on custom report.
conversionsReportIncluded boolean: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: false
customEventsIncluded boolean: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether the custom events are included in event conversions report. Default value: false
dimension string: Field usage depends on service value: - Service snapchat_ads: Sets Dimension on custom report.
dimensions string[]: Field usage depends on service value: - Service tiktok_ads: Dimensions to synced
eventNames string[]: Field usage depends on service value: - Service reddit_ads: The list of events the conversion data will be synchronised for
granularity string: Field usage depends on service value: - Service snapchat_ads: Sets Granularity on custom report.
level string: Field usage depends on service value: - Service reddit_ads: Level of custom report.
metrics string[]: Field usage depends on service value: - Service tiktok_ads: Metrics to be synced
reportFields string[]: Field usage depends on service value: - Service reddit_ads: The list of fields included in custom report
reportName string: Field usage depends on service value: - Service reddit_ads: The table name within the schema to which connector syncs the data of the specific report. - Service snapchat_ads: Custom report name (must be unique)
reportType string: Field usage depends on service value: - Service tiktok_ads: Type of report to be generated
segmentation string: Field usage depends on service value: - Service reddit_ads: Level of custom report.
skAdMetricsFields string[]: Field usage depends on service value: - Service snapchat_ads: List of SKAd Metrics fields in custom report.
tableName string: Field usage depends on service value: - Service tiktok_ads: Destination Table name of report
timeZone string: Field usage depends on service value: - Service reddit_ads: The specific time zone to sync report data if useAccountTimeZone set to false.
timeZoneMode string: Field usage depends on service value: - Service reddit_ads: When this parameter is set to ACCOUNT, connector will use account related time zone to sync report data. Default value: ACCOUNT. Possible values: ACCOUNT, USER

add_metric_variants bool: Field usage depends on service value: - Service snapchat_ads: Add fields for separate "swipe-up" and "view" variants of selected metrics
aggregate str: Field usage depends on service value: - Service tiktok_ads: Time aggregation of report
base_metrics_fields Sequence[str]: Field usage depends on service value: - Service snapchat_ads: List of Core, Additional and Conversion Metrics Stats Fields.
breakdown str: Field usage depends on service value: - Service snapchat_ads: Sets Breakdown on custom report.
breakout str: Field usage depends on service value: - Service snapchat_ads: Sets Breakout on custom report.
conversions_report_included bool: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: false
custom_events_included bool: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether the custom events are included in event conversions report. Default value: false
dimension str: Field usage depends on service value: - Service snapchat_ads: Sets Dimension on custom report.
dimensions Sequence[str]: Field usage depends on service value: - Service tiktok_ads: Dimensions to synced
event_names Sequence[str]: Field usage depends on service value: - Service reddit_ads: The list of events the conversion data will be synchronised for
granularity str: Field usage depends on service value: - Service snapchat_ads: Sets Granularity on custom report.
level str: Field usage depends on service value: - Service reddit_ads: Level of custom report.
metrics Sequence[str]: Field usage depends on service value: - Service tiktok_ads: Metrics to be synced
report_fields Sequence[str]: Field usage depends on service value: - Service reddit_ads: The list of fields included in custom report
report_name str: Field usage depends on service value: - Service reddit_ads: The table name within the schema to which connector syncs the data of the specific report. - Service snapchat_ads: Custom report name (must be unique)
report_type str: Field usage depends on service value: - Service tiktok_ads: Type of report to be generated
segmentation str: Field usage depends on service value: - Service reddit_ads: Level of custom report.
sk_ad_metrics_fields Sequence[str]: Field usage depends on service value: - Service snapchat_ads: List of SKAd Metrics fields in custom report.
table_name str: Field usage depends on service value: - Service tiktok_ads: Destination Table name of report
time_zone str: Field usage depends on service value: - Service reddit_ads: The specific time zone to sync report data if useAccountTimeZone set to false.
time_zone_mode str: Field usage depends on service value: - Service reddit_ads: When this parameter is set to ACCOUNT, connector will use account related time zone to sync report data. Default value: ACCOUNT. Possible values: ACCOUNT, USER

addMetricVariants Boolean: Field usage depends on service value: - Service snapchat_ads: Add fields for separate "swipe-up" and "view" variants of selected metrics
aggregate String: Field usage depends on service value: - Service tiktok_ads: Time aggregation of report
baseMetricsFields List<String>: Field usage depends on service value: - Service snapchat_ads: List of Core, Additional and Conversion Metrics Stats Fields.
breakdown String: Field usage depends on service value: - Service snapchat_ads: Sets Breakdown on custom report.
breakout String: Field usage depends on service value: - Service snapchat_ads: Sets Breakout on custom report.
conversionsReportIncluded Boolean: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: false
customEventsIncluded Boolean: Field usage depends on service value: - Service reddit_ads: The boolean value specifying whether the custom events are included in event conversions report. Default value: false
dimension String: Field usage depends on service value: - Service snapchat_ads: Sets Dimension on custom report.
dimensions List<String>: Field usage depends on service value: - Service tiktok_ads: Dimensions to synced
eventNames List<String>: Field usage depends on service value: - Service reddit_ads: The list of events the conversion data will be synchronised for
granularity String: Field usage depends on service value: - Service snapchat_ads: Sets Granularity on custom report.
level String: Field usage depends on service value: - Service reddit_ads: Level of custom report.
metrics List<String>: Field usage depends on service value: - Service tiktok_ads: Metrics to be synced
reportFields List<String>: Field usage depends on service value: - Service reddit_ads: The list of fields included in custom report
reportName String: Field usage depends on service value: - Service reddit_ads: The table name within the schema to which connector syncs the data of the specific report. - Service snapchat_ads: Custom report name (must be unique)
reportType String: Field usage depends on service value: - Service tiktok_ads: Type of report to be generated
segmentation String: Field usage depends on service value: - Service reddit_ads: Level of custom report.
skAdMetricsFields List<String>: Field usage depends on service value: - Service snapchat_ads: List of SKAd Metrics fields in custom report.
tableName String: Field usage depends on service value: - Service tiktok_ads: Destination Table name of report
timeZone String: Field usage depends on service value: - Service reddit_ads: The specific time zone to sync report data if useAccountTimeZone set to false.
timeZoneMode String: Field usage depends on service value: - Service reddit_ads: When this parameter is set to ACCOUNT, connector will use account related time zone to sync report data. Default value: ACCOUNT. Possible values: ACCOUNT, USER

GetConnectorConfigCustomTable

ActionBreakdowns List<string>: Field usage depends on service value: - Service facebook_ads: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
ActionReportTime string: Field usage depends on service value: - Service facebook_ads: The report time of action stats. Possible action_report time values.
Aggregation string: Field usage depends on service value: - Service facebook_ads: Options to select aggregation duration. Possible aggregation values.
Breakdowns List<string>: Field usage depends on service value: - Service facebook_ads: List of breakdowns which connector will sync. Possible breakdowns values.
ClickAttributionWindow string: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on clicks. Possible click_attribution_window values.
ConfigType string: Field usage depends on service value: - Service facebook_ads: Option to select Prebuilt Reports or Custom Reports. Possible config_type values.
EngagedViewAttributionWindow string: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on engaged views. Possible view_attribution_window values.
Fields List<string>: Field usage depends on service value: - Service facebook_ads: List of fields which connector will sync. Possible field values.
Level string
PrebuiltReportName string: Field usage depends on service value: - Service facebook_ads: The report name to which connector will sync the data. Possible prebuilt_report values.
TableName string: Field usage depends on service value: - Service facebook_ads: The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with Fivetran's naming conventions.
UseUnifiedAttributionSetting bool
ViewAttributionWindow string: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on views. Possible view_attribution_window values.

ActionBreakdowns []string: Field usage depends on service value: - Service facebook_ads: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
ActionReportTime string: Field usage depends on service value: - Service facebook_ads: The report time of action stats. Possible action_report time values.
Aggregation string: Field usage depends on service value: - Service facebook_ads: Options to select aggregation duration. Possible aggregation values.
Breakdowns []string: Field usage depends on service value: - Service facebook_ads: List of breakdowns which connector will sync. Possible breakdowns values.
ClickAttributionWindow string: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on clicks. Possible click_attribution_window values.
ConfigType string: Field usage depends on service value: - Service facebook_ads: Option to select Prebuilt Reports or Custom Reports. Possible config_type values.
EngagedViewAttributionWindow string: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on engaged views. Possible view_attribution_window values.
Fields []string: Field usage depends on service value: - Service facebook_ads: List of fields which connector will sync. Possible field values.
Level string
PrebuiltReportName string: Field usage depends on service value: - Service facebook_ads: The report name to which connector will sync the data. Possible prebuilt_report values.
TableName string: Field usage depends on service value: - Service facebook_ads: The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with Fivetran's naming conventions.
UseUnifiedAttributionSetting bool
ViewAttributionWindow string: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on views. Possible view_attribution_window values.

actionBreakdowns List<String>: Field usage depends on service value: - Service facebook_ads: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
actionReportTime String: Field usage depends on service value: - Service facebook_ads: The report time of action stats. Possible action_report time values.
aggregation String: Field usage depends on service value: - Service facebook_ads: Options to select aggregation duration. Possible aggregation values.
breakdowns List<String>: Field usage depends on service value: - Service facebook_ads: List of breakdowns which connector will sync. Possible breakdowns values.
clickAttributionWindow String: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on clicks. Possible click_attribution_window values.
configType String: Field usage depends on service value: - Service facebook_ads: Option to select Prebuilt Reports or Custom Reports. Possible config_type values.
engagedViewAttributionWindow String: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on engaged views. Possible view_attribution_window values.
fields List<String>: Field usage depends on service value: - Service facebook_ads: List of fields which connector will sync. Possible field values.
level String
prebuiltReportName String: Field usage depends on service value: - Service facebook_ads: The report name to which connector will sync the data. Possible prebuilt_report values.
tableName String: Field usage depends on service value: - Service facebook_ads: The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with Fivetran's naming conventions.
useUnifiedAttributionSetting Boolean
viewAttributionWindow String: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on views. Possible view_attribution_window values.

actionBreakdowns string[]: Field usage depends on service value: - Service facebook_ads: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
actionReportTime string: Field usage depends on service value: - Service facebook_ads: The report time of action stats. Possible action_report time values.
aggregation string: Field usage depends on service value: - Service facebook_ads: Options to select aggregation duration. Possible aggregation values.
breakdowns string[]: Field usage depends on service value: - Service facebook_ads: List of breakdowns which connector will sync. Possible breakdowns values.
clickAttributionWindow string: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on clicks. Possible click_attribution_window values.
configType string: Field usage depends on service value: - Service facebook_ads: Option to select Prebuilt Reports or Custom Reports. Possible config_type values.
engagedViewAttributionWindow string: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on engaged views. Possible view_attribution_window values.
fields string[]: Field usage depends on service value: - Service facebook_ads: List of fields which connector will sync. Possible field values.
level string
prebuiltReportName string: Field usage depends on service value: - Service facebook_ads: The report name to which connector will sync the data. Possible prebuilt_report values.
tableName string: Field usage depends on service value: - Service facebook_ads: The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with Fivetran's naming conventions.
useUnifiedAttributionSetting boolean
viewAttributionWindow string: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on views. Possible view_attribution_window values.

action_breakdowns Sequence[str]: Field usage depends on service value: - Service facebook_ads: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
action_report_time str: Field usage depends on service value: - Service facebook_ads: The report time of action stats. Possible action_report time values.
aggregation str: Field usage depends on service value: - Service facebook_ads: Options to select aggregation duration. Possible aggregation values.
breakdowns Sequence[str]: Field usage depends on service value: - Service facebook_ads: List of breakdowns which connector will sync. Possible breakdowns values.
click_attribution_window str: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on clicks. Possible click_attribution_window values.
config_type str: Field usage depends on service value: - Service facebook_ads: Option to select Prebuilt Reports or Custom Reports. Possible config_type values.
engaged_view_attribution_window str: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on engaged views. Possible view_attribution_window values.
fields Sequence[str]: Field usage depends on service value: - Service facebook_ads: List of fields which connector will sync. Possible field values.
level str
prebuilt_report_name str: Field usage depends on service value: - Service facebook_ads: The report name to which connector will sync the data. Possible prebuilt_report values.
table_name str: Field usage depends on service value: - Service facebook_ads: The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with Fivetran's naming conventions.
use_unified_attribution_setting bool
view_attribution_window str: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on views. Possible view_attribution_window values.

actionBreakdowns List<String>: Field usage depends on service value: - Service facebook_ads: List of action_breakdowns which connector will sync. Possible action_breakdowns values.
actionReportTime String: Field usage depends on service value: - Service facebook_ads: The report time of action stats. Possible action_report time values.
aggregation String: Field usage depends on service value: - Service facebook_ads: Options to select aggregation duration. Possible aggregation values.
breakdowns List<String>: Field usage depends on service value: - Service facebook_ads: List of breakdowns which connector will sync. Possible breakdowns values.
clickAttributionWindow String: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on clicks. Possible click_attribution_window values.
configType String: Field usage depends on service value: - Service facebook_ads: Option to select Prebuilt Reports or Custom Reports. Possible config_type values.
engagedViewAttributionWindow String: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on engaged views. Possible view_attribution_window values.
fields List<String>: Field usage depends on service value: - Service facebook_ads: List of fields which connector will sync. Possible field values.
level String
prebuiltReportName String: Field usage depends on service value: - Service facebook_ads: The report name to which connector will sync the data. Possible prebuilt_report values.
tableName String: Field usage depends on service value: - Service facebook_ads: The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with Fivetran's naming conventions.
useUnifiedAttributionSetting Boolean
viewAttributionWindow String: Field usage depends on service value: - Service facebook_ads: Time period to attribute conversions based on views. Possible view_attribution_window values.

GetConnectorConfigProjectCredential

ApiKey string: Field usage depends on service value: - Service amplitude: The API key of the project.
Project string: Field usage depends on service value: - Service amplitude: The project name you wish to use with Fivetran.
SecretKey string: Field usage depends on service value: - Service amplitude: The secret key of the project.

ApiKey string: Field usage depends on service value: - Service amplitude: The API key of the project.
Project string: Field usage depends on service value: - Service amplitude: The project name you wish to use with Fivetran.
SecretKey string: Field usage depends on service value: - Service amplitude: The secret key of the project.

apiKey String: Field usage depends on service value: - Service amplitude: The API key of the project.
project String: Field usage depends on service value: - Service amplitude: The project name you wish to use with Fivetran.
secretKey String: Field usage depends on service value: - Service amplitude: The secret key of the project.

apiKey string: Field usage depends on service value: - Service amplitude: The API key of the project.
project string: Field usage depends on service value: - Service amplitude: The project name you wish to use with Fivetran.
secretKey string: Field usage depends on service value: - Service amplitude: The secret key of the project.

api_key str: Field usage depends on service value: - Service amplitude: The API key of the project.
project str: Field usage depends on service value: - Service amplitude: The project name you wish to use with Fivetran.
secret_key str: Field usage depends on service value: - Service amplitude: The secret key of the project.

apiKey String: Field usage depends on service value: - Service amplitude: The API key of the project.
project String: Field usage depends on service value: - Service amplitude: The project name you wish to use with Fivetran.
secretKey String: Field usage depends on service value: - Service amplitude: The secret key of the project.

GetConnectorConfigReport

Aggregation string: Field usage depends on service value: - Service google_search_console: (Optional) Aggregation type. Supported only for the SEARCH_RESULTS report type
Attributes List<string>: Field usage depends on service value: - Service google_search_ads_360: The report attributes included to sync.
ConfigType string: Field usage depends on service value: - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports. - Service google_analytics_4: Whether to use the Prebuilt Reports or Custom Reports.
Dimensions List<string>: Field usage depends on service value: - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_analytics_4: The report dimensions to include into a sync. - Service google_search_console: The report dimensions included to sync.
Fields List<string>: Field usage depends on service value: - Service google_ads: A list of the fields to sync. Must be populated if config_type is set to Custom.
Filter string: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
FilterFieldName string: Field usage depends on service value: - Service google_analytics_4: The dimension name to filter on.
FilterType string: Field usage depends on service value: - Service google_analytics_4: Filter type for reports request. Possible values are INCLUDE and EXCLUDE
FilterValue string
GenerateFivetranPk bool: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
Metrics List<string>: Field usage depends on service value: - Service google_analytics: The report metrics to include into a sync. - Service google_analytics_4: The report metrics to include into a sync. - Service google_search_ads_360: The report metrics included to sync.
PrebuiltReport string: Field usage depends on service value: - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data. - Service google_analytics_4: The name of the Prebuilt Report from which the connector will sync the data.
PrimaryKeys List<string>: Field usage depends on service value: - Service workday: Primary Keys
ReportFormatType string: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
ReportType string: Field usage depends on service value: - Service google_ads: The name of the Google Ads report from which the connector will sync the data. Possible report_type values. - Service google_search_ads_360: The type of report - Service google_search_console: The type of report
ReportUrl string: Field usage depends on service value: - Service workday: URL for a live custom report.
RollbackWindow double: Field usage depends on service value: - Service google_analytics_4: The custom window size for rollback syncs.
SearchTypes List<string>: Field usage depends on service value: - Service google_search_console: Search types included to sync. Supported only for the SEARCH_RESULTS report type
SegmentIds List<string>
Segments List<string>: Field usage depends on service value: - Service google_analytics: 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. - Service google_search_ads_360: The report segments included to sync.
SupportNestedColumns bool: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
Table string: Field usage depends on service value: - Service google_ads: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics_4: The table name within the schema to which connector will sync the data of the specific report. - Service google_search_ads_360: The name of a table within the schema to which connector syncs the data of a given report. - Service google_search_console: The name of a table within the schema to which connector syncs the data of a given report. - Service workday: The table name within the schema to which connector will sync the data of the specific report.
TimeAggregationGranularity string: Field usage depends on service value: - Service google_analytics_4: The report data aggregation time granularity.

Aggregation string: Field usage depends on service value: - Service google_search_console: (Optional) Aggregation type. Supported only for the SEARCH_RESULTS report type
Attributes []string: Field usage depends on service value: - Service google_search_ads_360: The report attributes included to sync.
ConfigType string: Field usage depends on service value: - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports. - Service google_analytics_4: Whether to use the Prebuilt Reports or Custom Reports.
Dimensions []string: Field usage depends on service value: - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_analytics_4: The report dimensions to include into a sync. - Service google_search_console: The report dimensions included to sync.
Fields []string: Field usage depends on service value: - Service google_ads: A list of the fields to sync. Must be populated if config_type is set to Custom.
Filter string: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
FilterFieldName string: Field usage depends on service value: - Service google_analytics_4: The dimension name to filter on.
FilterType string: Field usage depends on service value: - Service google_analytics_4: Filter type for reports request. Possible values are INCLUDE and EXCLUDE
FilterValue string
GenerateFivetranPk bool: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
Metrics []string: Field usage depends on service value: - Service google_analytics: The report metrics to include into a sync. - Service google_analytics_4: The report metrics to include into a sync. - Service google_search_ads_360: The report metrics included to sync.
PrebuiltReport string: Field usage depends on service value: - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data. - Service google_analytics_4: The name of the Prebuilt Report from which the connector will sync the data.
PrimaryKeys []string: Field usage depends on service value: - Service workday: Primary Keys
ReportFormatType string: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
ReportType string: Field usage depends on service value: - Service google_ads: The name of the Google Ads report from which the connector will sync the data. Possible report_type values. - Service google_search_ads_360: The type of report - Service google_search_console: The type of report
ReportUrl string: Field usage depends on service value: - Service workday: URL for a live custom report.
RollbackWindow float64: Field usage depends on service value: - Service google_analytics_4: The custom window size for rollback syncs.
SearchTypes []string: Field usage depends on service value: - Service google_search_console: Search types included to sync. Supported only for the SEARCH_RESULTS report type
SegmentIds []string
Segments []string: Field usage depends on service value: - Service google_analytics: 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. - Service google_search_ads_360: The report segments included to sync.
SupportNestedColumns bool: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
Table string: Field usage depends on service value: - Service google_ads: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics_4: The table name within the schema to which connector will sync the data of the specific report. - Service google_search_ads_360: The name of a table within the schema to which connector syncs the data of a given report. - Service google_search_console: The name of a table within the schema to which connector syncs the data of a given report. - Service workday: The table name within the schema to which connector will sync the data of the specific report.
TimeAggregationGranularity string: Field usage depends on service value: - Service google_analytics_4: The report data aggregation time granularity.

aggregation String: Field usage depends on service value: - Service google_search_console: (Optional) Aggregation type. Supported only for the SEARCH_RESULTS report type
attributes List<String>: Field usage depends on service value: - Service google_search_ads_360: The report attributes included to sync.
configType String: Field usage depends on service value: - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports. - Service google_analytics_4: Whether to use the Prebuilt Reports or Custom Reports.
dimensions List<String>: Field usage depends on service value: - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_analytics_4: The report dimensions to include into a sync. - Service google_search_console: The report dimensions included to sync.
fields List<String>: Field usage depends on service value: - Service google_ads: A list of the fields to sync. Must be populated if config_type is set to Custom.
filter String: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
filterFieldName String: Field usage depends on service value: - Service google_analytics_4: The dimension name to filter on.
filterType String: Field usage depends on service value: - Service google_analytics_4: Filter type for reports request. Possible values are INCLUDE and EXCLUDE
filterValue String
generateFivetranPk Boolean: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
metrics List<String>: Field usage depends on service value: - Service google_analytics: The report metrics to include into a sync. - Service google_analytics_4: The report metrics to include into a sync. - Service google_search_ads_360: The report metrics included to sync.
prebuiltReport String: Field usage depends on service value: - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data. - Service google_analytics_4: The name of the Prebuilt Report from which the connector will sync the data.
primaryKeys List<String>: Field usage depends on service value: - Service workday: Primary Keys
reportFormatType String: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
reportType String: Field usage depends on service value: - Service google_ads: The name of the Google Ads report from which the connector will sync the data. Possible report_type values. - Service google_search_ads_360: The type of report - Service google_search_console: The type of report
reportUrl String: Field usage depends on service value: - Service workday: URL for a live custom report.
rollbackWindow Double: Field usage depends on service value: - Service google_analytics_4: The custom window size for rollback syncs.
searchTypes List<String>: Field usage depends on service value: - Service google_search_console: Search types included to sync. Supported only for the SEARCH_RESULTS report type
segmentIds List<String>
segments List<String>: Field usage depends on service value: - Service google_analytics: 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. - Service google_search_ads_360: The report segments included to sync.
supportNestedColumns Boolean: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
table String: Field usage depends on service value: - Service google_ads: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics_4: The table name within the schema to which connector will sync the data of the specific report. - Service google_search_ads_360: The name of a table within the schema to which connector syncs the data of a given report. - Service google_search_console: The name of a table within the schema to which connector syncs the data of a given report. - Service workday: The table name within the schema to which connector will sync the data of the specific report.
timeAggregationGranularity String: Field usage depends on service value: - Service google_analytics_4: The report data aggregation time granularity.

aggregation string: Field usage depends on service value: - Service google_search_console: (Optional) Aggregation type. Supported only for the SEARCH_RESULTS report type
attributes string[]: Field usage depends on service value: - Service google_search_ads_360: The report attributes included to sync.
configType string: Field usage depends on service value: - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports. - Service google_analytics_4: Whether to use the Prebuilt Reports or Custom Reports.
dimensions string[]: Field usage depends on service value: - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_analytics_4: The report dimensions to include into a sync. - Service google_search_console: The report dimensions included to sync.
fields string[]: Field usage depends on service value: - Service google_ads: A list of the fields to sync. Must be populated if config_type is set to Custom.
filter string: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
filterFieldName string: Field usage depends on service value: - Service google_analytics_4: The dimension name to filter on.
filterType string: Field usage depends on service value: - Service google_analytics_4: Filter type for reports request. Possible values are INCLUDE and EXCLUDE
filterValue string
generateFivetranPk boolean: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
metrics string[]: Field usage depends on service value: - Service google_analytics: The report metrics to include into a sync. - Service google_analytics_4: The report metrics to include into a sync. - Service google_search_ads_360: The report metrics included to sync.
prebuiltReport string: Field usage depends on service value: - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data. - Service google_analytics_4: The name of the Prebuilt Report from which the connector will sync the data.
primaryKeys string[]: Field usage depends on service value: - Service workday: Primary Keys
reportFormatType string: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
reportType string: Field usage depends on service value: - Service google_ads: The name of the Google Ads report from which the connector will sync the data. Possible report_type values. - Service google_search_ads_360: The type of report - Service google_search_console: The type of report
reportUrl string: Field usage depends on service value: - Service workday: URL for a live custom report.
rollbackWindow number: Field usage depends on service value: - Service google_analytics_4: The custom window size for rollback syncs.
searchTypes string[]: Field usage depends on service value: - Service google_search_console: Search types included to sync. Supported only for the SEARCH_RESULTS report type
segmentIds string[]
segments string[]: Field usage depends on service value: - Service google_analytics: 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. - Service google_search_ads_360: The report segments included to sync.
supportNestedColumns boolean: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
table string: Field usage depends on service value: - Service google_ads: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics_4: The table name within the schema to which connector will sync the data of the specific report. - Service google_search_ads_360: The name of a table within the schema to which connector syncs the data of a given report. - Service google_search_console: The name of a table within the schema to which connector syncs the data of a given report. - Service workday: The table name within the schema to which connector will sync the data of the specific report.
timeAggregationGranularity string: Field usage depends on service value: - Service google_analytics_4: The report data aggregation time granularity.

aggregation str: Field usage depends on service value: - Service google_search_console: (Optional) Aggregation type. Supported only for the SEARCH_RESULTS report type
attributes Sequence[str]: Field usage depends on service value: - Service google_search_ads_360: The report attributes included to sync.
config_type str: Field usage depends on service value: - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports. - Service google_analytics_4: Whether to use the Prebuilt Reports or Custom Reports.
dimensions Sequence[str]: Field usage depends on service value: - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_analytics_4: The report dimensions to include into a sync. - Service google_search_console: The report dimensions included to sync.
fields Sequence[str]: Field usage depends on service value: - Service google_ads: A list of the fields to sync. Must be populated if config_type is set to Custom.
filter str: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
filter_field_name str: Field usage depends on service value: - Service google_analytics_4: The dimension name to filter on.
filter_type str: Field usage depends on service value: - Service google_analytics_4: Filter type for reports request. Possible values are INCLUDE and EXCLUDE
filter_value str
generate_fivetran_pk bool: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
metrics Sequence[str]: Field usage depends on service value: - Service google_analytics: The report metrics to include into a sync. - Service google_analytics_4: The report metrics to include into a sync. - Service google_search_ads_360: The report metrics included to sync.
prebuilt_report str: Field usage depends on service value: - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data. - Service google_analytics_4: The name of the Prebuilt Report from which the connector will sync the data.
primary_keys Sequence[str]: Field usage depends on service value: - Service workday: Primary Keys
report_format_type str: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
report_type str: Field usage depends on service value: - Service google_ads: The name of the Google Ads report from which the connector will sync the data. Possible report_type values. - Service google_search_ads_360: The type of report - Service google_search_console: The type of report
report_url str: Field usage depends on service value: - Service workday: URL for a live custom report.
rollback_window float: Field usage depends on service value: - Service google_analytics_4: The custom window size for rollback syncs.
search_types Sequence[str]: Field usage depends on service value: - Service google_search_console: Search types included to sync. Supported only for the SEARCH_RESULTS report type
segment_ids Sequence[str]
segments Sequence[str]: Field usage depends on service value: - Service google_analytics: 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. - Service google_search_ads_360: The report segments included to sync.
support_nested_columns bool: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
table str: Field usage depends on service value: - Service google_ads: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics_4: The table name within the schema to which connector will sync the data of the specific report. - Service google_search_ads_360: The name of a table within the schema to which connector syncs the data of a given report. - Service google_search_console: The name of a table within the schema to which connector syncs the data of a given report. - Service workday: The table name within the schema to which connector will sync the data of the specific report.
time_aggregation_granularity str: Field usage depends on service value: - Service google_analytics_4: The report data aggregation time granularity.

aggregation String: Field usage depends on service value: - Service google_search_console: (Optional) Aggregation type. Supported only for the SEARCH_RESULTS report type
attributes List<String>: Field usage depends on service value: - Service google_search_ads_360: The report attributes included to sync.
configType String: Field usage depends on service value: - Service google_analytics: Whether to use the Prebuilt Reports or Custom Reports. - Service google_analytics_4: Whether to use the Prebuilt Reports or Custom Reports.
dimensions List<String>: Field usage depends on service value: - Service google_analytics: The report dimensions to include into a sync. The date dimension is mandatory for all the report types. - Service google_analytics_4: The report dimensions to include into a sync. - Service google_search_console: The report dimensions included to sync.
fields List<String>: Field usage depends on service value: - Service google_ads: A list of the fields to sync. Must be populated if config_type is set to Custom.
filter String: Field usage depends on service value: - Service google_analytics: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
filterFieldName String: Field usage depends on service value: - Service google_analytics_4: The dimension name to filter on.
filterType String: Field usage depends on service value: - Service google_analytics_4: Filter type for reports request. Possible values are INCLUDE and EXCLUDE
filterValue String
generateFivetranPk Boolean: Field usage depends on service value: - Service workday: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
metrics List<String>: Field usage depends on service value: - Service google_analytics: The report metrics to include into a sync. - Service google_analytics_4: The report metrics to include into a sync. - Service google_search_ads_360: The report metrics included to sync.
prebuiltReport String: Field usage depends on service value: - Service google_analytics: The name of the Prebuilt Report from which the connector will sync the data. - Service google_analytics_4: The name of the Prebuilt Report from which the connector will sync the data.
primaryKeys List<String>: Field usage depends on service value: - Service workday: Primary Keys
reportFormatType String: Field usage depends on service value: - Service workday: This is to select report format from JSON and CSV. By default, report format is JSON.
reportType String: Field usage depends on service value: - Service google_ads: The name of the Google Ads report from which the connector will sync the data. Possible report_type values. - Service google_search_ads_360: The type of report - Service google_search_console: The type of report
reportUrl String: Field usage depends on service value: - Service workday: URL for a live custom report.
rollbackWindow Number: Field usage depends on service value: - Service google_analytics_4: The custom window size for rollback syncs.
searchTypes List<String>: Field usage depends on service value: - Service google_search_console: Search types included to sync. Supported only for the SEARCH_RESULTS report type
segmentIds List<String>
segments List<String>: Field usage depends on service value: - Service google_analytics: 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. - Service google_search_ads_360: The report segments included to sync.
supportNestedColumns Boolean: Field usage depends on service value: - Service workday: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
table String: Field usage depends on service value: - Service google_ads: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics: The table name within the schema to which connector will sync the data of the specific report. - Service google_analytics_4: The table name within the schema to which connector will sync the data of the specific report. - Service google_search_ads_360: The name of a table within the schema to which connector syncs the data of a given report. - Service google_search_console: The name of a table within the schema to which connector syncs the data of a given report. - Service workday: The table name within the schema to which connector will sync the data of the specific report.
timeAggregationGranularity String: Field usage depends on service value: - Service google_analytics_4: The report data aggregation time granularity.

GetConnectorConfigReportConfig

ConfigType string: Field usage depends on service value: - Service yahoo_dsp: Set the value to PREBUILT if it's one of the preconfigured reports (see the prebuilt_report_type option). Otherwise, set to CUSTOM.
Currency string: Field usage depends on service value: - Service yahoo_dsp: Currency used in a report. Default value: USD.
Dimensions List<string>: Field usage depends on service value: - Service yahoo_dsp: Dimensions used in a report. Must be populated if config_type is set to CUSTOM.
IntervalType string: Field usage depends on service value: - Service yahoo_dsp: The granularity of data in a report. Default value: DAY.
Metrics List<string>: Field usage depends on service value: - Service yahoo_dsp: Metrics used in a report. Must be populated if config_type is set to CUSTOM.
PrebuiltReportType string: Field usage depends on service value: - Service yahoo_dsp: Specific report type to sync. Must be populated if config_type is set to PREBUILT.
ReportName string: Field usage depends on service value: - Service yahoo_dsp: Table name in destination.
TimeZone string: Field usage depends on service value: - Service yahoo_dsp: Specify the time zone to be used to request report data
UseAdvertiserTimezone bool: Field usage depends on service value: - Service yahoo_dsp: Use advertiser timezone to request report data.

ConfigType string: Field usage depends on service value: - Service yahoo_dsp: Set the value to PREBUILT if it's one of the preconfigured reports (see the prebuilt_report_type option). Otherwise, set to CUSTOM.
Currency string: Field usage depends on service value: - Service yahoo_dsp: Currency used in a report. Default value: USD.
Dimensions []string: Field usage depends on service value: - Service yahoo_dsp: Dimensions used in a report. Must be populated if config_type is set to CUSTOM.
IntervalType string: Field usage depends on service value: - Service yahoo_dsp: The granularity of data in a report. Default value: DAY.
Metrics []string: Field usage depends on service value: - Service yahoo_dsp: Metrics used in a report. Must be populated if config_type is set to CUSTOM.
PrebuiltReportType string: Field usage depends on service value: - Service yahoo_dsp: Specific report type to sync. Must be populated if config_type is set to PREBUILT.
ReportName string: Field usage depends on service value: - Service yahoo_dsp: Table name in destination.
TimeZone string: Field usage depends on service value: - Service yahoo_dsp: Specify the time zone to be used to request report data
UseAdvertiserTimezone bool: Field usage depends on service value: - Service yahoo_dsp: Use advertiser timezone to request report data.

configType String: Field usage depends on service value: - Service yahoo_dsp: Set the value to PREBUILT if it's one of the preconfigured reports (see the prebuilt_report_type option). Otherwise, set to CUSTOM.
currency String: Field usage depends on service value: - Service yahoo_dsp: Currency used in a report. Default value: USD.
dimensions List<String>: Field usage depends on service value: - Service yahoo_dsp: Dimensions used in a report. Must be populated if config_type is set to CUSTOM.
intervalType String: Field usage depends on service value: - Service yahoo_dsp: The granularity of data in a report. Default value: DAY.
metrics List<String>: Field usage depends on service value: - Service yahoo_dsp: Metrics used in a report. Must be populated if config_type is set to CUSTOM.
prebuiltReportType String: Field usage depends on service value: - Service yahoo_dsp: Specific report type to sync. Must be populated if config_type is set to PREBUILT.
reportName String: Field usage depends on service value: - Service yahoo_dsp: Table name in destination.
timeZone String: Field usage depends on service value: - Service yahoo_dsp: Specify the time zone to be used to request report data
useAdvertiserTimezone Boolean: Field usage depends on service value: - Service yahoo_dsp: Use advertiser timezone to request report data.

configType string: Field usage depends on service value: - Service yahoo_dsp: Set the value to PREBUILT if it's one of the preconfigured reports (see the prebuilt_report_type option). Otherwise, set to CUSTOM.
currency string: Field usage depends on service value: - Service yahoo_dsp: Currency used in a report. Default value: USD.
dimensions string[]: Field usage depends on service value: - Service yahoo_dsp: Dimensions used in a report. Must be populated if config_type is set to CUSTOM.
intervalType string: Field usage depends on service value: - Service yahoo_dsp: The granularity of data in a report. Default value: DAY.
metrics string[]: Field usage depends on service value: - Service yahoo_dsp: Metrics used in a report. Must be populated if config_type is set to CUSTOM.
prebuiltReportType string: Field usage depends on service value: - Service yahoo_dsp: Specific report type to sync. Must be populated if config_type is set to PREBUILT.
reportName string: Field usage depends on service value: - Service yahoo_dsp: Table name in destination.
timeZone string: Field usage depends on service value: - Service yahoo_dsp: Specify the time zone to be used to request report data
useAdvertiserTimezone boolean: Field usage depends on service value: - Service yahoo_dsp: Use advertiser timezone to request report data.

config_type str: Field usage depends on service value: - Service yahoo_dsp: Set the value to PREBUILT if it's one of the preconfigured reports (see the prebuilt_report_type option). Otherwise, set to CUSTOM.
currency str: Field usage depends on service value: - Service yahoo_dsp: Currency used in a report. Default value: USD.
dimensions Sequence[str]: Field usage depends on service value: - Service yahoo_dsp: Dimensions used in a report. Must be populated if config_type is set to CUSTOM.
interval_type str: Field usage depends on service value: - Service yahoo_dsp: The granularity of data in a report. Default value: DAY.
metrics Sequence[str]: Field usage depends on service value: - Service yahoo_dsp: Metrics used in a report. Must be populated if config_type is set to CUSTOM.
prebuilt_report_type str: Field usage depends on service value: - Service yahoo_dsp: Specific report type to sync. Must be populated if config_type is set to PREBUILT.
report_name str: Field usage depends on service value: - Service yahoo_dsp: Table name in destination.
time_zone str: Field usage depends on service value: - Service yahoo_dsp: Specify the time zone to be used to request report data
use_advertiser_timezone bool: Field usage depends on service value: - Service yahoo_dsp: Use advertiser timezone to request report data.

configType String: Field usage depends on service value: - Service yahoo_dsp: Set the value to PREBUILT if it's one of the preconfigured reports (see the prebuilt_report_type option). Otherwise, set to CUSTOM.
currency String: Field usage depends on service value: - Service yahoo_dsp: Currency used in a report. Default value: USD.
dimensions List<String>: Field usage depends on service value: - Service yahoo_dsp: Dimensions used in a report. Must be populated if config_type is set to CUSTOM.
intervalType String: Field usage depends on service value: - Service yahoo_dsp: The granularity of data in a report. Default value: DAY.
metrics List<String>: Field usage depends on service value: - Service yahoo_dsp: Metrics used in a report. Must be populated if config_type is set to CUSTOM.
prebuiltReportType String: Field usage depends on service value: - Service yahoo_dsp: Specific report type to sync. Must be populated if config_type is set to PREBUILT.
reportName String: Field usage depends on service value: - Service yahoo_dsp: Table name in destination.
timeZone String: Field usage depends on service value: - Service yahoo_dsp: Specify the time zone to be used to request report data
useAdvertiserTimezone Boolean: Field usage depends on service value: - Service yahoo_dsp: Use advertiser timezone to request report data.

GetConnectorConfigReportList

Dimension string: Field usage depends on service value: - Service spotify_ads: The dimension (entity_type) to sync.
Fields List<string>: Field usage depends on service value: - Service spotify_ads: A list of the fields (metrics) to sync.
Granularity string: Field usage depends on service value: - Service spotify_ads: The report granularity.
Table string: Field usage depends on service value: - Service spotify_ads: The table name within the schema to which connector will sync the data of the specific report.

Dimension string: Field usage depends on service value: - Service spotify_ads: The dimension (entity_type) to sync.
Fields []string: Field usage depends on service value: - Service spotify_ads: A list of the fields (metrics) to sync.
Granularity string: Field usage depends on service value: - Service spotify_ads: The report granularity.
Table string: Field usage depends on service value: - Service spotify_ads: The table name within the schema to which connector will sync the data of the specific report.

dimension String: Field usage depends on service value: - Service spotify_ads: The dimension (entity_type) to sync.
fields List<String>: Field usage depends on service value: - Service spotify_ads: A list of the fields (metrics) to sync.
granularity String: Field usage depends on service value: - Service spotify_ads: The report granularity.
table String: Field usage depends on service value: - Service spotify_ads: The table name within the schema to which connector will sync the data of the specific report.

dimension string: Field usage depends on service value: - Service spotify_ads: The dimension (entity_type) to sync.
fields string[]: Field usage depends on service value: - Service spotify_ads: A list of the fields (metrics) to sync.
granularity string: Field usage depends on service value: - Service spotify_ads: The report granularity.
table string: Field usage depends on service value: - Service spotify_ads: The table name within the schema to which connector will sync the data of the specific report.

dimension str: Field usage depends on service value: - Service spotify_ads: The dimension (entity_type) to sync.
fields Sequence[str]: Field usage depends on service value: - Service spotify_ads: A list of the fields (metrics) to sync.
granularity str: Field usage depends on service value: - Service spotify_ads: The report granularity.
table str: Field usage depends on service value: - Service spotify_ads: The table name within the schema to which connector will sync the data of the specific report.

dimension String: Field usage depends on service value: - Service spotify_ads: The dimension (entity_type) to sync.
fields List<String>: Field usage depends on service value: - Service spotify_ads: A list of the fields (metrics) to sync.
granularity String: Field usage depends on service value: - Service spotify_ads: The report granularity.
table String: Field usage depends on service value: - Service spotify_ads: The table name within the schema to which connector will sync the data of the specific report.

GetConnectorConfigSecretsList

Key string: Field usage depends on service value: - Service aws_lambda: Secret Key. - Service azure_function: Key - Service google_cloud_function: Key
Value string: Field usage depends on service value: - Service aws_lambda: Secret Value. - Service azure_function: Value - Service google_cloud_function: Value

Key string: Field usage depends on service value: - Service aws_lambda: Secret Key. - Service azure_function: Key - Service google_cloud_function: Key
Value string: Field usage depends on service value: - Service aws_lambda: Secret Value. - Service azure_function: Value - Service google_cloud_function: Value

key String: Field usage depends on service value: - Service aws_lambda: Secret Key. - Service azure_function: Key - Service google_cloud_function: Key
value String: Field usage depends on service value: - Service aws_lambda: Secret Value. - Service azure_function: Value - Service google_cloud_function: Value

key string: Field usage depends on service value: - Service aws_lambda: Secret Key. - Service azure_function: Key - Service google_cloud_function: Key
value string: Field usage depends on service value: - Service aws_lambda: Secret Value. - Service azure_function: Value - Service google_cloud_function: Value

key str: Field usage depends on service value: - Service aws_lambda: Secret Key. - Service azure_function: Key - Service google_cloud_function: Key
value str: Field usage depends on service value: - Service aws_lambda: Secret Value. - Service azure_function: Value - Service google_cloud_function: Value

key String: Field usage depends on service value: - Service aws_lambda: Secret Key. - Service azure_function: Key - Service google_cloud_function: Key
value String: Field usage depends on service value: - Service aws_lambda: Secret Value. - Service azure_function: Value - Service google_cloud_function: Value

GetConnectorConfigTenantConfig

Subdomain string: Field usage depends on service value: - Service reltio: Your Reltio subdomain.
TenantId string: Field usage depends on service value: - Service reltio: Your Reltio tenant ID.

Subdomain string: Field usage depends on service value: - Service reltio: Your Reltio subdomain.
TenantId string: Field usage depends on service value: - Service reltio: Your Reltio tenant ID.

subdomain String: Field usage depends on service value: - Service reltio: Your Reltio subdomain.
tenantId String: Field usage depends on service value: - Service reltio: Your Reltio tenant ID.

subdomain string: Field usage depends on service value: - Service reltio: Your Reltio subdomain.
tenantId string: Field usage depends on service value: - Service reltio: Your Reltio tenant ID.

subdomain str: Field usage depends on service value: - Service reltio: Your Reltio subdomain.
tenant_id str: Field usage depends on service value: - Service reltio: Your Reltio tenant ID.

subdomain String: Field usage depends on service value: - Service reltio: Your Reltio subdomain.
tenantId String: Field usage depends on service value: - Service reltio: Your Reltio tenant ID.

GetConnectorDestinationSchema

Name string: The connector schema name in destination. Has to be unique within the group (destination). Required for connector creation.
Prefix string: The connector schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connector creation.
Table string: The table name unique within the schema to which connector will sync the data. Required for connector creation.

Name string: The connector schema name in destination. Has to be unique within the group (destination). Required for connector creation.
Prefix string: The connector schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connector creation.
Table string: The table name unique within the schema to which connector will sync the data. Required for connector creation.

name String: The connector schema name in destination. Has to be unique within the group (destination). Required for connector creation.
prefix String: The connector schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connector creation.
table String: The table name unique within the schema to which connector will sync the data. Required for connector creation.

name string: The connector schema name in destination. Has to be unique within the group (destination). Required for connector creation.
prefix string: The connector schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connector creation.
table string: The table name unique within the schema to which connector will sync the data. Required for connector creation.

name str: The connector schema name in destination. Has to be unique within the group (destination). Required for connector creation.
prefix str: The connector schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connector creation.
table str: The table name unique within the schema to which connector will sync the data. Required for connector creation.

name String: The connector schema name in destination. Has to be unique within the group (destination). Required for connector creation.
prefix String: The connector schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connector creation.
table String: The table name unique within the schema to which connector will sync the data. Required for connector creation.

GetConnectorStatus

IsHistoricalSync bool: The boolean specifying whether the connector should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connector will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
SetupState string: The current setup state of the connector. The available values are: - incomplete - the setup config is incomplete, the setup tests never succeeded connected - the connector is properly set up, broken - the connector setup config is broken.
SyncState string: The current sync state of the connector. The available values are: scheduled - the sync is waiting to be run, syncing - the sync is currently running, paused - the sync is currently paused, rescheduled - the sync is waiting until more API calls are available in the source service.
Tasks List<GetConnectorStatusTask>: The collection of tasks for the connector.
UpdateState string: The current data update state of the connector. The available values are: on_schedule - the sync is running smoothly, no delays, delayed - the data is delayed for a longer time than expected for the update.
Warnings List<GetConnectorStatusWarning>: The collection of warnings for the connector.

IsHistoricalSync bool: The boolean specifying whether the connector should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connector will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
SetupState string: The current setup state of the connector. The available values are: - incomplete - the setup config is incomplete, the setup tests never succeeded connected - the connector is properly set up, broken - the connector setup config is broken.
SyncState string: The current sync state of the connector. The available values are: scheduled - the sync is waiting to be run, syncing - the sync is currently running, paused - the sync is currently paused, rescheduled - the sync is waiting until more API calls are available in the source service.
Tasks []GetConnectorStatusTask: The collection of tasks for the connector.
UpdateState string: The current data update state of the connector. The available values are: on_schedule - the sync is running smoothly, no delays, delayed - the data is delayed for a longer time than expected for the update.
Warnings []GetConnectorStatusWarning: The collection of warnings for the connector.

isHistoricalSync Boolean: The boolean specifying whether the connector should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connector will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
setupState String: The current setup state of the connector. The available values are: - incomplete - the setup config is incomplete, the setup tests never succeeded connected - the connector is properly set up, broken - the connector setup config is broken.
syncState String: The current sync state of the connector. The available values are: scheduled - the sync is waiting to be run, syncing - the sync is currently running, paused - the sync is currently paused, rescheduled - the sync is waiting until more API calls are available in the source service.
tasks List<GetConnectorStatusTask>: The collection of tasks for the connector.
updateState String: The current data update state of the connector. The available values are: on_schedule - the sync is running smoothly, no delays, delayed - the data is delayed for a longer time than expected for the update.
warnings List<GetConnectorStatusWarning>: The collection of warnings for the connector.

isHistoricalSync boolean: The boolean specifying whether the connector should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connector will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
setupState string: The current setup state of the connector. The available values are: - incomplete - the setup config is incomplete, the setup tests never succeeded connected - the connector is properly set up, broken - the connector setup config is broken.
syncState string: The current sync state of the connector. The available values are: scheduled - the sync is waiting to be run, syncing - the sync is currently running, paused - the sync is currently paused, rescheduled - the sync is waiting until more API calls are available in the source service.
tasks GetConnectorStatusTask[]: The collection of tasks for the connector.
updateState string: The current data update state of the connector. The available values are: on_schedule - the sync is running smoothly, no delays, delayed - the data is delayed for a longer time than expected for the update.
warnings GetConnectorStatusWarning[]: The collection of warnings for the connector.

is_historical_sync bool: The boolean specifying whether the connector should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connector will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
setup_state str: The current setup state of the connector. The available values are: - incomplete - the setup config is incomplete, the setup tests never succeeded connected - the connector is properly set up, broken - the connector setup config is broken.
sync_state str: The current sync state of the connector. The available values are: scheduled - the sync is waiting to be run, syncing - the sync is currently running, paused - the sync is currently paused, rescheduled - the sync is waiting until more API calls are available in the source service.
tasks Sequence[GetConnectorStatusTask]: The collection of tasks for the connector.
update_state str: The current data update state of the connector. The available values are: on_schedule - the sync is running smoothly, no delays, delayed - the data is delayed for a longer time than expected for the update.
warnings Sequence[GetConnectorStatusWarning]: The collection of warnings for the connector.

isHistoricalSync Boolean: The boolean specifying whether the connector should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connector will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
setupState String: The current setup state of the connector. The available values are: - incomplete - the setup config is incomplete, the setup tests never succeeded connected - the connector is properly set up, broken - the connector setup config is broken.
syncState String: The current sync state of the connector. The available values are: scheduled - the sync is waiting to be run, syncing - the sync is currently running, paused - the sync is currently paused, rescheduled - the sync is waiting until more API calls are available in the source service.
tasks List<Property Map>: The collection of tasks for the connector.
updateState String: The current data update state of the connector. The available values are: on_schedule - the sync is running smoothly, no delays, delayed - the data is delayed for a longer time than expected for the update.
warnings List<Property Map>: The collection of warnings for the connector.

GetConnectorStatusTask

Code string: Task code.
Message string: Task message.

Code string: Task code.
Message string: Task message.

code String: Task code.
message String: Task message.

code string: Task code.
message string: Task message.

code str: Task code.
message str: Task message.

code String: Task code.
message String: Task message.

GetConnectorStatusWarning

Code string: Warning code.
Message string: Warning message.

Code string: Warning code.
Message string: Warning message.

code String: Warning code.
message String: Warning message.

code string: Warning code.
message string: Warning message.

code str: Warning code.
message str: Warning message.

code String: Warning code.
message String: Warning message.

Package Details

Repository: fivetran fivetran/terraform-provider-fivetran
License
Notes: This Pulumi package is based on the fivetran Terraform Provider.

fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran

fivetran/terraform-provider-fivetran

fivetran.getConnector

On this page

On this page

Example Usage

Using getConnector

getConnector Result

Supporting Types

GetConnectorConfig

GetConnectorConfigAccountsRedditAd

GetConnectorConfigAdobeAnalyticsConfiguration

GetConnectorConfigAppIdsAppsflyer

GetConnectorConfigCustomPayload

GetConnectorConfigCustomReport

GetConnectorConfigCustomTable

GetConnectorConfigProjectCredential

GetConnectorConfigReport

GetConnectorConfigReportConfig

GetConnectorConfigReportList

GetConnectorConfigSecretsList

GetConnectorConfigTenantConfig

GetConnectorDestinationSchema

GetConnectorStatus

GetConnectorStatusTask

GetConnectorStatusWarning

Package Details

On this page

On this page