AWS Athena

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
access_id	string		true
secret_access_key	string		true
region	string		true
outputbucket	string	A pre-existing bucket (folder optional) that AWS can use to store query results. ex: s3://polytomic-athena-results/customer-dataset	true

Example

{
  "name": "awsathena connection",
  "type": "awsathena",
  "configuration": {
    "access_id": "AKIAIOSFODNN7EXAMPLE",
    "outputbucket": "s3://polytomic-athena-results/customer-dataset",
    "region": "us-east-1",
    "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
catalog	string	false
database	string	false
table	string	false

Example

{
  ...
  "configuration": {
    "catalog": "awsdatacatalog",
    "database": "default",
    "query": "SELECT * FROM \"webdata\".\"impressions\"",
    "table": "users"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
advanced	object		false
schema	string	Output schema to write to	false
mirror_schemas	boolean	Indicates whether schemas should be mirrored	false

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "truncate_existing": false
    },
    "mirror_schemas": false,
    "schema": "public"
  }
}

Affinity

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
api_key	string		true

Example

{
  "name": "affinity connection",
  "type": "affinity",
  "configuration": {
    "api_key": "******"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
object	string		false

Example

{
  ...
  "configuration": {
    "object": "organization"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Airtable

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
client_id	string		false
client_secret	string		false

Example

{
  "name": "airtable connection",
  "type": "airtable",
  "configuration": {
    "client_id": "eb669428-1854-4cb1-a560-403e05b8acbf",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
baseobj	object	false
tableobj	object	false
viewobj	object	false

Example

{
  ...
  "configuration": {
    "baseobj": {},
    "tableobj": {},
    "viewobj": {}
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Amplitude

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
api_key	string		true
secret_key	string		true

Example

{
  "name": "amplitude connection",
  "type": "amplitude",
  "configuration": {
    "api_key": "api-key",
    "secret_key": "******"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Attio

Connection

Configuration

Example

{
  "name": "attio connection",
  "type": "attio",
  "configuration": {}
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
object	string		false
list	object		false

Example

{
  ...
  "configuration": {
    "list": {},
    "object": ""
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Azure Blob Storage

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
account_name	string		true
access_key	string		true
container_name	string		true
is_single_table	boolean	Treat the files as a single table. (required if `is_single_table` is "true")	false
single_table_name	string	(required if `IsSingleTable` is "true")	false
single_table_file_format	string	(required if `IsSingleTable` is "true")	false
skip_lines	integer	Skip first N lines of each CSV file.	false

Example

{
  "name": "azureblob connection",
  "type": "azureblob",
  "configuration": {
    "access_key": "abcdefghijklmnopqrstuvwxyz0123456789/+ABCDEabcdefghijklmnopqrstuvwxyz0123456789/+ABCDE==",
    "account_name": "account",
    "container_name": "container",
    "is_single_table": false,
    "single_table_file_format": "csv",
    "single_table_name": "collection",
    "skip_lines": 0
  }
}

Model Sync

Source

N/A

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
format	string	Output file encoding	false

Example

{
  ...
  "target": {
      "configuration": {
        "format": "csv"
    }
  }
}

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
format	string	Output file encoding	false
subfolder	string	Subfolder to write to (optional)	false

Example

{
  ...
  "destination_configuration": {
    "format": "csv",
    "subfolder": "reports"
  }
}

Azure SQL

Connection

Configuration

NAME	TYPE	REQUIRED
hostname	string	true
username	string	true
password	string	true
database	string	true
port	integer	true
ssl	boolean	false

Example

{
  "name": "azuresql connection",
  "type": "azuresql",
  "configuration": {
    "database": "sampledb",
    "hostname": "example.database.windows.net",
    "password": "secret",
    "port": 1433,
    "ssl": false,
    "username": "user"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
table	string	false
view	string	false

Example

{
  ...
  "configuration": {
    "query": "SELECT * from users",
    "table": "users",
    "view": "active_users"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
advanced	object		false
schema	string	Output schema to write to	false
mirror_schemas	boolean	Indicates whether schemas should be mirrored	false

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "truncate_existing": false
    },
    "mirror_schemas": false,
    "schema": "public"
  }
}

Azure Synapse

Connection

Configuration

NAME	TYPE	REQUIRED
hostname	string	true
username	string	true
password	string	true
database	string	true
port	integer	true

Example

{
  "name": "synapse connection",
  "type": "synapse",
  "configuration": {
    "database": "yourdatabase",
    "hostname": "yourserver.sql.azuresynapse.net",
    "password": "secret",
    "port": 1433,
    "username": "user"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
table	string	false
view	string	false

Example

{
  ...
  "configuration": {
    "query": "SELECT * from users",
    "table": "users",
    "view": "active_users"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
advanced	object		false
schema	string	Output schema to write to	false
mirror_schemas	boolean	Indicates whether schemas should be mirrored	false

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "truncate_existing": false
    },
    "mirror_schemas": false,
    "schema": "public"
  }
}

Customer.io

Connection

Configuration

NAME	TYPE	REQUIRED
site_id	string	true
tracking_api_key	string	true
app_api_key	string	true

Example

{
  "name": "customerio connection",
  "type": "customerio",
  "configuration": {
    "app_api_key": "7f81wos4eeua0kap5dabridfwgd1uh",
    "site_id": "osh853chlrhick8w7qyz",
    "tracking_api_key": "a7l1nkxqhnwa48h94vbmsly1a2pnss"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Databricks

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
server_hostname	string		true
port	integer		true
access_token	string		true
http_path	string		true
cloud_provider	string		false
aws_access_key_id	string	See https://docs.polytomic.com/docs/databricks-connections#writing-to-databricks (required if `CloudProvider` is "aws")	false
aws_secret_access_key	string	(required if `CloudProvider` is "aws")	false
aws_user	string		false
s3_bucket_name	string	Name of bucket used for staging data load files (required if `CloudProvider` is "aws")	false
s3_bucket_region	string	Region of bucket. Note: must match region of redshift server (required if `CloudProvider` is "aws")	false
azure_account_name	string	The account name of the storage account (required if `CloudProvider` is "azure")	false
azure_access_key	string	The access key associated with this storage account (required if `CloudProvider` is "azure")	false
container_name	string	The container which we will stage files in (required if `CloudProvider` is "azure")	false
enforce_query_limit	boolean		false
concurrent_queries	integer		false

Example

{
  "name": "databricks connection",
  "type": "databricks",
  "configuration": {
    "access_token": "isoz8af6zvp8067gu68gvrp0oftevn",
    "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
    "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "aws_user": "",
    "azure_access_key": "abcdefghijklmnopqrstuvwxyz0123456789/+ABCDEabcdefghijklmnopqrstuvwxyz0123456789/+ABCDE==",
    "azure_account_name": "account",
    "cloud_provider": "aws",
    "concurrent_queries": 0,
    "container_name": "container",
    "enforce_query_limit": false,
    "http_path": "/sql",
    "port": 443,
    "s3_bucket_name": "s3://polytomic-databricks-results/customer-dataset",
    "s3_bucket_region": "us-east-1",
    "server_hostname": "dbc-1234dsafas-d0001.cloud.databricks.com"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
catalog	string	false
schema	string	false
table	string	false
query	string	false

Example

{
  ...
  "configuration": {
    "catalog": "samples",
    "query": "SELECT * FROM samples.nyctaxi.trips",
    "schema": "nyctaxi",
    "table": "trips"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	REQUIRED
advanced	object	false
schema	string	false
mirror_schemas	boolean	false
catalog	string	false

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "truncate_existing": false
    },
    "catalog": "samples",
    "mirror_schemas": false,
    "schema": "nyctaxi"
  }
}

Dialpad

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
api_key	string		true

Example

{
  "name": "dialpad connection",
  "type": "dialpad",
  "configuration": {
    "api_key": "tdYoegMt2eLlP0FWY9F3vxU3mM9ZG6TIQpzTeeH1uLEJWB81oEXqIyjbbRBzSv8QYaoiH8rH4sdrhIt1"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
object	string		false

Example

{
  ...
  "configuration": {
    "object": "Contacts"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Dittofeed

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
url	string		true
write_key	string		true

Example

{
  "name": "dittofeed connection",
  "type": "dittofeed",
  "configuration": {
    "url": "https://demo.dittofeed.com/",
    "write_key": "YoegMt2eLlP0FWY9F3vxU3mM9ZG6TIQpzTeeH1uLEJWB81oEXq="
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Facebook Ads

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
auth_method	string		true
accounts	array		false
byo_app_token	string	(required if `AuthMethod` is "token")	false
graph_api_version	string	(required if `AuthMethod` is "token")	false
account_id	string	(required if `AuthMethod` is "token")	false

Example

{
  "name": "fbaudience connection",
  "type": "fbaudience",
  "configuration": {
    "account_id": "1234567890",
    "accounts": [
        {
            "label": "",
            "value": ""
        }
    ],
    "auth_method": "token",
    "byo_app_token": "secret",
    "graph_api_version": "v19.0"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Freshdesk

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
subdomain	string	e.g. 'polytomic' if your helpdesk is at https://polytomic.freshdesk.com	true
apikey	string		true

Example

{
  "name": "freshdesk connection",
  "type": "freshdesk",
  "configuration": {
    "apikey": "secret",
    "subdomain": "polytomic"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
object	string		false

Example

{
  ...
  "configuration": {
    "object": "object"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Front

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
api_key	string		true

Example

{
  "name": "front connection",
  "type": "front",
  "configuration": {
    "api_key": "secret"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
stream_id	string		false

Example

{
  ...
  "configuration": {
    "stream_id": "contacts"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Google Ads

Connection

Configuration

NAME	TYPE	REQUIRED
oauth_refresh_token	string	false
accounts	array	false
client_id	string	false
client_secret	string	false

Example

{
  "name": "googleads connection",
  "type": "googleads",
  "configuration": {
    "accounts": [
        {
            "label": "",
            "value": ""
        }
    ],
    "client_id": "a45gadsfdsaf47byor2ugfbhsgllpf12gf56gfds",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Google BigQuery

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
service_account	string		true
location	string	Region or multi-region for query operations	false
override_project_id	string	Override service key's project ID for cross-account access	false
structured_values_as_json	boolean		false

Example

{
  "name": "bigquery connection",
  "type": "bigquery",
  "configuration": {
    "location": "us-east1",
    "override_project_id": "",
    "service_account": "",
    "structured_values_as_json": false
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
dataset	string	false
table	string	false

Example

{
  ...
  "configuration": {
    "dataset": "nyctaxi",
    "query": "SELECT * from sampledata.nyctaxi.taxis",
    "table": "taxis"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	REQUIRED
advanced	object	false
mirror_schemas	boolean	false
dataset	string	false

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "truncate_existing": false
    },
    "dataset": "dataset",
    "mirror_schemas": false
  }
}

Google Cloud MySQL

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
connection_name	string	Takes the form of project:region:instance	true
database	string		true
username	string		false
password	string	May be omitted when authenticating to Postgres using the service account key.	false
credentials	string		true
change_detection	boolean		false

Example

{
  "name": "googlecloudmysql connection",
  "type": "googlecloudmysql",
  "configuration": {
    "change_detection": false,
    "connection_name": "project:region:instance",
    "credentials": "",
    "database": "sampledb",
    "password": "secret",
    "username": "cloudsql"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
table	string	false
view	string	false

Example

{
  ...
  "configuration": {
    "query": "SELECT * from users",
    "table": "users",
    "view": "active_users"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

N/A

Google Cloud PostgreSQL

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
connection_name	string	Takes the form of project:region:instance	true
database	string		true
username	string		false
password	string	May be omitted when authenticating to Postgres using the service account key.	false
credentials	string		true
change_detection	boolean		false
publication	string		false

Example

{
  "name": "googlecloudsql connection",
  "type": "googlecloudsql",
  "configuration": {
    "change_detection": false,
    "connection_name": "project:region:instance",
    "credentials": "",
    "database": "sampledb",
    "password": "secret",
    "publication": "polytomic",
    "username": "cloudsql"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
table	string	false
view	string	false

Example

{
  ...
  "configuration": {
    "query": "SELECT * from users",
    "table": "users",
    "view": "active_users"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
replication_slot	string	Leave blank to allow Polytomic to manage a replication slot for this sync.	false

Example

{
  ...
  "source_configuration": {
    "replication_slot": "polytomic"
  }
}

Destination

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
advanced	object		false
schema	string	Output schema to write to	false
mirror_schemas	boolean	Indicates whether schemas should be mirrored	false

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "truncate_existing": false
    },
    "mirror_schemas": false,
    "schema": "public"
  }
}

Google Cloud Storage

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
project_id	string		false
client_email	string		false
service_account	string		true
bucket	string		true
is_single_table	boolean	Treat the files as a single table. (required if `is_single_table` is "true")	false
single_table_name	string	(required if `IsSingleTable` is "true")	false
single_table_file_format	string	(required if `IsSingleTable` is "true")	false
skip_lines	integer	Skip first N lines of each CSV file.	false

Example

{
  "name": "gcs connection",
  "type": "gcs",
  "configuration": {
    "bucket": "my-bucket",
    "client_email": "",
    "is_single_table": false,
    "project_id": "",
    "service_account": "",
    "single_table_file_format": "",
    "single_table_name": "collection",
    "skip_lines": 0
  }
}

Model Sync

Source

N/A

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
format	string	Output file encoding	false

Example

{
  ...
  "target": {
      "configuration": {
        "format": "csv"
    }
  }
}

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
format	string	Output file encoding	false
subfolder	string	Subfolder to write to (optional)	false

Example

{
  ...
  "destination_configuration": {
    "format": "csv",
    "subfolder": "reports"
  }
}

Google Sheets

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
oauth_refresh_token	string		false
service_account	string		false
spreadsheet_id	object		true
connect_mode	string	Either browser (default) or code; if code is specified, the response will include an auth_code for the user to enter when completing authorization.	false
client_id	string		false
client_secret	string		false

Example

{
  "name": "gsheets connection",
  "type": "gsheets",
  "configuration": {
    "client_id": "eb669428-1854-4cb1-a560-403e05b8acbf",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "connect_mode": "clientcredentials",
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "service_account": "",
    "spreadsheet_id": {
        "label": "",
        "value": ""
    }
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
selected_sheet	object		false

Example

{
  ...
  "configuration": {
    "selected_sheet": {}
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Harmonic

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
api_key	string		true

Example

{
  "name": "harmonic connection",
  "type": "harmonic",
  "configuration": {
    "api_key": "secret"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
source	string	false
stream_id	string	false
entity	string	false

Example

{
  ...
  "configuration": {
    "entity": "person",
    "source": "savedSearchPeopleGql",
    "stream_id": "urn:harmonic:saved_search:53635"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Heap

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
application_id	string		true

Example

{
  "name": "heap connection",
  "type": "heap",
  "configuration": {
    "application_id": "1234567890"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Hubspot

Connection

Configuration

NAME	TYPE	REQUIRED
oauth_refresh_token	string	false
client_id	string	false
client_secret	string	false

Example

{
  "name": "hubspot connection",
  "type": "hubspot",
  "configuration": {
    "client_id": "a45gadsfdsaf47byor2ugfbhsgllpf12gf56gfds",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
stream_id	string		false

Example

{
  ...
  "configuration": {
    "stream_id": "companies"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
write_null_values	boolean		false

Example

{
  ...
  "target": {
      "configuration": {
        "write_null_values": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

N/A

Intercom

Connection

Configuration

Example

{
  "name": "intercom connection",
  "type": "intercom",
  "configuration": {}
}

Model Sync

Source

N/A

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
write_null_values	boolean		false

Example

{
  ...
  "target": {
      "configuration": {
        "write_null_values": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

N/A

Iterable

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
api_key	string		true

Example

{
  "name": "iterable connection",
  "type": "iterable",
  "configuration": {
    "api_key": "secret"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Klaviyo

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
apikey	string		true
privateApikey	string		true

Example

{
  "name": "klaviyo connection",
  "type": "klaviyo",
  "configuration": {
    "apikey": "fsgsfdjswabfhkkocpbm3",
    "privateApikey": "pk_escdc06jswabfhkkocpbm3uyrwxzam"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
stream_id	string		false

Example

{
  ...
  "configuration": {
    "stream_id": "lists"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Kustomer

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
domain	string	e.g. 'polytomic' if your portal is 'https://polytomic.kustomerapp.com/app'	true
apikey	string		true

Example

{
  "name": "kustomer connection",
  "type": "kustomer",
  "configuration": {
    "apikey": "secret",
    "domain": "polytomic"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
object	string		false

Example

{
  ...
  "configuration": {
    "object": "customer"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Lob

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
apikey	string		true

Example

{
  "name": "lob connection",
  "type": "lob",
  "configuration": {
    "apikey": "test_0dc8dXXXXXXXXXXXXXXXXXXXXXX5b0cc"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Marketo

Connection

Configuration

NAME	TYPE	REQUIRED
client_id	string	true
client_secret	string	true
rest_endpoint	string	true
enforce_api_limits	boolean	false
daily_api_calls	integer	false
concurrent_imports	integer	false

Example

{
  "name": "marketo connection",
  "type": "marketo",
  "configuration": {
    "client_id": "629b6d74-f602-47f4-8fef-388485343d85",
    "client_secret": "123*******************xyz",
    "concurrent_imports": 5,
    "daily_api_calls": 37500,
    "enforce_api_limits": false,
    "rest_endpoint": "https://123-ABC-999.mktorest.com/rest"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
object	string		false
list	object		false

Example

{
  ...
  "configuration": {
    "list": {},
    "object": "lists"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
write_null_values	boolean		false

Example

{
  ...
  "target": {
      "configuration": {
        "write_null_values": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

N/A

Microsoft Ads

Connection

Configuration

NAME	TYPE	REQUIRED
oauth_refresh_token	string	false
accounts	array	false
client_id	string	false
client_secret	string	false

Example

{
  "name": "msads connection",
  "type": "msads",
  "configuration": {
    "accounts": [
        {
            "label": "",
            "value": ""
        }
    ],
    "client_id": "a45gadsfdsafbyorxhugfbhsgllpf12gf56gfds",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Microsoft SQL Server

Connection

Configuration

NAME	TYPE	REQUIRED
hostname	string	true
username	string	true
password	string	true
database	string	true
port	integer	true
ssl	boolean	false

Example

{
  "name": "mssql connection",
  "type": "mssql",
  "configuration": {
    "database": "sampledb",
    "hostname": "example.database.windows.net",
    "password": "secret",
    "port": 1433,
    "ssl": false,
    "username": "user"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
table	string	false
view	string	false

Example

{
  ...
  "configuration": {
    "query": "SELECT * from users",
    "table": "users",
    "view": "active_users"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
advanced	object		false
schema	string	Output schema to write to	false
mirror_schemas	boolean	Indicates whether schemas should be mirrored	false

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "truncate_existing": false
    },
    "mirror_schemas": false,
    "schema": "public"
  }
}

MySQL

Connection

Configuration

NAME	TYPE	REQUIRED
hostname	string	true
account	string	true
passwd	string	true
dbname	string	true
port	integer	true
ssl	boolean	false
ssh	boolean	false
ssh_user	string	false
ssh_host	string	false
ssh_port	integer	false
ssh_private_key	string	false
change_detection	boolean	false

Example

{
  "name": "mysql connection",
  "type": "mysql",
  "configuration": {
    "account": "admin",
    "change_detection": false,
    "dbname": "mydb",
    "hostname": "database.example.com",
    "passwd": "password",
    "port": 3306,
    "ssh": false,
    "ssh_host": "",
    "ssh_port": 22,
    "ssh_private_key": "",
    "ssh_user": "",
    "ssl": false
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
table	string	false
view	string	false

Example

{
  ...
  "configuration": {
    "query": "SELECT * from users",
    "table": "users",
    "view": "active_users"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

N/A

NetSuite

Connection

Configuration

NAME	TYPE	REQUIRED
account_id	string	true
consumer_key	string	true
consumer_secret	string	true
token	string	true
token_secret	string	true

Example

{
  "name": "netsuite connection",
  "type": "netsuite",
  "configuration": {
    "account_id": "1234567_SB1",
    "consumer_key": "ac3nougotfs7ict684hnbomxmcn496nqdo27b8myvkc19uhmxno8gx6o2g264kim2ivkaona2chyje5k2pcb904iuw",
    "consumer_secret": "ilez5hy9dugg7x3mg9qolw4m2g3jch7jgcf72wwf3yb5m71qzz4pldopork15bmj1pyqyniq5nhjd3yc3ka2hnobar",
    "token": "rgzq4xk3nz3huuwanngu9k1z7s8ogyr6haa7u7rg63qpxx5cn36ddxswhjse1dgwabqin1q9aay9nvfgkfjglgvtqv",
    "token_secret": "b1ay1kdvmw63azwvgej0f36t6nscxig5mczwicrlb7mnoaj5519dyobie4j0d3zbefg4r35nwqfel2eckqnf44sclg"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
object	string		false

Example

{
  ...
  "configuration": {
    "object": "account"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Outreach

Connection

Configuration

NAME	TYPE	REQUIRED
oauth_refresh_token	string	false
client_id	string	false
client_secret	string	false

Example

{
  "name": "outreach connection",
  "type": "outreach",
  "configuration": {
    "client_id": "a45gadsfdsaf47byor2ugfbhsgllpf12gf56gfds",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
stream_id	string		false

Example

{
  ...
  "configuration": {
    "stream_id": "accounts"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Pardot

Connection

Configuration

NAME	TYPE	REQUIRED
business_unit_id	string	false
account_type	string	false
enforce_api_limits	boolean	false
daily_api_calls	integer	false

Example

{
  "name": "pardot connection",
  "type": "pardot",
  "configuration": {
    "account_type": "Production",
    "business_unit_id": "1234567",
    "daily_api_calls": 0,
    "enforce_api_limits": false
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Pipedrive

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
domain	string		true
api_key	string		true

Example

{
  "name": "pipedrive connection",
  "type": "pipedrive",
  "configuration": {
    "api_key": "secret",
    "domain": "polytomic"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
stream_id	string		false
include_deleted	boolean		false

Example

{
  ...
  "configuration": {
    "include_deleted": false,
    "stream_id": "deals"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

PostgreSQL

Connection

Configuration

NAME	TYPE	REQUIRED
hostname	string	true
username	string	true
password	string	true
database	string	true
port	integer	true
ssl	boolean	false
ssh	boolean	false
ssh_user	string	false
ssh_host	string	false
ssh_port	integer	false
ssh_private_key	string	false
client_certs	boolean	false
client_certificate	string	false
client_key	string	false
ca_cert	string	false
change_detection	boolean	false
publication	string	false

Example

{
  "name": "postgresql connection",
  "type": "postgresql",
  "configuration": {
    "ca_cert": "",
    "change_detection": false,
    "client_certificate": "",
    "client_certs": false,
    "client_key": "",
    "database": "sampledb",
    "hostname": "database.example.com",
    "password": "password",
    "port": 5432,
    "publication": "polytomic",
    "ssh": false,
    "ssh_host": "",
    "ssh_port": 22,
    "ssh_private_key": "",
    "ssh_user": "",
    "ssl": false,
    "username": "postgres"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
table	string	false
view	string	false

Example

{
  ...
  "configuration": {
    "query": "SELECT * from users",
    "table": "users",
    "view": "active_users"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
replication_slot	string	Leave blank to allow Polytomic to manage a replication slot for this sync.	false

Example

{
  ...
  "source_configuration": {
    "replication_slot": "polytomic"
  }
}

Destination

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
advanced	object		false
mirror_schemas	boolean	Indicates whether schemas should be mirrored	false
schema	string	Output schema to write to	false

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "truncate_existing": false
    },
    "mirror_schemas": false,
    "schema": "public"
  }
}

PredictLeads

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
api_token	string		true
api_key	string		true

Example

{
  "name": "predictleads connection",
  "type": "predictleads",
  "configuration": {
    "api_key": "token",
    "api_token": "key"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

QuickBooks

Connection

Configuration

NAME	TYPE	REQUIRED
realm_id	string	true
oauth_refresh_token	string	false
client_id	string	false
client_secret	string	false

Example

{
  "name": "quickbooks connection",
  "type": "quickbooks",
  "configuration": {
    "client_id": "a45gadsfdsaf47byor2ugfbhsgllpf12gf56gfds",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "realm_id": "12345678"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
object	string		false
date_macro	string		false

Example

{
  ...
  "configuration": {
    "date_macro": "",
    "object": "accounts"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Redshift

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
hostname	string		true
username	string		true
password	string		true
database	string		true
port	integer		true
ssh	boolean		false
ssh_user	string		false
ssh_host	string		false
ssh_port	integer		false
ssh_private_key	string		false
aws_access_key_id	string	Access Key ID with read/write access to a bucket. More info: https://docs.polytomic.com/docs/redshift	false
aws_secret_access_key	string		false
s3_bucket_name	string	Name of bucket used for staging data load files	false
s3_bucket_region	string	Region of bucket. Note: must match region of redshift server	false

Example

{
  "name": "redshift connection",
  "type": "redshift",
  "configuration": {
    "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
    "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "database": "mydb",
    "hostname": "mycluster.us-west-2.redshift.amazonaws.com",
    "password": "password",
    "port": 5439,
    "s3_bucket_name": "my-bucket",
    "s3_bucket_region": "us-west-2",
    "ssh": false,
    "ssh_host": "",
    "ssh_port": 22,
    "ssh_private_key": "",
    "ssh_user": "",
    "username": "redshift_user"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
schema	string	false
table	string	false
view	string	false

Example

{
  ...
  "configuration": {
    "query": "SELECT * FROM sampledata.users",
    "schema": "sampledata",
    "table": "users",
    "view": "active_users"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	REQUIRED
advanced	object	false
schema	string	false
mirror_schemas	boolean	false

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "truncate_existing": false
    },
    "mirror_schemas": false,
    "schema": "schema"
  }
}

Reply

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
api_key	string		true

Example

{
  "name": "replyio connection",
  "type": "replyio",
  "configuration": {
    "api_key": "secret"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
stream_id	string		false

Example

{
  ...
  "configuration": {
    "stream_id": "people"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

S3

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
auth_mode	string	How to authenticate with AWS. Defaults to Access Key and Secret	true
aws_access_key_id	string	Access Key ID with read/write access to a bucket. (required if `AuthMode` is "aws_access_key_id")	false
aws_secret_access_key	string	(required if `AuthMode` is "aws_access_key_id")	false
aws_user	string		false
iam_role_arn	string	(required if `AuthMode` is "iam_role")	false
external_id	string	External ID for the IAM role	false
s3_bucket_region	string		true
s3_bucket_name	string	Bucket name (folder optional); ex: s3://polytomic/dataset	true
is_single_table	boolean	Treat the files as a single table. (required if `is_single_table` is "true")	false
single_table_name	string	(required if `IsSingleTable` is "true")	false
single_table_file_format	string	(required if `IsSingleTable` is "true")	false
skip_lines	integer	Skip first N lines of each CSV file.	false

Example

{
  "name": "s3 connection",
  "type": "s3",
  "configuration": {
    "auth_mode": "access_key_and_secret",
    "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
    "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "aws_user": "",
    "external_id": "",
    "iam_role_arn": "",
    "is_single_table": false,
    "s3_bucket_name": "s3://polytomic/dataset",
    "s3_bucket_region": "us-east-1",
    "single_table_file_format": "",
    "single_table_name": "collection",
    "skip_lines": 0
  }
}

Model Sync

Source

N/A

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
format	string	Output file encoding	false

Example

{
  ...
  "target": {
      "configuration": {
        "format": "csv"
    }
  }
}

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
format	string	Output file encoding	false
subfolder	string	Subfolder to write to (optional)	false

Example

{
  ...
  "destination_configuration": {
    "format": "csv",
    "subfolder": "reports"
  }
}

Salesforce

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
oauth_refresh_token	string		false
connect_mode	string	Either browser (default) or code; if code is specified, the response will include an auth_code for the user to enter when completing authorization. NOTE: when supplying client_id and client_secret the connect mode must be api	false
client_id	string	(required if `connect_mode` is "clientcredentials")	false
client_secret	string	(required if `connect_mode` is "clientcredentials")	false
domain	string	Enter your Salesforce login domain.	true
enforce_api_limits	boolean		false
daily_api_calls	integer		false
enable_tooling	boolean		false
enable_multicurrency_lookup	boolean		false

Example

{
  "name": "salesforce connection",
  "type": "salesforce",
  "configuration": {
    "client_id": "a45gadsfdsaf47byor2ugfbhsgllpf12gf56gfds",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "connect_mode": "api",
    "daily_api_calls": 0,
    "domain": "http://instance.my.salesforce.com",
    "enable_multicurrency_lookup": false,
    "enable_tooling": false,
    "enforce_api_limits": false,
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
table	string	false
query	string	false
include_deleted	boolean	false

Example

{
  ...
  "configuration": {
    "include_deleted": false,
    "query": "select Id from Contact",
    "table": "Contact"
  }
}

Target

Configuration

NAME	TYPE	REQUIRED
ingestion_api	string	false
sort_batches_by	string	false
insert_null_values	boolean	false
ignore_invalid_references	boolean	false
only_sync_different	boolean	false

Example

{
  ...
  "target": {
      "configuration": {
        "ignore_invalid_references": false,
        "ingestion_api": "bulk",
        "insert_null_values": false,
        "only_sync_different": false,
        "sort_batches_by": "AccountId"
    }
  }
}

Bulk Sync

Source

N/A

Destination

N/A

Segment

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
write_key	string		true

Example

{
  "name": "segment connection",
  "type": "segment",
  "configuration": {
    "write_key": "write-key"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Smartsheet

Connection

Configuration

NAME	TYPE	REQUIRED
oauth_refresh_token	string	false
client_id	string	false
client_secret	string	false

Example

{
  "name": "smartsheet connection",
  "type": "smartsheet",
  "configuration": {
    "client_id": "a45gadsfdsaf47byor2ugfbhsgllpf12gf56gfds",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
  }
}

Model Sync

Source

N/A

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Snowflake

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
account	string	e.g. uc193736182, ja8382948.us-central-1.gcp	true
username	string		true
password	string		false
dbname	string		true
warehouse	string		false
params	string	Additional connection parameters, formatted as a query string	false
key_pair_auth	boolean		false
private_key	string		false
private_key_passphrase	string		false

Example

{
  "name": "snowflake connection",
  "type": "snowflake",
  "configuration": {
    "account": "uc193736182",
    "dbname": "database_name",
    "key_pair_auth": false,
    "params": "",
    "password": "password",
    "private_key": "",
    "private_key_passphrase": "",
    "username": "user",
    "warehouse": "warehouse"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED
query	string	false
schema	string	false
table	string	false
view	string	false

Example

{
  ...
  "configuration": {
    "query": "SELECT * FROM sampledata.users",
    "schema": "sampledata",
    "table": "users",
    "view": "active_users"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false

Example

{
  ...
  "target": {
      "configuration": {
        "preserve_table_on_resync": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	REQUIRED
advanced	object	false
schema	string	false
mirror_schemas	boolean	false

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "truncate_existing": false
    },
    "mirror_schemas": false,
    "schema": "schema"
  }
}

Stripe

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
api_key	string		true

Example

{
  "name": "stripe connection",
  "type": "stripe",
  "configuration": {
    "api_key": "secret"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
stream_id	string		false

Example

{
  ...
  "configuration": {
    "stream_id": "customers"
  }
}

Target

N/A

Bulk Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
reporting_lookback	integer		false

Example

{
  ...
  "source_configuration": {
    "reporting_lookback": 0
  }
}

Destination

N/A

UserVoice

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
domain	string		true
api_key	string		true

Example

{
  "name": "uservoice connection",
  "type": "uservoice",
  "configuration": {
    "api_key": "secret",
    "domain": "polytomic"
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
stream_id	string		false

Example

{
  ...
  "configuration": {
    "stream_id": "suggestions"
  }
}

Target

N/A

Bulk Sync

Source

N/A

Destination

N/A

Webhook

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
url	string		true
headers	array		false

Example

{
  "name": "webhook connection",
  "type": "webhook",
  "configuration": {
    "headers": [
        {
            "name": "foo",
            "value": ""
        }
    ],
    "url": "https://example.com/webhook"
  }
}

Model Sync

Source

N/A

Target

Configuration

NAME	TYPE	REQUIRED
batch_size	integer	false
metadata	array	false
record_requests	boolean	false

Example

{
  ...
  "target": {
      "configuration": {
        "batch_size": 0,
        "metadata": [
                {}
        ],
        "record_requests": false
    }
  }
}

Bulk Sync

Source

N/A

Destination

N/A

Zendesk Support

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
domain	string		true
custom_api_limits	boolean		false
ratelimit_rpm	integer	Set a custom maximum request per minute limit.	false
auth_method	string		true
api_token	string	(required if `AuthMethod` is "apitoken")	false
email	string	(required if `AuthMethod` is "apitoken")	false

Example

{
  "name": "zendesk_support connection",
  "type": "zendesk_support",
  "configuration": {
    "api_token": "secret-token",
    "auth_method": "apitoken",
    "custom_api_limits": false,
    "domain": "polytomic.zendesk.com",
    "email": "[email protected]",
    "ratelimit_rpm": 0
  }
}

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
object	string		false

Example

{
  ...
  "configuration": {
    "object": "tickets"
  }
}

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED
replace_relationships	boolean		false

Example

{
  ...
  "target": {
      "configuration": {
        "replace_relationships": false
    }
  }
}