Stitch connects to a large, diverse universe of applications and data warehouses, each of which is configured differently. Connection property objects contain the properties necessary to create a source or destination.

This guide serves as a reference for connection property objects in the Connect API, including availability and the properties required (if supported) to configure each of Stitch’s destinations and sources via the API.

In this guide, we’ll cover:


Connection property object basics

What are connection property objects?

A connection property object is a JSON object that contains the properties necessary to create a source or destination using the Connect API. Connection property objects include info like connection credentials, configuration details, and for sources, some replication settings.

Connection property objects are used with the following endpoints to create and update connections:

Action Endpoint
Create a destination POST /v4/destinations
Update a destination PUT /v4/destinations/{destination_id}
Create a source POST /v4/sources
Update a destination PUT /v4/destinations/{destination_id}

Connection property types

Connection property objects can contain two types of properties:

  • Form properties are required to create the source or destination and complete the connection’s form step. The majority of sources and destinations will only have form properties.

  • OAuth properties are used to complete the source or destination’s oauth step, if the connection supports OAuth. OAuth properties are only required if you’re performing OAuth for the connection yourself. Otherwise, Stitch will perform the OAuth handshake using its own client credentials.

    Refer to the Performing OAuth with Stitch Connect guide for more info.

All connection properties should be sent in the properties argument when creating or updating a source or destination. Note: OAuth properties may be provided alongside form properties in a single POST or PUT request. A separate request isn’t necessary.


Search for a connection type

Looking for info on a specific connection type? This section contains info about all of Stitch’s sources and destinations and their availability in the API.

In the table below:

  • Connection name: The name and version of the connection.
  • Connection type: The type of connection. This will either be destination or source.
  • Connection property: Indicates if the connection is available via the API:

    • If available, this column will contain the name of the connection property used to create the connection type. Use the Create a destination or the Create a source endpoint to create the connection, depending on the connection’s type.
    • If unavailable, this column will contain Unavailable
Connection name Connection type Connection property
3PL Central (v1) Source platform.3plcentral
AdRoll (v1) Source platform.adroll
AfterShip (v1) Source Unsupported
Amazon Aurora MySQL RDS (v1) Source platform.aurora
Amazon Aurora PostgreSQL (v1) Destination postgres
Amazon Aurora PostgreSQL RDS (v2) Source platform.postgres
Amazon DynamoDB (v1) Source platform.dynamodb
Amazon Microsoft SQL Server RDS (v1) Source platform.mssql
Amazon MySQL RDS (v1) Source platform.mysql
Amazon Oracle RDS (v1) Source platform.oracle
Amazon PostgreSQL RDS (v1) Destination postgres
Amazon PostgreSQL RDS (v2) Source platform.postgres
Amazon Redshift (v2) Destination redshift
Amazon S3 (v1) Destination s3
Amazon S3 CSV (v1) Source platform.s3-csv
Amplitude (v1) Source platform.amplitude
AppsFlyer (v1) Source platform.appsflyer
Asana (v2) Source platform.asana
Autopilot (v1) Source platform.autopilot
BigCommerce (v1) Source platform.bigcommerce
Braintree (v1) Source platform.braintree
Branch (v1) Source Unsupported
Bronto (v1) Source platform.bronto
Campaign Manager (v1) Source platform.doubleclick-campaign-manager
Campaign Monitor (v1) Source platform.campaign-monitor
Chargebee (v1) Source platform.chargebee
Chargify (v1) Source platform.chargify
Close.io (v1) Source platform.closeio
Club Speed (v1) Source platform.clubspeed
Codat (v1) Source platform.codat
Contentful (v1) Source Unsupported
COVID-19 Public Data (v1) Source platform.covid-19
Customer.io (v1) Source Unsupported
Darksky (v1) Source platform.darksky
data.world (v1) Destination platform.darksky
Databricks Delta Lake (AWS) (v1) Destination databricks_delta
Delighted (v1) Source Unsupported
Deputy (v1) Source platform.deputy
Desk (v15-10-2015) Source Unsupported
Drip (v1) Source Unsupported
eBay (v1) Source platform.ebay
Eloqua (v1) Source platform.eloqua
Facebook Ads (v1) Source platform.facebook
FormKeep (v1) Source Unsupported
Freshdesk (v1) Source platform.freshdesk
Front (v1) Source platform.frontapp
FullStory (v1) Source platform.fullstory
GitHub (v1) Source platform.github
GitLab (v1) Source platform.gitlab
Google Ads (v1) Source platform.adwords
Google Analytics (v1) Source platform.google-analytics
Google Analytics (AdWords) (v05-12-2017) Source Unsupported
Google Analytics 360 (v1) Source platform.ga360
Google BigQuery (v2) Destination bigquery_v2
Google CloudSQL MySQL (v1) Source platform.cloudsql
Google CloudSQL PostgreSQL (v1) Destination postgres
Google CloudSQL PostgreSQL (v2) Source platform.hp-cloudsql-pg
Google ECommerce (v15-10-2015) Source Unsupported
Google Search Console (v1) Source platform.google-search-console
Google Sheets (v1) Source platform.google-sheets
Harvest (v2) Source platform.harvest
Harvest Forecast (v1) Source platform.harvest-forecast
Heap (v1) Source platform.heap
Help Scout (v1) Source platform.helpscout
Heroku (v1) Destination postgres
Heroku (v1) Source platform.heroku_pg
HubSpot (v2) Source platform.hubspot
iLEVEL (v1) Source platform.ilevel
Impact (v1) Source platform.impact
Incoming Webhooks (v1) Source Unsupported
Intacct (v1) Source platform.intacct
Intercom (v1) Source platform.intercom
Invoiced (v1) Source platform.invoiced
Iterable (v1) Source Unsupported
JIRA (v2) Source platform.jira
Klaviyo (v1) Source platform.klaviyo
Kustomer (v1) Source platform.kustomer
Lever (v1) Source platform.lever
LinkedIn Ads (v1) Source platform.linkedin-ads
Listrak (v1) Source platform.listrak
LivePerson (v1) Source platform.liveperson
Looker (v1) Source platform.looker
LookML (v1) Source platform.lookml
Magento (v1) Source platform.mysql
MailChimp (v1) Source platform.mailchimp
Mailjet (v1) Source Unsupported
Mailshake (v1) Source platform.mailshake
Mambu (v2) Source platform.mambu
Mandrill (v1) Source Unsupported
MariaDB (v1) Source platform.mariadb
Marketo (v2) Source platform.marketobulk
Microsoft Advertising (v2) Source platform.bing-ads
Microsoft Azure MySQL (v1) Source platform.mysql
Microsoft Azure SQL Database (v1) Source platform.mssql
Microsoft Azure Synapse Analytics (v1) Destination azure_sqldw
Microsoft SQL Server (v1) Source platform.mssql
Microsoft Teams (v1) Source platform.ms-teams
Mixpanel (v1) Source platform.mixpanel
MongoDB (v2) Source platform.mongodb
MongoDB Atlas (v2) Source platform.mongodb
MySQL (v2) Source platform.hp-mysql
NetSuite (v1) Source platform.netsuite
NetSuite Suite Analytics (v1) Source platform.netsuite-suite-analytics
Onfleet (v1) Source platform.onfleet
Oracle (v1) Source platform.oracle
Outbrain (v1) Source platform.outbrain
Outreach (v1) Source platform.outreach
Panoply (v2) Destination panoply
Pardot (v1) Source platform.pardot
Particle.io (v1) Source Unsupported
Pendo (v1) Source platform.pendo
Pepperjam (v1) Source platform.pepperjam
Pipedrive (v1) Source platform.pipedrive
PostgreSQL (v1) Destination postgres
PostgreSQL (v2) Source platform.hp-postgres
Quick Base (v1) Source platform.quickbase
QuickBooks (v1) Source platform.quickbooks
ReCharge (v1) Source platform.recharge
Recurly (v1) Source platform.recurly
Referral SaaSquatch (v1) Source platform.referral-saasquatch
Responsys (v1) Source platform.responsys
Revinate (v1) Source platform.revinate
RingCentral (v1) Source platform.ringcentral
SaaSOptics (v1) Source platform.saasoptics
Salesforce (v1) Source platform.salesforce
Salesforce Marketing Cloud (v1) Source platform.exacttarget
Segment (v1) Source Unsupported
Selligent (v1) Source platform.selligent
SendGrid (v1) Source Unsupported
SendGrid Core (v1) Source platform.sendgrid
SendWithUs (v1) Source Unsupported
SFTP (v1) Source platform.sftp
ShipHero (v1) Source platform.shiphero
Shippo (v1) Source platform.shippo
Shopify (v1) Source platform.shopify
Slack (v1) Source platform.slack
Snowflake (v1) Destination snowflake
SparkPost (v1) Source Unsupported
Square (v1) Source platform.square
Stripe (v1) Source platform.stripe
SurveyMonkey (v1) Source platform.surveymonkey
Taboola (v1) Source platform.taboola
Toggl (v1) Source platform.toggl
Trello (v1) Source platform.trello
Twitter Ads (v1) Source platform.twitter-ads
Typeform (v1) Source platform.typeform
UJET (v1) Source platform.ujet
Urban Airship (v1) Source platform.urban-airship
UserVoice (v1) Source platform.uservoice
Vero (v1) Source Unsupported
Wootric (v1) Source Unsupported
Workday RaaS (v1) Source platform.workday-raas
Xero (v1) Source platform.xero
Yotpo (v1) Source platform.yotpo
Zapier (v1) Source Unsupported
Zendesk Chat (v1) Source Unsupported
Zendesk Support (v1) Source platform.zendesk
Zoom (v1) Source platform.zoom
Zuora (v1) Source platform.zuora

All connection property objects

SOURCE

The 3PL Central source connection property object

Property type: platform.3plcentral Connection type: Source
Documentation: Stitch docs

3PL Central connections read data from the 3PL Central API and correspond to source type: platform.3plcentral.

The credentials required to configure a 3PL Central source must be requested from a 3PL Central account manager. Refer to the 3PL Central documentation for more info.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

base_url STRING

The API URL to which /endpoints are appended.

client_id STRING

The secure OAuth 2.0 identifier for the 3PL Central application/client.

client_secret STRING

The secure OAuth 2.0 secret key for the 3PL Central application/client authentication.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

customer_id STRING

The ID for the 3PL Central customer organization.

facility_id STRING

The ID for the 3PL Central warehouse facility.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

tpl_key STRING

A 3PL Central warehouse-specific 3PL key.

user_login_id STRING

The ID for the 3PL Central user.

Example 3PL Central source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "base_url":"https://secure-wms.com",
  "client_id":"<OAUTH_CLIENT_ID>",
  "client_secret":"<OAUTH_CLIENT_SECRET>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "customer_id":"<CUSTOMER_INTEGER_ID>",
  "facility_id":"<FACILITY_INTEGER_ID>",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z",
  "tpl_key":"<WH_SPECIFIC_3PL_KEY>",
  "user_login_id":"<USER_INTEGER_ID>"
}

Back to connection property object search


SOURCE

The AdRoll source connection property object

Property type: platform.adroll Connection type: Source
Documentation: Stitch docs

AdRoll connections read data from the AdRoll API and correspond to source type: platform.adroll.

AdRoll source connection property objects can contain two types of properties:

AdRoll source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

end_date STRING

An ISO 8601-compliant date to indicate the date that Stitch should stop replicating data from your AdRoll account. This can be useful if you want to replicate campaign data from a specific timerange.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example AdRoll source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "end_date":"2020-08-01T00:00:00Z",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

AdRoll source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to AdRoll's documentation for more info on performing OAuth with AdRoll.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
access_token STRING

An access token generated by a NextRoll OAuth handshake.

client_secret STRING

The secret key of the AdRoll account to use when extracting data.

refresh_token STRING

The grant to refresh your NextRoll access token when it has expired.

Example AdRoll source connection property object with OAuth properties
{
  "access_token":"<ACCESS_TOKEN>",
  "client_secret":"<SECRET_KEY>",
  "refresh_token":"<YOUR_REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Amazon Aurora source connection property object

Property type: platform.aurora Connection type: Source
Documentation: Stitch docs

Amazon Aurora connections read data from Amazon Aurora databases and correspond to source type: platform.aurora.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
allow_non_auto_increment_pks STRING

If true, an auto-incrementing Primary Key will not be required for tables using Full Table Replication. Auto-incrementing Primary Keys are used during full table replication to allow the replication of a table to span multiple replication jobs.

Unless set, this property will default to true.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

filter_dbs STRING

This is an internal field and is for Stitch use only.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 1

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

host STRING

The IP address or hostname of the database server.

password STRING

The password for the user connecting to the database server. Note: This property will never be returned by the API, but it can be submitted when creating or modifying a connection.

port INTEGER

The port of the database server. The default is 3306.

server_id STRING

Defines the unique ID of the server that Stitch will connect to, if using Log-based (binlog) Replication.

Server IDs must be unique, as MySQL doesn’t allow replication to simultaneously occur across multiple connections using the same server ID. For more info about this setting in Stitch, refer to the MySQL documentation.

ssh STRING

If true, an SSH tunnel will be used to connect to the database.

ssh_host STRING

The IP address or hostname of the SSH server. This property is only required if ssh: true.

ssh_port STRING

The port of the SSH server. This property is only required if ssh: true.

ssh_user STRING

The username of the SSH user. This property is only required if ssh: true.

ssl STRING

If true, SSL will be used to connect to the database.

use_log_based_replication STRING

If true, Log-based Incremental Replication will be used as the default Replication Method for tables set to replicate. This choice can be overriden on individual tables at any time.

user STRING

The username of the database user.

database STRING

The name of the logical database to connect to.

Example Amazon Aurora source connection property object with form properties
{
  "allow_non_auto_increment_pks":"true",
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "filter_dbs":"",
  "frequency_in_minutes":"30",
  "host":"<HOST_ADDRESS>",
  "password":"<PASSWORD>",
  "port":"3306",
  "server_id":"<UNIQUE_SERVER_ID>",
  "ssh":"true",
  "ssh_host":"<SSH_HOST>",
  "ssh_port":"22",
  "ssh_user":"<SSH_USERNAME>",
  "ssl":"false",
  "use_log_based_replication":"true",
  "user":"<USERNAME>",
  "database
":"<DATABASE_NAME>"
}

Back to connection property object search


SOURCE

The Amazon DynamoDB source connection property object

Property type: platform.dynamodb Connection type: Source
Documentation: Stitch docs

Amazon DynamoDB connections read data from Amazon DynamoDB databases and correspond to source type: platform.dynamodb.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
account_id STRING

The user’s Amazon Web Services (AWS) Account ID. Refer to the Amazon DynamoDB documentation for more info.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

external_id STRING

The external ID associated with the Amazon Web Services (AWS) Identity Access Management (IAM) role used by Stitch. In AWS, external IDs are used to increase role security when granting access to accounts that you don’t own or have administrative access to. Stitch will provide this ID when accessing Amazon DynamoDB.

This value can be anything, but it must be the same as the external ID provided in the AWS console when creating the Stitch IAM role. Refer to the Amazon DynamoDB documentation for more info.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 1

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

region_name STRING

The name of the region your Amazon DynamoDB instance resides in.

role_name STRING

The name of the AWS IAM role Stitch should assume when extracting data from Amazon DynamoDB. This role will have the permissions in the IAM policy associated with the role.

Refer to the Amazon DynamoDB documentation for more info about the IAM policy, role, and how to create them in AWS.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

use_local_dynamo STRING

This is a Stitch internal field.

Example Amazon DynamoDB source connection property object with form properties
{
  "account_id":"123456789101",
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "external_id":"stitch_connection_12345",
  "frequency_in_minutes":"60",
  "region_name":"us-east-2",
  "role_name":"<ROLE_NAME>",
  "start_date":"2018-01-10T00:00:00Z",
  "use_local_dynamo":""
}

Back to connection property object search


DESTINATION

The Amazon Redshift destination connection property object

Property type: redshift Connection type: Destination
Documentation: Stitch docs

Amazon Redshift connections write data to a Amazon Redshift and correspond to destination type: redshift.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
database STRING

The name of the logical database to connect to.

encryption_host STRING

If using SSH encryption, the host of the SSH server. Required only if encryption_type is ssh.

encryption_port STRING

If using SSH encryption, the port of the SSH server. Required only if encryption_type is ssh.

encryption_type STRING

Indicates that SSH encryption should be used to connect to the destination. Valid values are:

  • none - No encryption will be used.
  • ssh - SSH encryption will be used to connect to the destination. The SSH connection details should be submitted using the encryption_host, encryption_port, and encryption_username.
encryption_username STRING

If using SSH encryption, the name of the SSH user. Required only if encryption_type is ssh.

host STRING

The IP address or hostname of the database server.

password STRING

The password for the user connecting to the database server. Note: This property will never be returned by the API, but it can be submitted when creating or modifying a connection.

port STRING

The port of the database server. The default is 5439.

username STRING

The username of the database user.

Example Amazon Redshift destination connection property object with form properties
{
  "database":"<DATABASE_NAME>",
  "encryption_host":"<ENCRYPTION_HOST_ADDRESS>",
  "encryption_port":"<ENCRYPTION_PORT>",
  "encryption_type":"ssh",
  "encryption_username":"<ENCRYPTION_USERNAME>",
  "host":"<HOST_ADDRESS>",
  "password":"<PASSWORD>",
  "port":"5439",
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The Amazon S3 CSV source connection property object

Property type: platform.s3-csv Connection type: Source
Documentation: Stitch docs

Amazon S3 CSV connections read data from CSV files in an Amazon S3 bucket and correspond to source type: platform.s3-csv.

Refer to the Amazon S3 CSV documentation for requirements for CSV files.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
account_id STRING

The user’s Amazon Web Services (AWS) Account ID. Refer to the Amazon S3 CSV documentation for more info.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

bucket STRING

The name of the bucket Stitch should replicate data from. This value should not contain any URLs, https, or S3 parts.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

external_id STRING

The external ID associated with the Amazon Web Services (AWS) Identity Access Management (IAM) role used by Stitch. In AWS, external IDs are used to increase role security when granting access to accounts that you don’t own or have administrative access to. Stitch will provide this ID when accessing Amazon S3 CSV.

This value can be anything, but it must be the same as the external ID provided in the AWS console when creating the Stitch IAM role. Refer to the Amazon S3 CSV documentation for more info.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 1

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

role_name STRING

The name of the AWS IAM role Stitch should assume when extracting data from Amazon S3. This role will have the permissions in the IAM policy associated with the role.

Refer to our Amazon S3 CSV documentation for more info about the IAM policy, role, and how to create them in AWS.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

tables STRING

A series of properties defining the CSV files to be tracked as tables. For every table configuration, this property will contain a JSON object with the following properties. Note: Every property should be an escaped string.

Refer to the Amazon S3 CSV documentation for requirements for CSV files.

  • search_pattern - The search criteria Stitch should use when selecting CSV files for extraction. This can be the name of a single file or a regular expression. For example: customers.csv or *\.csv
  • search_prefix - The directory path Stitch should limit the file search to. For example: exports/data
  • table_name - The name of the table as it should appear in the destination. For example: customers
  • key_properties - A comma-separated list of header fields in the CSV files Stitch can use to uniquely identify records. For example: _id,date

    Note: If undefined, data will be loaded to the table in an append-only fashion. Refer to the Amazon S3 CSV documentation for more info.

  • date_overrides - A comma-separated list of header fields in the CSV that should be typed as datetime fields in the destination. For example: updated_at,created_at

    Note: If columns aren’t specified and values can’t be parsed as dates, Stitch will load data for the columns as nullable strings. Refer to the Amazon S3 CSV documentation for more info.

  • delimiter - The field separator delimiter used in the CSV files. Accepted values are:

    • , - Comma
    • | - Pipe
    • \t - Tab
Example Amazon S3 CSV source connection property object with form properties
{
  "account_id":"123456789101",
  "anchor_time":"2018-04-30T17:00:00Z",
  "bucket":"com-test-stitch-bucket",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "external_id":"stitch_connection_12345",
  "frequency_in_minutes":"60",
  "role_name":"<ROLE_NAME>",
  "start_date":"2018-01-10T00:00:00Z",
  "tables":"[{\"search_pattern\":\"customers.csv\",\"search_prefix\":\"exports\/files\",\"table_name\":\"customers\",\"key_properties\":\"id\",\"date_overrides\":\"created_at\",\"delimiter\":\",\"},{\"search_pattern\":\"orders.csv\",\"search_prefix\":\"exports\/files\",\"table_name\":\"orders\",\"key_properties\":\"id\",\"date_overrides\":\"updated_at\",\"delimiter\":\",\"}]"
}

Back to connection property object search


DESTINATION

The Amazon S3 destination connection property object

Property type: s3 Connection type: Destination
Documentation: Stitch docs

Amazon S3 connections write data to an Amazon S3 bucket and correspond to destination type: s3.

To set up an Amazon S3 destination, users will need to:

  1. Create a bucket policy that grants Stitch permission to write to the bucket
  2. Create a “challenge file” in the bucket that allows Stitch to test the connection

Refer to our Amazon S3 documentation for additional details.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
csv_delimiter STRING

Defines the delimiter used if output_file_format is csv. Accepted values are:

  • , (comma)
  • | (pipe)
  • \t (tab)
csv_force_quote STRING

If true, Stitch will place all elements of key-value pairs in quotes when output_file_format is csv.

For example: Numerical fields will appear as "123" instead of 123.

output_file_format STRING

Defines the type of file Stitch will write to the bucket. Possible values are:

  • csv, which will use CSV (.csv) files
  • jsonl, which will use JSON (.jsonl) files

For examples of what data will look like in each format, refer to our Amazon S3 documentation.

s3_bucket STRING

The name of the Amazon S3 bucket Stitch will write to.

s3_key_format_string STRING

Defines the naming convention Stitch should use when creating Object Keys. Object Keys are used to name tables when Stitch writes to the bucket.

The required elements for an Object Key are:

  • [integration_name]
  • [table_name]
  • [table_version]
  • [timestamp_loaded]

For more info on construcing an S3 Object Key, refer to our Amazon S3 documentation.

sentinel_key STRING

The sentinel key is the name the challenge file in the bucket must have. The challenge file is a blank file that Stitch uses to test the permissions for the bucket. Note: The API treats this property as a credential, which means it won’t be returned in responses.

This file:

  • Must have a name that begins with stitch-challenge-file-. For example: stitch-challenge-file-af295ad1-7a4b-4881-89dc-c9be27de13a5
  • Must remain in the bucket even after the inital setup is complete

Refer to our Amazon S3 documentation for additional details.

Example Amazon S3 destination connection property object with form properties
{
  "csv_delimiter":"|",
  "csv_force_quote":"true",
  "output_file_format":"csv",
  "s3_bucket":"com-stitch-s3-bucket",
  "s3_key_format_string":"[integration_name]/[table_name]/[table_version]_[timestamp_loaded].<csv|json>",
  "sentinel_key":"stitch-challenge-file-af295ad1-7a4b-4881-89dc-c9be27de13a5"
}

Back to connection property object search


SOURCE

The Amplitude source connection property object

Property type: platform.amplitude Connection type: Source
Documentation: Stitch docs

Amplitude connections read data from the Amplitude API and correspond to source type: platform.amplitude.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
account STRING

The account ID for the Amplitude Snowflake warehouse.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

username STRING

The username of the database user.

warehouse STRING

The name of the Amplitude Snowflake warehouse.

Example Amplitude source connection property object with form properties
{
  "account":"<AMPLITUDE_SNOWFLAKE_ACCOUNT>",
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "start_date":"2018-01-10T00:00:00Z",
  "username":"<USERNAME>",
  "warehouse":"<AMPLITUDE_WAREHOUSE>"
}

Back to connection property object search


SOURCE

The AppsFlyer source connection property object

Property type: platform.appsflyer Connection type: Source
Documentation: Stitch docs

AppsFlyer connections read data from the AppsFlyer API and correspond to source type: platform.appsflyer.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_token STRING

The API token for the AppsFlyer account Stitch should replicate data from. Refer to the AppsFlyer documentation for instructions on retrieving this info.

app_id STRING

The app ID for the AppsFlyer account Stitch should replicate data from. Refer to the AppsFlyer documentation for instructions on retrieving this info.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example AppsFlyer source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_token":"<API_TOKEN>",
  "app_id":"<API_TOKEN>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Asana source connection property object

Property type: platform.asana Connection type: Source
Documentation: Stitch docs

Asana connections read data from the Asana API and correspond to source type: platform.asana.

Asana source connection property objects can contain two types of properties:

Asana source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Asana source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Asana source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Asana's documentation for more info on performing OAuth with Asana.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
access_token STRING

The Asana token to use in future requests to the Asana API, created after a successful OAuth handshake.

client_id STRING

Your Asana OAuth application client ID.

client_secret STRING

Your Asana OAuth application client secret.

redirect_uri STRING

Your Asana OAuth application redirect URL. This is provided to Asana when you register your OAuth application.

refresh_token STRING

If exchanging a code with Asana, a long-lived token that can be used to retrieve new access_tokens when old ones expire.

Example Asana source connection property object with OAuth properties
{
  "access_token":"<ACCESS_TOKEN>",
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "redirect_uri":"<YOUR_OAUTH_REDIRECT_URI>",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Autopilot source connection property object

Property type: platform.autopilot Connection type: Source
Documentation: Stitch docs

Autopilot connections read data from the Autopilot API and correspond to source type: platform.autopilot.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_key STRING

An API key for the Autopilot account that Stitch should replicate data from.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (3600).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Autopilot source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"3600",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The BigCommerce source connection property object

Property type: platform.bigcommerce Connection type: Source
Documentation: Stitch docs

BigCommerce connections read data from the BigCommerce API and correspond to source type: platform.bigcommerce.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
access_token STRING

The user’s BigCommerce API access token. Refer to the BigCommerce documentation for instructions on retrieving this credential.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

client_id STRING

The user’s BigCommerce API client ID. Refer to the BigCommerce documentation for instructions on retrieving this credential.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

store_hash STRING

The user’s BigCommerce store hash. Refer to the BigCommerce documentation for instructions on retrieving this credential.

Example BigCommerce source connection property object with form properties
{
  "access_token":"<API_ACCESS_TOKEN>",
  "anchor_time":"2018-04-30T17:00:00Z",
  "client_id":"<API_CLIENT_ID>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z",
  "store_hash":"<STORE_HASH>"
}

Back to connection property object search


SOURCE

The Braintree source connection property object

Property type: platform.braintree Connection type: Source
Documentation: Stitch docs

Braintree connections read data from the Braintree API and correspond to source type: platform.braintree.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

merchant_id STRING

The Braintree account’s merchant ID. Note: Stitch’s Braintree integration replicates data from the default merchant account under this merchant ID. Refer to the Braintree documentation for instructions on retrieving this info.

private_key STRING

The Braintree account’s private key. Refer to the Braintree documentation for instructions on retrieving this info.

public_key STRING

The Braintree account’s public key. Refer to the Braintree documentation for instructions on retrieving this info.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Braintree source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "merchant_id":"<MERCHANT_ID>",
  "private_key":"<PRIVATE_KEY>",
  "public_key":"<PUBLIC_KEY>",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Bronto source connection property object

Property type: platform.bronto Connection type: Source
Documentation: Stitch docs

Bronto connections read data from the Bronto API and correspond to source type: platform.bronto.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

token STRING

The API token for the Bronto account Stitch should replicate data from.

Example Bronto source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z",
  "token":"<API_TOKEN>"
}

Back to connection property object search


SOURCE

The Campaign Manager source connection property object

Property type: platform.doubleclick-campaign-manager Connection type: Source
Documentation: Stitch docs

Campaign Manager connections read data from the Campaign Manager API and correspond to source type: platform.doubleclick-campaign-manager.

Campaign Manager source connection property objects can contain two types of properties:

Campaign Manager source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted.

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

profile_id STRING

The ID of the Campaign Manager profile you want to replicate data from. Refer to the Campaign Manager documentation for instructions on retrieving this info.

Example Campaign Manager source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "profile_id":"<CAMPAIGN_MANAGER_PROFILE_ID>"
}

Back to connection property object search

Campaign Manager source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Campaign Manager's documentation for more info on performing OAuth with Campaign Manager.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

Your Campaign Manager OAuth application’s client ID. Refer to Google’s documentation for more info.

client_secret STRING

Your Campaign Manager OAuth application’s client secret. Refer to Google’s documentation for more info.

refresh_token STRING

A long-lived token, used to generate new access tokens when needed. Refer to Google’s documentation for more info.

Example Campaign Manager source connection property object with OAuth properties
{
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Campaign Monitor source connection property object

Property type: platform.campaign-monitor Connection type: Source
Documentation: Stitch docs

Campaign Monitor connections read data from the Campaign Monitor API and correspond to source type: platform.campaign-monitor.

Campaign Monitor source connection property objects can contain two types of properties:

Campaign Monitor source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

client_id STRING

The user’s Campaign Monitor API client ID. This can be found in the Campaign Monitor app in Account Settings > API keys.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Campaign Monitor source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "client_id":"<CAMPAIGN_MONITOR_CLIENT_ID>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Campaign Monitor source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Campaign Monitor's documentation for more info on performing OAuth with Campaign Monitor.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
access_token STRING

An Campaign Monitor OAuth token.

refresh_token STRING

A long-lived Campaign Monitor token which can be used to obtain a new Campaign Monitor access_token.

Example Campaign Monitor source connection property object with OAuth properties
{
  "access_token":"<CAMPAIGN MONITOR_ACCESS_TOKEN>",
  "refresh_token":"<CAMPAIGN MONITOR_REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Chargebee source connection property object

Property type: platform.chargebee Connection type: Source
Documentation: Stitch docs

Chargebee connections read data from the Chargebee API and correspond to source type: platform.chargebee.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_key STRING

The user’s Chargebee API key. Refer to the Chargebee documentation for info on generating this credential.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

site STRING

The name of the user’s Chargebee site. This can be found in the Chargebee site URL. For example: If the URL was https://stitch.chargebee.com, only stitch would be entered into this field.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Chargebee source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<CHARGEBEE_API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "site":"<CHARGEBEE_SITE_NAME>",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Chargify source connection property object

Property type: platform.chargify Connection type: Source
Documentation: Stitch docs

Chargify connections read data from the Chargify API and correspond to source type: platform.chargify.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_key STRING

A Chargify API key. Refer to the Chargify documentation for instructions on creating this credential.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

subdomain STRING

Your Chargify subdomain. For example: If the full URL of your Chargify site were https://stitch.my-chargify-site.com, this value would be stitch.

Example Chargify source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<YOUR_CHARGIFY_API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z",
  "subdomain":"<YOUR_CHARGIFY_SUBDOMAIN>"
}

Back to connection property object search


SOURCE

The Close.io source connection property object

Property type: platform.closeio Connection type: Source
Documentation: Stitch docs

Close.io connections read data from the Close.io API and correspond to source type: platform.closeio.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_key STRING

Your API key. API keys can be generated in by navigating to Settings > Your API Keys.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Close.io source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Club Speed source connection property object

Property type: platform.clubspeed Connection type: Source
Documentation: Stitch docs

Club Speed connections read data from the Club Speed API and correspond to source type: platform.clubspeed.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

private_key STRING

Your Club Speed private API key. You will need to contact Club Speed support to obtain this credential.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

subdomain STRING

Your Club Speed subdomain.

For example: If the full URL is stitchdata.clubspeedtiming.com, only stitchdata should be entered.

Example Club Speed source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "private_key":"<PRIVATE_API_KEY>",
  "start_date":"2018-01-10T00:00:00Z",
  "subdomain":"<SUBDOMAIN>"
}

Back to connection property object search


SOURCE

The Codat source connection property object

Property type: platform.codat Connection type: Source
Documentation: Stitch docs

Codat connections read data from the Codat API and correspond to source type: platform.codat.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_key STRING

Your Codat API key. Refer to the Codat documentation for instructions on retrieving this credential.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

uat_urls STRING

Indicates whether the instance being connected is a UAT (sandbox) instance or not.

Example Codat source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<CODAT_API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z",
  "uat_urls":""
}

Back to connection property object search


SOURCE

The COVID-19 Public Data source connection property object

Property type: platform.covid-19 Connection type: Source
Documentation: Stitch docs

COVID-19 Public Data connections read data from the COVID-19 Public Data API and correspond to source type: platform.covid-19.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_token STRING

A GitHub access token which allows access to any project the user wants to replicate data from. Note: This access token must have the repo scope at a minimum. Refer to the COVID-19 Public Data documentation for more info.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example COVID-19 Public Data source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_token":"<ACCESS_TOKEN>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Darksky source connection property object

Property type: platform.darksky Connection type: Source
Documentation: Stitch docs

Darksky connections read data from the Darksky API and correspond to source type: platform.darksky.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

language STRING

The language that summary attributes in the forecast table should be returned in. For example: If set to en, summary data will be returned in English.

Refer to Darksky’s documentation for a list of accepted values.

location_list STRING

The longitude and latitude of the locations to be returned. The locations must be semi-colon delineated.

For example: <latitude>,<longitude> is an accepted value for a single location, and <latitude>,<longitude>;<latitude>,<longitude>; ... etc is accepted for multiple locations.

secret_key STRING

Your Darksky secret API key. Refer to the Darksky documentation for instructions on obtaining this credential.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

units STRING

The requested unit of measurement for weather conditions to be returned.

For example: us for Imperial Units, and si for International System of Units.

Example Darksky source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "language":"en",
  "location_list":"00.000000,-000.000000",
  "secret_key":"<DARKSKY_SECRET_KEY>",
  "start_date":"2018-01-10T00:00:00Z",
  "units":"us"
}

Back to connection property object search


DESTINATION

The Databricks Delta Lake destination connection property object

Property type: databricks_delta Connection type: Destination
Documentation: Stitch docs

Databricks Delta Lake connections write data to a Databricks Delta Lake destination via an Amazon S3 bucket and correspond to destination type: databricks_delta.

To set up an Databricks Delta Lake destination, users will need to:

  1. Configure access for Stitch and Databricks to an existing Amazon S3 bucket
  2. Generate a Databricks REST API token
  3. Retrieve the Databricks’ cluster JDBC URL

Depending on your Amazon Web Services (AWS) configuration, you may need to perform additional steps to successfully connect this destination.

Refer to our Databricks Delta Lake documentation for additional details.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
access_token STRING

A Databricks REST API access token. Refer to the Databricks Delta Lake documentation for instructions on generating this credential.

jdbc_url STRING

The JDBC URL used to connect to your Databricks cluster. Refer to the Databricks Delta Lake documentation for instructions on retrieving this info.

ssh_config OBJECT

An object containing properties for configuring SSH encryption for the destination.

Name Type Required Description
ssh STRING

Indicates whether SSH encryption should be used to connect to the destination. Valid values are:

  • false - No encryption will be used.
  • true - SSH encryption will be used to connect to the destination. The SSH connection details should be submitted using the ssh_host, ssh_port, and ssh_user properties.
ssh_host STRING

If using SSH encryption, the host of the SSH server. Required only if ssh is true.

ssh_port STRING

If using SSH encryption, the port of the SSH server. Required only if ssh is true.

ssh_user STRING

If using SSH encryption, the name of the SSH user. Required only if ssh is true.

staging_area OBJECT

Connection information for the Amazon S3 bucket Stitch will stage data to before loading into Databricks Delta Lake.

Name Type Required Description
scheme STRING

This will be s3.

bucket_name STRING

The name of the Amazon S3 bucket.

Note: This must be a pre-existing bucket. Refer to the Databricks Delta Lake documentation for instructions on configuring access to the bucket for Stitch and Databricks Delta Lake.

Example Databricks Delta Lake destination connection property object with form properties
{
  "access_token":"<ACCESS_TOKEN>",
  "jdbc_url":"jdbc:spark://<server-hostname>:<port>/default;transportMode=http;ssl=1;httpPath=<http-path>;AuthMech=3;UID=token;PWD=<personal-access-token>",
  "ssh_config":{
     "ssh":"true",
     "ssh_host":"your-ssh-server-address",
     "ssh_port":"22",
     "ssh_user":"stitch"
    },
  "staging_area":{
     "scheme": "s3",
     "bucket_name": "<S3-BUCKET-NAME>"
    }
}

Back to connection property object search


SOURCE

The Deputy source connection property object

Property type: platform.deputy Connection type: Source
Documentation: Stitch docs

Deputy connections read data from the Deputy API and correspond to source type: platform.deputy.

Deputy source connection property objects can contain two types of properties:

Deputy source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Deputy source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Deputy source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Deputy's documentation for more info on performing OAuth with Deputy.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

Your Deputy OAuth application’s client ID.

client_secret STRING

Your Deputy OAuth application’s client secret.

domain STRING

The Deputy subdomain of the user authorizing the connection.

redirect_uri STRING

A URL where Deputy will forward the user with access credentials for your application.

refresh_token STRING

A long-lived token, used to generate new Deputy access tokens when old ones expire.

Example Deputy source connection property object with OAuth properties
{
  "client_id":"<YOUR_DEPUTY_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_DEPUTY_OAUTH_CLIENT_SECRET>",
  "domain":"your-deputy-subdomain.na.deputy.com",
  "redirect_uri":"https://your-deputy-app.com/app/",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The eBay source connection property object

Property type: platform.ebay Connection type: Source
Documentation: Stitch docs

eBay connections read data from the eBay API and correspond to source type: platform.ebay.

eBay source connection property objects can contain two types of properties:

eBay source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

Example eBay source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60"
}

Back to connection property object search

eBay source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to eBay's documentation for more info on performing OAuth with eBay.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

This is your App ID in your eBay seller account.

client_secret STRING

This is your Cert ID in your eBay seller account.

refresh_token STRING

A long-lived token, used to generate new eBay access tokens when old ones expire.

scope STRING

This allows Stitch to have certain access privileges to your eBay sales data.

Example eBay source connection property object with OAuth properties
{
  "client_id":"<CLIENT_ID>",
  "client_secret":"<CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>",
  "scope":"<SCOPE>"
}

Back to connection property object search


SOURCE

The Eloqua source connection property object

Property type: platform.eloqua Connection type: Source
Documentation: Stitch docs

Eloqua connections read data from the Eloqua Bulk and REST APIs and correspond to source type: platform.eloqua.

Eloqua source connection property objects can contain two types of properties:

Eloqua source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

bulk_page_size STRING

The number of records each page in a bulk export should contain. Note: This setting only affects streams that use the Eloqua Bulk API. Refer to the Eloqua documentation for info about how each stream is replicated.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Eloqua source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "bulk_page_size":"5000",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Eloqua source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Eloqua's documentation for more info on performing OAuth with Eloqua.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

Your Eloqua OAuth application’s client ID, obtained when you register your app with Eloqua.

client_secret STRING

Your Eloqua OAuth application’s client secret, obtained when you register your app with Eloqua.

redirect_uri STRING

Your Eloqua OAuth application’s registered redirection endpoint. This should be the same URL entered as the Callback Url when you registered your app.

refresh_token STRING

A long-lived token, used to generate new Eloqua access tokens when old ones expire.

Example Eloqua source connection property object with OAuth properties
{
  "client_id":"<YOUR_ELOQUA_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_ELOQUA_OAUTH_CLIENT_ID>",
  "redirect_uri":"https://your-awesome-company.com/app",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Facebook Ads source connection property object

Property type: platform.facebook Connection type: Source
Documentation: Stitch docs

Facebook Ads connections read data from the Facebook Ads API and correspond to source type: platform.facebook.

Facebook Ads source connection property objects can contain two types of properties:

Facebook Ads source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

attribution_window STRING

Defines the number, in days, Stitch should use as an attribution window. An attribution window is the period of time for attributing results to ads and the lookback period after those actions occur during which ad results are counted.

Accepted values, in days:

  • 1
  • 7
  • 28

To ensure your Facebook Ads and Stitch settings align, we recommend using the same attribution window in Stitch that you use in Facebook Ads. For example: If the attribution window is 28 days in Facebook, this value should be 28.

If your click and view windows differ, you should select the greater of the two. For example: If clicks have a window of 7 days and views have a window of 1 day, you should enter 7 for this setting.

cron_expression STRING

Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted.

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

include_deleted STRING

If true, Stitch will replicate data for deleted campaigns, ads, and adsets. Note: This data will not be included alongside insights data.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Facebook Ads source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "attribution_window":"7",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "include_deleted":"true",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Facebook Ads source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Facebook Ads's documentation for more info on performing OAuth with Facebook Ads.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
access_token STRING

An access token generated by a Facebook OAuth handshake.

account_id STRING

The ID of the Facebook Ads account to use when extracting data.

Example Facebook Ads source connection property object with OAuth properties
{
  "access_token":"<ACCESS_TOKEN>",
  "account_id":"<FACEBOOK_ADS_ACCOUNT_ID>"
}

Back to connection property object search


SOURCE

The Freshdesk source connection property object

Property type: platform.freshdesk Connection type: Source
Documentation: Stitch docs

Freshdesk connections read data from the Freshdesk API and correspond to source type: platform.freshdesk.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_key STRING

The API key for the Freshdesk account Stitch should replicate data from. Refer to the Freshdesk documentation for instructions on retrieving this credential.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

domain STRING

The subdomain prefix of the Freshdesk account Stitch should replicate data from. For example: If the URL were stitch. }}.com, this value would be stitch.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Freshdesk source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "domain":"<SUBDOMAIN_PREFIX>",
  "frequency_in_minutes":"30",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Front source connection property object

Property type: platform.frontapp Connection type: Source
Documentation: Stitch docs

Front connections read data from the Front API and correspond to source type: platform.frontapp.

Note: To use this integration, the user must have a Premium or Enterprise Front plan. These plans include API access, which is required to use Stitch’s Front integration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

incremental_range STRING

Defines how data will be aggregated. Accepted values are daily or hourly.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

token STRING

The user’s Front API token. Refer to the Front setup guide for instructions on how to generate this token.

Example Front source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "incremental_range":"daily",
  "start_date":"2018-01-10T00:00:00Z",
  "token":"<API_TOKEN>"
}

Back to connection property object search


SOURCE

The FullStory source connection property object

Property type: platform.fullstory Connection type: Source
Documentation: Stitch docs

FullStory connections read data from the FullStory API and correspond to source type: platform.fullstory.

Note: To use this integration, the user must have a FullStory account with the FullStory Data Export Pack add-on. This is a paid addition that allows users to export raw event data, and is required to use FullStory’s Data Export REST API.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_key STRING

A FullStory API key, used to authenticate to FullStory’s Data Export API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example FullStory source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The GitHub source connection property object

Property type: platform.github Connection type: Source
Documentation: Stitch docs

GitHub connections read data from the GitHub API and correspond to source type: platform.github.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
access_token STRING

An access token which allows access to any project the user wants to replicate data from. Note: This access token must have the repo scope at a minimum. Refer to the GitHub documentation for more info.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

repository STRING

The path or paths of the repository or repositories to be tracked. A repository path is relative to https://github.com. For example: The path for the Stitch Docs repository is stitchdata/docs

To track multiple repositories, this value should be a space delimited list of the repository paths. For example:

stitchdata/docs stitchdata/docs-about-docs
start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example GitHub source connection property object with form properties
{
  "access_token":"<ACCESS_TOKEN>",
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "repository":"stitchdata/docs stitchdata/docs-about-docs",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The GitLab source connection property object

Property type: platform.gitlab Connection type: Source
Documentation: Stitch docs

GitLab connections read data from the GitLab API and correspond to source type: platform.gitlab.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_url STRING

The URL for the GitLab API. This value must be https://gitlab.com/api/v3.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

groups STRING

Note: While providing this property is optional, either projects or groups must be provided. You may also provide both properties.

A space separated list of groups you want to track. How data is replicated using this property depends on the value of the groups property:

  • If groups is provided but projects is not, all group projects will be replicated.
  • If groups and projects are provided, the selected projects of the provided groups will be replicated.
  • If projects is provided but groups is not, all selected projects will be replicated.
private_token STRING

A GitLab Personal Access token. Refer to the GitLab documentation for instructions on generating this credential.

projects STRING

Note: While providing this property is optional, either projects or groups must be provided. You may also provide both properties.

A space-separated list of projects you want to track.

For example: In an organization named stitch, there are two projects to track: stitch-data and stitch-docs. To track them, this value would be: stitch/stitch-data stitch/stitch-docs

A space separated list of groups you want to track. How data is replicated using this property depends on the value of the groups property:

  • If groups is provided but projects is not, all group projects will be replicated.
  • If groups and projects are provided, the selected projects of the provided groups will be replicated.
  • If projects is provided but groups is not, all selected projects will be replicated.
start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example GitLab source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_url":"https://gitlab.com/api/v3",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "groups":"your-org/group-a",
  "private_token":"<PRIVATE_TOKEN>",
  "projects":"your-org/project-a your-org/project-b",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Google Ads source connection property object

Property type: platform.adwords Connection type: Source
Documentation: Stitch docs

Google Ads connections read data from the Google Ads API and correspond to source type: platform.adwords.

Google Ads source connection property objects can contain two types of properties:

Google Ads source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (1440).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Google Ads source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"1440",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Google Ads source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Google Ads's documentation for more info on performing OAuth with Google Ads.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
customer_ids STRING

A comma-separated list of Google Ads account IDs to replicate data from.

developer_token STRING

Your Google Ads developer token, which identifies your app to the AdWords API. Refer to Google’s documentation for more info.

oauth_client_id STRING

Your Google Ads OAuth application’s client ID, obtained when you create an OAuth app with Google. Refer to Google’s documentation for more info.

oauth_client_secret STRING

Your Google Ads OAuth application’s client secret, obtained when you create an OAuth app with Google. Refer to Google’s documentation for more info.

refresh_token STRING

A long-lived token, used to generate new Google Ads access tokens when old ones expire.

user_id STRING

The ID of the Google user authorizing the connection.

Example Google Ads source connection property object with OAuth properties
{
  "customer_ids":"1234567890,0987654321",
  "developer_token":"<YOUR_DEVELOPER_TOKEN>",
  "oauth_client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "oauth_client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>",
  "user_id":"<USER_ID>"
}

Back to connection property object search


SOURCE

The Google Analytics 360 source connection property object

Property type: platform.ga360 Connection type: Source
Documentation: Stitch docs

Google Analytics 360 connections read data from the Google Analytics 360 API and correspond to source type: platform.ga360.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

dataset_id STRING

The ID of a dataset within your Google Analytics 360 project. Refer to the Google Analytics 360 documentation for instructions on obtaining this information

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

page_size STRING

This is an internal field for Stitch use.

project_id STRING

The ID of the project where your dataset lives. Refer to the Google Analytics 360 documentation for instructions on obtaining this information.

service_account_json STRING

Details and credentials for the Google Cloud Platform (GCP) IAM service account Stitch will use to replicate data.

This data is generated when a JSON project key file is created for the service account using the GCP Console. Refer to the Google Analytics 360 documentation for instructions on obtaining this credential.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Google Analytics 360 source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "dataset_id":"<YOUR_DATASET_ID>",
  "frequency_in_minutes":"60",
  "page_size":"<PAGE_SIZE>",
  "project_id":"<YOUR_PROJECT_ID>",
  "service_account_json":"{
     "type": "service_account",
     "project_id": "<YOUR_PROJECT_ID>",
     "private_key_id": "<PRIVATE_KEY_ID>",
     "private_key": "-----BEGIN PRIVATE KEY-----<PRIVATE_KEY>-----END PRIVATE KEY-----",
     "client_email": "<EMAIL>@<PROJECT_ID>.iam.gserviceaccount.com",
     "client_id": "<CLIENT_ID>",
     "auth_uri": "https://accounts.google.com/o/oauth2/auth",
     "token_uri": "https://accounts.google.com/o/oauth2/token",
     "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
     "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/<SERVICE_ACCOUNT_EMAIL>"
    }",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Google Analytics source connection property object

Property type: platform.google-analytics Connection type: Source
Documentation: Stitch docs

Google Analytics connections read data from the Google Analytics API and correspond to source type: platform.google-analytics.

Google Analytics source connection property objects can contain two types of properties:

Google Analytics source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

quota_user STRING

Note: This is a read-only property and will be returned when the Google Analytics object is successfully created. Including it in POST or PUT requests will result in InvalidProperties errors.

report_definitions ARRAY

An array of objects, each object pertaining to a custom report you want to create.

Note: Metrics and dimensions for each report can be selected when the source proceeds to the field_selection step.

Name Type Required Description
id STRING

A unique ID for the custom report.

name STRING

The name of the custom report. This will be used to create the name of the corresponding table in the destination.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Google Analytics source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "quota_user":"",
  "report_definitions":[
     {
        "name":"Visitor Traffic",
        "id":"visitor-traffic-report"
     },
     {
        "name":"Site A ECommerce",
        "id":"site-a-ecommerce-report"
     }
   ],
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Google Analytics source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Google Analytics's documentation for more info on performing OAuth with Google Analytics.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

Your Google Analytics OAuth application’s client ID, obtained when you create an OAuth app with Google. Refer to Google’s documentation for more info.

client_secret STRING

Your Google Analytics OAuth application’s client secret, obtained when you create an OAuth app with Google. Refer to Google’s documentation for more info.

refresh_token STRING

A long-lived token, used to generate new Google Analytics access tokens when old ones expire.

view_id STRING

The ID of the Google Analytics view (profile) to extract data from. You can use Google’s Account Explorer to search or browse through your accounts, properties, and views.

Example Google Analytics source connection property object with OAuth properties
{
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>",
  "view_id":"<A_VIEW_ID>"
}

Back to connection property object search


DESTINATION

The Google BigQuery destination connection property object

Property type: bigquery_v2 Connection type: Destination
Documentation: Stitch docs

Google BigQuery connections write data to a Google BigQuery and correspond to destination type: bigquery_v2.

To set up a Google BigQuery destination, users will need to:

  1. Create a Google Cloud Platform IAM service account
  2. Generate a JSON project key file

Refer to our Google BigQuery documentation for additional details.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
cloud_storage_location STRING

The Google Cloud Storage (GCS) region to be used during the replication process. This setting determines the region of the internal GCS storage bucket Stitch will use to load data into Google BigQuery.

Accepted values are:

  • US

  • EU

  • us-west2

  • northamerica-northeast1

  • us-east4

  • southamerica-east1

  • europe-north1

  • europe-west2

  • europe-west3

  • europe-west6

  • asia-east2

  • asia-south1

  • asia-northeast2

  • asia-east1

  • asia-northeast1

  • asia-southeast1

  • australia-southeast1

loading_mode STRING

Determines how Stitch handles changes to existing records when loading data into Google BigQuery. Note: This value cannot be modified after the destination is created.

Accepted values are:

  • UPSERT: Existing rows for which a Primary Key exists will be updated with the most recent version of the record from the source. With this option, only the most recent version of a record will exist in Google BigQuery.

  • APPEND_ONLY: Existing rows aren’t updated. Newer versions of existing records are added as new rows to the end of tables. With this option, many versions of the record will exist in Google BigQuery, capturing how a record changed over time.

Refer to the Understanding loading behavior guide for more info and examples.

project_id STRING

Note: This is a read-only property and will be returned when the Google BigQuery object is successfully created. Including it in POST or PUT requests will result in InvalidProperties errors.

The ID of the project associated with the service account.

service_account_credentials OBJECT

Details and credentials for the Google Cloud Platform (GCP) IAM service account Stitch will use to load data into Google BigQuery from Google Cloud Storage (GCS).

This data is generated when a JSON project key file is created for the service account using the GCP Console. Refer to setup guide for Google BigQuery destinations for more info and instructions.

Name Type Required Description
type STRING

This will be service_account.

project_id STRING

The ID of the project associated with the service account.

private_key_id STRING

The ID of the private key.

private_key STRING

The private key for the service account.

client_email STRING

The service account email address.

client_id STRING

The client ID.

auth_uri STRING

The auth URL for the service account.

token_uri STRING

The token URL for the service account.

auth_provider_x509_cert_url STRING

The auth provider x509 cert URL for the service account.

client_x509_cert_url STRING

The client x509 cert URL for the service account.

Example Google BigQuery destination connection property object with form properties
{
  "cloud_storage_location":"US",
  "loading_mode":"UPSERT",
  "project_id":"<READ_ONLY_PROJECT_ID>",
  "service_account_credentials":{
     "type": "service_account",
     "project_id": "<YOUR_PROJECT_ID>",
     "private_key_id": "<PRIVATE_KEY_ID>",
     "private_key": "-----BEGIN PRIVATE KEY-----<PRIVATE_KEY>-----END PRIVATE KEY-----",
     "client_email": "<EMAIL>@<PROJECT_ID>.iam.gserviceaccount.com",
     "client_id": "<CLIENT_ID>",
     "auth_uri": "https://accounts.google.com/o/oauth2/auth",
     "token_uri": "https://accounts.google.com/o/oauth2/token",
     "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
     "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/<SERVICE_ACCOUNT_EMAIL>"
    }
}

Back to connection property object search


SOURCE

The Google CloudSQL MySQL source connection property object

Property type: platform.cloudsql Connection type: Source
Documentation: Stitch docs

Google CloudSQL MySQL connections read data from Google CloudSQL MySQL databases and correspond to source type: platform.cloudsql.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
allow_non_auto_increment_pks STRING

If true, an auto-incrementing Primary Key will not be required for tables using Full Table Replication. Auto-incrementing Primary Keys are used during full table replication to allow the replication of a table to span multiple replication jobs.

Unless set, this property will default to true.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

filter_dbs STRING

This is an internal field and is for Stitch use only.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 1

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

host STRING

The IP address or hostname of the database server.

password STRING

The password for the user connecting to the database server. Note: This property will never be returned by the API, but it can be submitted when creating or modifying a connection.

port INTEGER

The port of the database server. The default is 3306.

server_id STRING

Defines the unique ID of the server that Stitch will connect to, if using Log-based (binlog) Replication.

Server IDs must be unique, as MySQL doesn’t allow replication to simultaneously occur across multiple connections using the same server ID. For more info about this setting in Stitch, refer to the MySQL documentation.

use_log_based_replication STRING

If true, Log-based Incremental Replication will be used as the default Replication Method for tables set to replicate. This choice can be overriden on individual tables at any time.

user STRING

The username of the database user.

database STRING

The name of the logical database to connect to.

Example Google CloudSQL MySQL source connection property object with form properties
{
  "allow_non_auto_increment_pks":"true",
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "filter_dbs":"",
  "frequency_in_minutes":"30",
  "host":"<HOST_ADDRESS>",
  "password":"<PASSWORD>",
  "port":"3306",
  "server_id":"<UNIQUE_SERVER_ID>",
  "use_log_based_replication":"true",
  "user":"<USERNAME>",
  "database
":"<DATABASE_NAME>"
}

Back to connection property object search


SOURCE

The Google CloudSQL PostgreSQL (HP) source connection property object

Property type: platform.hp-cloudsql-pg Connection type: Source
Documentation: Stitch docs

Google CloudSQL PostgreSQL (HP) connections read data from Google CloudSQL PostgreSQL databases and correspond to source type: platform.hp-cloudsql-pg.

Note: This version of the Google CloudSQL PostgreSQL source differs from the version used by the platform.cloudsql_pg form property. Refer to the Google CloudSQL PostgreSQL (HP) integration feature summary for more info.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

dbname STRING

The name of the logical database to connect to.

debug_lsn STRING

This is an internal field and is for Stitch use only.

filter_dbs STRING

This is an internal field and is for Stitch use only.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 1

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

host STRING

The IP address or hostname of the database server.

include_schemas_in_destination_stream_name STRING

If true, the name of the source schema will be included in the destination table name. For example: <source_schema_name>__<table_name>. This can help prevent table name collisions when two tables canonicalize to the same name.

For more info, refer to the Database Integration Table Name Collisions guide.

itersize STRING

This is an internal field and is for Stitch use only.

logical_poll_total_seconds STRING

The total amount of time, in seconds, that the integration should be allowed to poll for records while performing Log-based Incremental Replication.

password STRING

The password for the user connecting to the database server. Note: This property will never be returned by the API, but it can be submitted when creating or modifying a connection.

port INTEGER

The port of the database server. The default is 5432.

ssl STRING

If true, SSL will be used to connect to the database.

use_log_based_replication STRING

If true, Log-based Incremental Replication will be used as the default Replication Method for tables set to replicate. This choice can be overriden on individual tables at any time.

user STRING

The username of the database user.

Example Google CloudSQL PostgreSQL (HP) source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "dbname":"<DATABASE_NAME>",
  "debug_lsn":"",
  "filter_dbs":"",
  "frequency_in_minutes":"60",
  "host":"<HOST_ADDRESS>",
  "include_schemas_in_destination_stream_name":"false",
  "itersize":"",
  "logical_poll_total_seconds":"1800",
  "password":"<PASSWORD>",
  "port":"5432",
  "ssl":"false",
  "use_log_based_replication":"true",
  "user":"<USERNAME>"
}

Back to connection property object search


SOURCE

The Google CloudSQL PostgreSQL source connection property object

Property type: platform.cloudsql_pg Connection type: Source
Documentation: Stitch docs

Google CloudSQL PostgreSQL connections read data from Google CloudSQL PostgreSQL databases and correspond to source type: platform.cloudsql_pg.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

dbname STRING

The name of the logical database to connect to.

debug_lsn STRING

This is an internal field and is for Stitch use only.

filter_dbs STRING

This is an internal field and is for Stitch use only.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 1

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

host STRING

The IP address or hostname of the database server.

include_schemas_in_destination_stream_name STRING

If true, the name of the source schema will be included in the destination table name. For example: <source_schema_name>__<table_name>. This can help prevent table name collisions when two tables canonicalize to the same name.

For more info, refer to the Database Integration Table Name Collisions guide.

itersize STRING

This is an internal field and is for Stitch use only.

logical_poll_total_seconds STRING

The total amount of time, in seconds, that the integration should be allowed to poll for records while performing Log-based Incremental Replication.

password STRING

The password for the user connecting to the database server. Note: This property will never be returned by the API, but it can be submitted when creating or modifying a connection.

port INTEGER

The port of the database server. The default is 5432.

ssl STRING

If true, SSL will be used to connect to the database.

use_log_based_replication STRING

If true, Log-based Incremental Replication will be used as the default Replication Method for tables set to replicate. This choice can be overriden on individual tables at any time.

user STRING

The username of the database user.

Example Google CloudSQL PostgreSQL source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "dbname":"<DATABASE_NAME>",
  "debug_lsn":"",
  "filter_dbs":"",
  "frequency_in_minutes":"60",
  "host":"<HOST_ADDRESS>",
  "include_schemas_in_destination_stream_name":"false",
  "itersize":"",
  "logical_poll_total_seconds":"1800",
  "password":"<PASSWORD>",
  "port":"5432",
  "ssl":"false",
  "use_log_based_replication":"true",
  "user":"<USERNAME>"
}

Back to connection property object search


SOURCE

The Google Search Console source connection property object

Property type: platform.google-search-console Connection type: Source
Documentation: Stitch docs

Google Search Console connections read data from the Google Search Console API and correspond to source type: platform.google-search-console.

Google Search Console source connection property objects can contain two types of properties:

Google Search Console source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

site_urls STRING

The domains and websites that belong to your organization. The URLs should be comma delimited and begin with https:// or http://. Refer to the Google Search Console documentation for instructions on how to set these URLs up in your Google Search Console account.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Google Search Console source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "site_urls":"https://yoursite.com, http://yourothersite.com",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Google Search Console source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Google Search Console's documentation for more info on performing OAuth with Google Search Console.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

Your Google Search Console OAuth application’s client ID, obtained when you create an OAuth app with Google. Refer to Google’s documentation for more info.

client_secret STRING

Your Google Search Console OAuth application’s client secret, obtained when you create an OAuth app with Google. Refer to Google’s documentation for more info.

refresh_token STRING

A long-lived token, used to generate new Google Search Console access tokens when old ones expire.

Example Google Search Console source connection property object with OAuth properties
{
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Google Sheets source connection property object

Property type: platform.google-sheets Connection type: Source
Documentation: Stitch docs

Google Sheets connections read data from the Google Sheets API and correspond to source type: platform.google-sheets.

Google Sheets source connection property objects can contain two types of properties:

Google Sheets source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

spreadsheet_id STRING

The unique identifier of your spreadsheet. It’s also a good idea to link back to the setup docs for this, since locating the spreadsheet ID isn’t totally straightforward. Refer to the Google Sheets documentation for instructions on locating this info.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Google Sheets source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "spreadsheet_id":"<YOUR_SPREADSHEET_ID>",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Google Sheets source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Google Sheets's documentation for more info on performing OAuth with Google Sheets.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

Your Google Sheets OAuth application’s client ID, obtained when you create an OAuth app with Google. Refer to Google’s documentation for more info.

client_secret STRING

Your Google Sheets OAuth application’s client secret, obtained when you create an OAuth app with Google. Refer to Google’s documentation for more info.

refresh_token STRING

A long-lived token, used to generate new Google Sheets access tokens when old ones expire.

Example Google Sheets source connection property object with OAuth properties
{
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Harvest Forecast source connection property object

Property type: platform.harvest-forecast Connection type: Source
Documentation: Stitch docs

Harvest Forecast connections read data from the Harvest Forecast API and correspond to source type: platform.harvest-forecast.

Harvest Forecast source connection property objects can contain two types of properties:

Harvest Forecast source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted.

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (3600).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Harvest Forecast source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"3600",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Harvest Forecast source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Harvest Forecast's documentation for more info on performing OAuth with Harvest Forecast.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

Your Harvest Forecast OAuth application client ID.

client_secret STRING

Your Harvest Forecast OAuth application client secret.

refresh_token STRING

If exchanging a code with Harvest Forecast, a long-lived token that can be used to retrieve new access_tokens when old ones expire.

Example Harvest Forecast source connection property object with OAuth properties
{
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Harvest source connection property object

Property type: platform.harvest Connection type: Source
Documentation: Stitch docs

Harvest connections read data from the Harvest API and correspond to source type: platform.harvest.

Harvest source connection property objects can contain two types of properties:

Harvest source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
account_name STRING

Your Harvest account name. For example: if your Harvest account URL is stitch.harvestapp.com, this value would be stitch.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted.

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Harvest source connection property object with form properties
{
  "account_name":"<ACCOUNT_NAME>",
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Harvest source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Harvest's documentation for more info on performing OAuth with Harvest.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

Your Harvest OAuth application client ID.

client_secret STRING

Your Harvest OAuth application client secret.

refresh_token STRING

If exchanging a code with Harvest, a long-lived token that can be used to retrieve new access_tokens when old ones expire.

Example Harvest source connection property object with OAuth properties
{
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Heap source connection property object

Property type: platform.heap Connection type: Source
Documentation: Stitch docs

Heap connections read data from data dumps in Amazon S3 buckets and correspond to source type: platform.heap.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
account_id STRING

Your Amazon Web Services account ID. Refer to the Heap documentation for instructions on retrieving this info.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

bucket STRING

The name of the bucket Stitch should replicate Heap data from. Heap requires that bucket names be prefixed with heap-rs3-.

cron_expression STRING

Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted.

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

external_id STRING

The external ID associated with the Amazon Web Services (AWS) Identity Access Management (IAM) role used by Stitch. In AWS, external IDs are used to increase role security when granting access to accounts that you don’t own or have administrative access to. Stitch will provide this ID when accessing Heap.

This value can be anything, but it must be the same as the external ID provided in the AWS console when creating the Stitch IAM role. Refer to the Heap documentation for more info.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

role_name STRING

The name of the AWS IAM role Stitch should assume when extracting data from Amazon S3. This role will have the permissions in the IAM policy associated with the role.

This value can be anything, but it must be the same as the role name provided in the AWS console when creating the Stitch IAM role.

Refer to the Heap documentation for more info.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Heap source connection property object with form properties
{
  "account_id":"123456789123",
  "anchor_time":"2018-04-30T17:00:00Z",
  "bucket":"heap-rs3-<BUCKET_NAME>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "external_id":"stitch_connection_12345",
  "frequency_in_minutes":"60",
  "role_name":"stitch_heap_CNTl5Br9",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Help Scout source connection property object

Property type: platform.helpscout Connection type: Source
Documentation: Stitch docs

Help Scout connections read data from the Help Scout API and correspond to source type: platform.helpscout.

Help Scout source connection property objects can contain two types of properties:

Help Scout source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted.

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (3600).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Help Scout source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"3600",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Help Scout source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Help Scout's documentation for more info on performing OAuth with Help Scout.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

Your Help Scout OAuth application client ID.

client_secret STRING

Your Help Scout OAuth application client secret.

refresh_token STRING

A long-lived token that can be used to retrieve new access_tokens when old ones expire.

Example Help Scout source connection property object with OAuth properties
{
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Heroku source connection property object

Property type: platform.heroku_pg Connection type: Source
Documentation: Stitch docs

Heroku connections read data from Heroku databases and correspond to source type: platform.heroku_pg.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

dbname STRING

The name of the logical database to connect to.

filter_dbs STRING

This is an internal field and is for Stitch use only.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 1

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

host STRING

The IP address or hostname of the database server.

include_schemas_in_destination_stream_name STRING

If true, the name of the source schema will be included in the destination table name. For example: <source_schema_name>__<table_name>. This can help prevent table name collisions when two tables canonicalize to the same name.

For more info, refer to the Database Integration Table Name Collisions guide.

itersize STRING

This is an internal field and is for Stitch use only.

password STRING

The password for the user connecting to the database server. Note: This property will never be returned by the API, but it can be submitted when creating or modifying a connection.

port INTEGER

The port of the database server. The default is 5432.

ssl STRING

If true, SSL will be used to connect to the database.

user STRING

The username of the database user.

Example Heroku source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "dbname":"<DATABASE_NAME>",
  "filter_dbs":"",
  "frequency_in_minutes":"60",
  "host":"<HOST_ADDRESS>",
  "include_schemas_in_destination_stream_name":"false",
  "itersize":"",
  "password":"<PASSWORD>",
  "port":"5432",
  "ssl":"false",
  "user":"<USERNAME>"
}

Back to connection property object search


SOURCE

The HubSpot source connection property object

Property type: platform.hubspot Connection type: Source
Documentation: Stitch docs

HubSpot connections read data from the HubSpot API and correspond to source type: platform.hubspot.

HubSpot source connection property objects can contain two types of properties:

HubSpot source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example HubSpot source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

HubSpot source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to HubSpot's documentation for more info on performing OAuth with HubSpot.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
client_id STRING

Your HubSpot OAuth application client ID.

client_secret STRING

Your HubSpot OAuth application client secret.

redirect_uri STRING

The URL that the user will be redirected to after they authorize your app for the requested scopes.

refresh_token STRING

If exchanging a code with HubSpot, a long-lived token that can be used to retrieve new access_tokens when old ones expire.

Example HubSpot source connection property object with OAuth properties
{
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "redirect_uri":"https://www.yourcompany.com/auth-callback",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The iLEVEL source connection property object

Property type: platform.ilevel Connection type: Source
Documentation: Stitch docs

iLEVEL connections read data from the iLEVEL API and correspond to source type: platform.ilevel.

Connecting a iLEVEL data source requires iLEVEL Web Services access. Contact iLEVEL support to request this feature.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

is_sandbox STRING

If true, the iLEVEL instance you’re connecting is a sandbox.

password STRING

The iLEVEL API user’s password.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

username STRING

An iLEVEL API user’s username.

Example iLEVEL source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "is_sandbox":"false",
  "password":"<PASSWORD>",
  "start_date":"2018-01-10T00:00:00Z",
  "username":"<ILEVEL_USERNAME>"
}

Back to connection property object search


SOURCE

The Impact source connection property object

Property type: platform.impact Connection type: Source
Documentation: Stitch docs

Impact connections read data from the Impact API and correspond to source type: platform.impact.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
account_sid STRING

The read-only version of your Impact Account SID. Refer to the Impact documentation for instructions on locating this info.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_catalog STRING

The internal Impact API you’re using for the Stitch Impact integration. Currently the only supported option is advertisers.

auth_token STRING

The read-only version of your Impact Auth Token. Refer to the Impact documentation for instructions on locating this info.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

model_id STRING/INTEGER

Identifies the conversion process and the necessary steps from click to conversion. It is an optional parameter for the conversion_paths endpoint, which shows conversions from clicks to conversion purchases. The only way to access this ID, you need to contact Impact Radius Support or open an Impact help desk request with Impact.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Impact source connection property object with form properties
{
  "account_sid":"<YOUR_API_ACCOUNT_SID>",
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_catalog":"advertisers",
  "auth_token":"<YOUR_API_AUTH_TOKEN>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "model_id":"<YOUR_MODEL_ID>",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Import API source connection property object

Property type: import_api Connection type: Source
Documentation: Stitch docs

Import API connections receive data you push to the Import API and correspond to source type: import_api.

To create an Import API source, the only required property is type, which must have a value of import_api.

Note: While Import API source form properties don’t technically have any form properties, some setup is still required to fully configure this source. Refer to the Create and Configure an Import API Source with the Connect API guide for help setting up this source.

Example Import API source connection property object with form properties
"type":"import_api"

Back to connection property object search


SOURCE

The Intacct source connection property object

Property type: platform.intacct Connection type: Source
Documentation: Stitch docs

Intacct connections read data from reports exported to Amazon S3 via Intacct's Data Delivery Service feature and correspond to source type: platform.intacct.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
account_id STRING

Your Amazon Web Services account ID. Refer to the Intacct documentation for instructions on retrieving this info.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

bucket STRING

The name of the bucket Stitch should replicate Intacct data from. This value should only include the bucket name: No URLs, https, or S3 parts.

company_id STRING

Your Intacct company ID, used to sign into Intacct.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

external_id STRING

The external ID associated with the Amazon Web Services (AWS) Identity Access Management (IAM) role used by Stitch. In AWS, external IDs are used to increase role security when granting access to accounts that you don’t own or have administrative access to. Stitch will provide this ID when accessing Intacct.

This value can be anything, but it must be the same as the external ID provided in the AWS console when creating the Stitch IAM role. Refer to the Intacct documentation for more info.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

path STRING

Optional: The path configured in Intacct for use in the S3 bucket.

role_name STRING

The name of the AWS IAM role Stitch should assume when extracting data from Amazon S3. This role will have the permissions in the IAM policy associated with the role.

This value can be anything, but it must be the same as the role name provided in the AWS console when creating the Stitch IAM role.

Refer to the Intacct documentation for more info.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Intacct source connection property object with form properties
{
  "account_id":"123456789123",
  "anchor_time":"2018-04-30T17:00:00Z",
  "bucket":"intacct-stitch-bucket",
  "company_id":"<COMPANY_ID>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "external_id":"stitch_connection_12345",
  "frequency_in_minutes":"60",
  "path":"/optional/bucket/path",
  "role_name":"stitch_intacct_CNTl5Br9",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Invoiced source connection property object

Property type: platform.invoiced Connection type: Source
Documentation: Stitch docs

Invoiced connections read data from the Invoiced API and correspond to source type: platform.invoiced.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_key STRING

Your Invoiced API key. Refer to the Invoiced documentation for instructions on generating this credential.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

sandbox STRING

If true, the Invoiced instance is a sandbox.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Invoiced source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<INVOICED_API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "sandbox":"false",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Jira source connection property object

Property type: platform.jira Connection type: Source
Documentation: Stitch docs

Jira connections read data from the Jira API and correspond to source type: platform.jira.

Stitch’s Jira source can connect to self-managed (hosted) or cloud-hosted instances. Note: The steps for connecting each type of instance vary. Refer to our Jira documentation for more info.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

base_url STRING

The base URL for the user’s Jira instance.

Note: If connecting a self-managed (hosted) instance, the server must use the HTTPs protocl or the connection will fail.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

password STRING

Depending on the type of Jira instance being connected, this value should be one of the following:

  • For a self-managed instance, this will be the password associated with the username.
  • For a cloud-hosted instance, this will be an API token generated by the user (username). Refer to our JIRA documentation for instructions on generating the token.
start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

username STRING

The user’s Jira username. This will typically be the email address the user uses to sign into Jira.

Example Jira source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "base_url":"<NAME>.atlassian.net",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "password":"<PASSWORD_OR_API_TOKEN>",
  "start_date":"2018-01-10T00:00:00Z",
  "username":"<NAME>@<DOMAIN>.com"
}

Back to connection property object search


SOURCE

The Klaviyo source connection property object

Property type: platform.klaviyo Connection type: Source
Documentation: Stitch docs

Klaviyo connections read data from and correspond to source type: platform.klaviyo.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_key STRING

Your Klaviyo API Key. Refer to the Klaviyo documentation for info on retrieving this credential.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Klaviyo source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<API-KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Kustomer source connection property object

Property type: platform.kustomer Connection type: Source
Documentation: Stitch docs

Kustomer connections read data from the Kustomer API and correspond to source type: platform.kustomer.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_token STRING

Your API key. Refer to the Kustomer documentation for instructions on obtaining this.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

date_window_size STRING

This is an internal field for Stitch use.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

page_size_limit STRING

This is an internal field for Stitch use.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Kustomer source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_token":"<YOUR_KUSTOMER_API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "date_window_size":"<DATE_WINDOW_SIZE>",
  "frequency_in_minutes":"60",
  "page_size_limit":"<PAGE_SIZE_LIMIT>",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Lever source connection property object

Property type: platform.lever Connection type: Source
Documentation: Stitch docs

Lever connections read data from the Lever API and correspond to source type: platform.lever.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

token STRING

Your Lever API key. Refer to the Lever documentation for instructions on obtaining this.

Example Lever source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z",
  "token":"<YOUR_API_TOKEN>"
}

Back to connection property object search


SOURCE

The Listrak source connection property object

Property type: platform.listrak Connection type: Source
Documentation: Stitch docs

Listrak connections read data from the Listrak API and correspond to source type: platform.listrak.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted.

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

password STRING

The password associated with the Listrak user.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

username STRING

Your Listrak username.

Example Listrak source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "password":"",
  "start_date":"2018-01-10T00:00:00Z",
  "username":""
}

Back to connection property object search


SOURCE

The LivePerson source connection property object

Property type: platform.liveperson Connection type: Source
Documentation: Stitch docs

LivePerson connections read data from the [LivePerson Data Access API](https://developers.liveperson.com/data-access-api-overview.html){:target="new"} and correspond to source type: platform.liveperson.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
access_token STRING

Your LivePerson API access token. Refer to the LivePerson documentation for instructions on creating this credential.

access_token_secret STRING

Your LivePerson API access token secret. Refer to the LivePerson documentation for instructions on creating this credential.

account_id STRING

Your LivePerson account ID.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

app_key STRING

Your LivePerson API app key. Refer to the LivePerson documentation for instructions on creating this credential.

app_secret STRING

Your LivePerson API app secret. Refer to the LivePerson documentation for instructions on creating this credential.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example LivePerson source connection property object with form properties
{
  "access_token":"<LIVEPERSON_ACCESS_TOKEN>",
  "access_token_secret":"<LIVEPERSON_ACCESS_TOKEN_SECRET>",
  "account_id":"<LIVEPERSON_ACCOUNT_ID>",
  "anchor_time":"2018-04-30T17:00:00Z",
  "app_key":"<LIVEPERSON_APP_KEY>",
  "app_secret":"<LIVEPERSON_APP_SECRET>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Looker source connection property object

Property type: platform.looker Connection type: Source
Documentation: Stitch docs

Looker connections read data from the Looker API and correspond to source type: platform.looker.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_port STRING

The Looker API Port number. This value will be 19999, unless you host Looker internally.

api_version STRING

The Looker API version. This value will be 3.1.

client_id STRING

The client ID portion of your Looker API3 Key. Refer to the Looker documentation for instructions on obtaining this information.

client_secret STRING

The client secret portion of your Looker API3 Key. Refer to the Looker documentation for instructions on obtaining this information.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

domain STRING

The domain of your Looker URL. This value is typically looker.com, unless you have your own white-listed domain.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

subdomain STRING

The subdomain of your Looker URL. This is the leading part of your Looker URL.

For example: If the URL is https://stitch.looker.com, the value for this property would be stitch.

Example Looker source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_port":"19999",
  "api_version":"3.1",
  "client_id":"<YOUR_LOOKER_CLIENT_ID>",
  "client_secret":"<YOUR_LOOKER_CLIENT_SECRET>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "domain":"looker.com",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z",
  "subdomain":"<YOUR_LOOKER_SUBDOMAIN>"
}

Back to connection property object search


SOURCE

The LookML source connection property object

Property type: platform.lookml Connection type: Source
Documentation: Stitch docs

LookML connections read data from GitHub repositories containing Looker LookML code and correspond to source type: platform.lookml.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_token STRING

A GitHub access token which allows access to any repository the user wants to replicate data from.

Note: This access token must have the repo scope at a minimum. Refer to the LookML documentation for more info.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

git_owner STRING

The name of owner of the GitHub repository to replicate LookML data from. You can find the owner in the URL of the repositories you want to replicate. For example: If the URL of the repository is https://github.com/stichdata/docs, the repository owner would be stitchdata.

git_repositories STRING

A comma-delimited list of the GitHub repositories to replicate LookML data from. The name of the repository is in its URL. For example: If the URL of the repository is https://github.com/stichdata/docs, the repository would be docs.

  • To track a single repository, this value should be just the name of the repository: repository-1
  • To track multiple repositories, this value should be comma-delimited: repository-1, repository-2, etc.
start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example LookML source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_token":"<API_TOKEN>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "git_owner":"<GIT_REPOSITORY_OWNER>",
  "git_repositories":"<GIT_REPOSITORY_NAME>",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The MailChimp source connection property object

Property type: platform.mailchimp Connection type: Source
Documentation: Stitch docs

MailChimp connections read data from the MailChimp API and correspond to source type: platform.mailchimp.

MailChimp source connection property objects can contain two types of properties:

MailChimp source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

page_size STRING

An optional parameter used to reduce the amount of data requested in a single API request. Refer to the MailChimp repository for more info.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example MailChimp source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "page_size":"250",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

MailChimp source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to MailChimp's documentation for more info on performing OAuth with MailChimp.

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
access_token STRING

The MailChimp token to use in future requests to the MailChimp API, created after a successful OAuth handshake.

client_id STRING

Your MailChimp OAuth application’s client ID.

client_secret STRING

Your MailChimp OAuth application’s client secret.

Example MailChimp source connection property object with OAuth properties
{
  "access_token":"<ACCESS_TOKEN>",
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>"
}

Back to connection property object search


SOURCE

The Mailshake source connection property object

Property type: platform.mailshake Connection type: Source
Documentation: Stitch docs

Mailshake connections read data from the Mailshake API and correspond to source type: platform.mailshake.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

api_key STRING

Your Mailshake API key. Refer to the Mailshake documentation for instructions on retrieving this credential.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Mailshake source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<YOUR_MAILSHAKE_API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Mambu source connection property object

Property type: platform.mambu Connection type: Source
Documentation: Stitch docs

Mambu connections read data from the Mambu API and correspond to source type: platform.mambu.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

password STRING

The password for the Mambu user account.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

subdomain STRING

The subdomain of the Mambu account.

username STRING

The Mambu username used for login.

Example Mambu source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "password":"<PASSWORD>",
  "start_date":"2018-01-10T00:00:00Z",
  "subdomain":"stitch.mambu.com",
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The MariaDB source connection property object

Property type: platform.mariadb Connection type: Source
Documentation: Stitch docs

MariaDB connections read data from MariaDB databases and correspond to source type: platform.mariadb.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
allow_non_auto_increment_pks STRING

If true, an auto-incrementing Primary Key will not be required for tables using Full Table Replication. Auto-incrementing Primary Keys are used during full table replication to allow the replication of a table to span multiple replication jobs.

Unless set, this property will default to true.

anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (30).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

filter_dbs STRING

This is an internal field and is for Stitch use only.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 1

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

host STRING

The IP address or hostname of the database server.

password STRING

The password for the user connecting to the database server. Note: This property will never be returned by the API, but it can be submitted when creating or modifying a connection.

port INTEGER

The port of the database server. The default is 3306.

server_id STRING

Defines the unique ID of the server that Stitch will connect to, if using Log-based (binlog) Replication.

Server IDs must be unique, as MySQL doesn’t allow replication to simultaneously occur across multiple connections using the same server ID. For more info about this setting in Stitch, refer to the MySQL documentation.

ssh STRING

If true, an SSH tunnel will be used to connect to the database.

ssh_host STRING

The IP address or hostname of the SSH server. This property is only required if ssh: true.

ssh_port STRING

The port of the SSH server. This property is only required if ssh: true.

ssh_user STRING

The username of the SSH user. This property is only required if ssh: true.

ssl STRING

If true, SSL will be used to connect to the database.

use_log_based_replication STRING

If true, Log-based Incremental Replication will be used as the default Replication Method for tables set to replicate. This choice can be overriden on individual tables at any time.

user STRING

The username of the database user.

database STRING

The name of the logical database to connect to.

Example MariaDB source connection property object with form properties
{
  "allow_non_auto_increment_pks":"true",
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "filter_dbs":"",
  "frequency_in_minutes":"30",
  "host":"<HOST_ADDRESS>",
  "password":"<PASSWORD>",
  "port":"3306",
  "server_id":"<UNIQUE_SERVER_ID>",
  "ssh":"true",
  "ssh_host":"<SSH_HOST>",
  "ssh_port":"22",
  "ssh_user":"<SSH_USERNAME>",
  "ssl":"false",
  "use_log_based_replication":"true",
  "user":"<USERNAME>",
  "database
":"<DATABASE_NAME>"
}

Back to connection property object search


SOURCE

The Marketo Bulk source connection property object

Property type: platform.marketobulk Connection type: Source
Documentation: Stitch docs

Marketo Bulk connections read data from the Marketo Bulk API and correspond to source type: platform.marketobulk.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

client_id STRING

The user’s Marketo client ID.

client_secret STRING

The user’s Marketo client secret.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (720).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

endpoint STRING

The user’s Marketo REST endpoint URL. For example: https://457-RFG-234.mktorest.com/rest

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Marketo Bulk source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "client_id":"<MARKETO_CLIENT_ID>",
  "client_secret":"<MARKETO_CLIENT_SECRET>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "endpoint":"https://<some-id-here>.mktorest.com/rest",
  "frequency_in_minutes":"720",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Marketo source connection property object

Property type: platform.marketo Connection type: Source
Documentation: Stitch docs

Marketo connections read data from the Marketo API and correspond to source type: platform.marketo.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

client_id STRING

The user’s Marketo client ID.

client_secret STRING

The user’s Marketo client secret.

cron_expression STRING

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (720).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

endpoint STRING

The user’s Marketo REST endpoint URL. For example: https://457-RFG-234.mktorest.com/rest

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

identity STRING

The user’s Marketo REST identity URL. For example: https://457-RFG-234.mktorest.com/identity

max_daily_calls STRING

The maximum number of daily API calls that Stitch may make to the Marketo API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Marketo source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "client_id":"<MARKETO_CLIENT_ID>",
  "client_secret":"<MARKETO_CLIENT_SECRET>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "endpoint":"https://<some-id-here>.mktorest.com/rest",
  "frequency_in_minutes":"720",
  "identity":"https://<some-id-here>.mktorest.com/identity",
  "max_daily_calls":"",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Microsoft Advertising (Bing Ads) source connection property object

Property type: platform.bing-ads Connection type: Source
Documentation: Stitch docs

Microsoft Advertising (Bing Ads) connections read data from the Microsoft Advertising (Bing Ads) API and correspond to source type: platform.bing-ads.

Microsoft Advertising (Bing Ads) source connection property objects can contain two types of properties:

Microsoft Advertising (Bing Ads) source form properties

Form properties are used to complete the form step in source configuration.

Note: Attributes marked as (required) must be provided to complete the form step for the connection.

Name Type Required Description
anchor_time STRING

Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling.

This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained.

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

cron_expression STRING

Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted.

A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info.

Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (1440).

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

frequency_in_minutes STRING

Defines how often, in minutes, Stitch should attempt to replicate data from . Accepted values are:

  • 30
  • 60
  • 360
  • 720
  • 1440

Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API.

start_date STRING

The date from which Stitch should begin replicating data from . Data from this date forward will be replicated.

This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z

Example Microsoft Advertising (Bing Ads) source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"1440",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Microsoft Advertising (Bing Ads) source OAuth properties

OAuth properties are used to complete the oauth step in source configuration.

A source's OAuth properties are required only if you’re performing OAuth for this source yourself. After you perform the OAuth handshake, use the PUT /v4/sources/{source_id} endpoint to update the source with the OAuth properties listed below.

Refer to Microsoft Advertising (Bing Ads)'s documentation for more info on performing OAuth with Microsoft Advertising (Bing Ads).

Note: Attributes marked as (required) must be provided to complete the oauth step for the connection.

Name Type Required Description
account_ids STRING

The ID of the account that owns the entities in API requests. Refer to Microsoft’s documentation for more info about this identifer.

customer_id STRING

The ID of the customer that contains and owns the Microsoft Advertising (Bing Ads) account being accessed. Refer to Microsoft’s documentation for more info about this identifer.

developer_token STRING

Your Microsoft Advertising (Bing Ads) developer token, used to access the Microsoft Advertising (Bing Ads) API. Refer to Microsoft’s documentation for instructions on obtaining this credential.

oauth_client_id STRING

The application (client) ID that the Azure portal - App registrations portal assigned your OAuth application. Refer to Microsoft’s documentation for more info.

oauth_client_secret STRING

Your Microsoft Advertising (Bing Ads) OAuth application’s client secret.

refresh_token STRING

A long-lived token that can be used to retrieve new Microsoft Advertising (Bing Ads) access_tokens when old ones expire.

user_id STRING

The ID of the user authorizing the connection.

Example Microsoft Advertising (Bing Ads) source connection property object with OAuth properties