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 source PUT /v4/sources/{source_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
ActiveCampaign (v1) Source platform.activecampaign
AdRoll (v1) Source platform.adroll
AfterShip (v1) Source Unsupported
Amazon Aurora MySQL (v1) Destination mysql_destination
Amazon Aurora MySQL RDS (v2) 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 Oracle RDS (v1) Source platform.oracle
Amazon PostgreSQL RDS (v1) Destination postgres
Amazon PostgreSQL RDS (v2) Source platform.postgres
Amazon RDS for MySQL (v1) Destination mysql_destination
Amazon RDS for SQL Server (v1) Destination mssql_server
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
Azure SQL Database (v1) Destination mssql_server
Azure SQL Managed Instance (v1) Destination mssql_server
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
CircleCI (v1) Source platform.circle-ci
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
Crossbeam (v1) Source platform.crossbeam
Customer.io (v1) Source Unsupported
Darksky (v1) Source platform.darksky
data.world (v1) Destination dataworld
Databricks Delta Lake (AWS) (v1) Destination databricks_delta
Delighted (v1) Source Unsupported
Deputy (v1) Source platform.deputy
Desk (v15-10-2015) Source Unsupported
Dixa (v1) Source platform.dixa
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 (v2) Source platform.frontapp
FullStory (v1) Source platform.fullstory
GitHub (v2) Source platform.github
GitLab (v1) Source platform.gitlab
Google Ads (v1) Source platform.google-ads
Google Ads (AdWords) (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 Analytics 4 (v1) Source platform.ga4
Google BigQuery (v2) Destination bigquery_v2
Google CloudSQL MySQL (v2) 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
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 (v2) Source platform.intercom
Invoiced (v1) Source platform.invoiced
Iterable (v1) Source platform.iterable
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 (v2) Source platform.linkedin-ads
Listrak (v1) Source platform.listrak
LivePerson (v1) Source platform.liveperson
Looker (v1) Source platform.looker
LookML (v1) Source platform.lookml
MailChimp (v1) Source platform.mailchimp
Mailjet (v1) Source Unsupported
Mailshake (v1) Source platform.mailshake
Mambu (v4) Source platform.mambu
Mandrill (v1) Source Unsupported
MariaDB (v2) Source platform.mariadb
MariaDB MySQL (v1) Destination mysql_destination
Marketo (v2) Source platform.marketobulk
Microsoft Advertising (v2) Source platform.bing-ads
Microsoft Azure SQL Database (v1) Source platform.mssql
Microsoft Azure Synapse Analytics (v1) Destination azure_sqldw
Microsoft SQL Server (v1) Destination mssql_server
Microsoft SQL Server (v1) Source platform.mssql
Microsoft Teams (v1) Source platform.ms-teams
Mixpanel (v1) Source platform.mixpanel
MongoDB (v3) Source platform.mongodb
MongoDB Atlas (v3) Source platform.mongodb
MySQL (v1) Destination mysql_destination
MySQL (v2) Source platform.hp-mysql
NetSuite (v2) 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 (v2) Source platform.quickbooks
Recharge (v2) 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
Sailthru (v1) Source platform.sailthru
Salesforce (v2) 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
Snapchat Ads (v1) Source platform.snapchat-ads
Snowflake (v1) Destination snowflake
SparkPost (v1) Source Unsupported
Square (v2) Source platform.square
Stripe (v3) Source platform.stripe
SurveyMonkey (v2) Source platform.surveymonkey
Taboola (v1) Source platform.taboola
TikTok Ads (v1) Source platform.tiktok-ads
Toggl (v1) Source platform.toggl
Trello (v1) Source platform.trello
Twilio (v1) Source platform.twilio
Twitter Ads (v1) Source platform.twitter-ads
Typeform (v2) 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 (v2) Source platform.yotpo
Zapier (v1) Source Unsupported
Zendesk Chat (v1) Source platform.zendesk-chat
Zendesk Support (v2) Source platform.zendesk
Zuora (v1) Source platform.zuora
(v) Source Unsupported

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 ActiveCampaign source connection property object

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

ActiveCampaign connections read data from the ActiveCampaign API and correspond to source type: platform.activecampaign.

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 ActiveCampaign API token. Refer to the ActiveCampaign documentation for instructions on retrieving this info.

api_url STRING

Your ActiveCampaign API URL. Your URL should begin with https://. Refer to the ActiveCampaign 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 (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 ActiveCampaign source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_token":"<YOUR_API_TOKEN>",
  "api_url":"<YOUR_API_URL>",
  "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 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 ARRAY

Optional: An array of strings that specifies the name of the databases that can be discovered by Stitch.

If no value is specified, Stitch will discover all databases on the host.

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":["<DATABASE_NAME>", "<OTHER_DATABASE_NAME>"],
  "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 Advanced or Premium 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 CircleCI source connection property object

Property type: platform.circle-ci Connection type: Source
Documentation: Stitch docs

CircleCI connections read data from and correspond to source type: platform.circle-ci.

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.

project_slugs STRING

Your project slugs. This is a space-separated list. Refer to the CircleCI documentation for instructions on how to create a project slug.

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 CircleCI API token. Refer to the CircleCI documentation for instructions on how to create a one.

Example CircleCI 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",
  "project_slugs":"<PROJECT_TYPE>/<ORG_NAME>/<REPO_NAME>",
  "start_date":"2018-01-10T00:00:00Z",
  "token":"<API_TOKEN>"
}

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 Crossbeam source connection property object

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

Crossbeam connections read data from the Crossbeam API and correspond to source type: platform.crossbeam.

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

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

auth_base_url STRING

Your Crossbeam account’s Auth base URL.

base_url STRING

Your account’s base URL.

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.

organization_uuid STRING

Your organization’s universally unique ID.

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 Crossbeam source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "auth_base_url":"<AUTH_BASE_URL>",
  "base_url":"<BASE_URL>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "organization_uuid":"<ORGANIZATION_UUID>",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Crossbeam 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 Crossbeam's documentation for more info on performing OAuth with Crossbeam.

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

Name Type Required Description
client_id STRING

The ID generated by Crossbeam to identify your OAuth application.

client_secret STRING

A secret key generated by Crossbeam to verify your client_id.

refresh_token STRING

An access token generated by a Crossbeam OAuth handshake.

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

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 data.world destination connection property object

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

data.world connections write data to a data.world account dataset and correspond to destination type: dataworld.

data.world destination connection property objects can contain two types of properties:

data.world destination form properties

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

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

Name Type Required Description
account_id STRING

A data.world Account ID. Refer to the data.world documentation for more info.

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
Example data.world destination connection property object with form properties
{
  "account_id":"<YOUR_DATA_WORLD_ACCOUNT_ID>",
  "output_file_format":"jsonl"
}

Back to connection property object search

data.world destination OAuth properties

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

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

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

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

Name Type Required Description
access_token STRING

The data.world access token to use in future requests to the data.world API, created after a successful OAuth handshake with data.world.

s3_bucket STRING

This property is provided by Stitch and should not be set when creating or updating a data.world destination.

s3_key_format_string STRING

This property is provided by Stitch and should not be set when creating or updating a data.world destination.

Example data.world destination connection property object with OAuth properties
{
  "access_token":"<ACCESS_TOKEN>",
  "s3_bucket":<S3_BUCKET>,
  "s3_key_format_string":"<S3_KEY_FORMAT_STRING>"
}

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 Dixa source connection property object

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

Dixa connections read data from and correspond to source type: platform.dixa.

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

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 Dixa 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",
  "start_date":"2018-01-10T00:00:00Z"
}

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 Advanced or Premium 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 (Adwords) source connection property object

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

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

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

Google Ads (Adwords) 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 (Adwords) 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 (Adwords) 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 (Adwords)'s documentation for more info on performing OAuth with Google Ads (Adwords).

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 (Adwords) account IDs to replicate data from.

developer_token STRING

Your Google Ads (Adwords) 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 (Adwords) 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 (Adwords) 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 (Adwords) access tokens when old ones expire.

user_id STRING

The ID of the Google user authorizing the connection.

Example Google Ads (Adwords) 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 Ads source connection property object

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

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

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.

conversion_window STRING

The number of days for the conversion window. The value can be any number between 1 and 30, 60 or 90.

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",
  "conversion_window":"30",
  "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.

login_customer_ids ARRAY

An array of objects, each containing a pair of customer IDs.

Name Type Required Description
customerId STRING

The Ads account’s customer ID

loginCustomerId STRING

The manager account’s customer ID.

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>",
  "login_customer_ids":[
     {
        "customerId":"<CUSTOMER_ID>",
        "loginCustomerId":"<MANAGER_ACCOUNT_CUSTOMER_ID>"
     }
   ],
  "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 4 source connection property object

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

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

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

Google Analytics 4 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.

conversion_window INTEGER

The conversion window. The value can be 30, 60 or 90 days. The conversion window is 90 days by default.

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.

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 4 source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "conversion_window":"X0",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "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 4 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 4's documentation for more info on performing OAuth with Google Analytics 4.

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

Name Type Required Description
access_token STRING

The token used to access your Google Analytics 4 data via API.

account_id STRING

Your Google Analytics 4 account ID. Refer to Google’s documentation for more info.

oauth_client_id STRING

Your Google Analytics 4 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 Analytics 4 OAuth application’s client secret, obtained when you create an OAuth app with Google. Refer to Google’s documentation for more info.

property_id STRING

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

refresh_token STRING

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

user_id STRING

TThe ID of the Google user authorizing the connection. You can use Google’s Account Explorer to search or browse through your accounts, properties, and views.

Example Google Analytics 4 source connection property object with OAuth properties
{
  "access_token":"<YOUR_ACCESS_TOKEN>",
  "account_id":"<YOUR_ACCOUNT_ID>",
  "oauth_client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "oauth_client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "property_id":"<A_PROPERTY_ID>",
  "refresh_token":"<REFRESH_TOKEN>",
  "user_id":"<A_USER_ID>"
}

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 ARRAY

Optional: An array of strings that specifies the name of the databases that can be discovered by Stitch. If no value is specified, Stitch will discover all databases on the host.

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":["<DATABASE_NAME>", "<OTHER_DATABASE_NAME>"],
  "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 Advanced or Premium 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 Advanced or Premium 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 Advanced or Premium 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 Advanced or Premium 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 Iterable source connection property object

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

Iterable connections read data from and correspond to source type: platform.iterable.

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 Iterable API key.

api_window_in_days INTEGER

The API window, in days.

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 Iterable source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<API_KEY>",
  "api_window_in_days":"X",
  "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 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 Advanced or Premium 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 ARRAY

Optional: An array of strings that specifies the name of the databases that can be discovered by Stitch.

If no value is specified, Stitch will discover all databases on the host.

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":["<DATABASE_NAME>", "<OTHER_DATABASE_NAME>"],
  "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 Advanced or Premium 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
{
  "account_ids":"<ACCOUNT_ID>",
  "customer_id":"<CUSTOMER_ID>",
  "developer_token":"<YOUR_MICROSOFT_ADVERTISING_(BING_ADS)_DEVELOPER_TOKEN>",
  "oauth_client_id":"<YOUR_MICROSOFT_ADVERTISING_(BING_ADS)_OAUTH_CLIENT_ID>",
  "oauth_client_secret":"<YOUR_MICROSOFT_ADVERTISING_(BING_ADS)_OAUTH_CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>",
  "user_id":"<USER_ID>"
}

Back to connection property object search


DESTINATION

The Azure Synapse Analytics destination connection property object

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

Azure Synapse Analytics connections write data to a Azure Synapse Analytics and correspond to destination type: azure_sqldw.

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

Name Type Required Description
azure_storage_account_token STRING

An Azure Storage Access Key. This is used to access Azure Blob Storage, which Stitch uses to stage data for Polybase before loading it into an Azure Synapse Analytics destination.

For more info and instructions for generating this credential, refer to our Azure Synapse Analytics setup documentation.

azure_storage_sas_url STRING

An Azure Blob service Shared Access Signature (SAS) URL, which is used to grant Stitch restricted access to Azure Storage resources. These resources are used to load data into an Azure Synapse Analytics destination.

For more info and instructions for generating this credential, refer to our Azure Synapse Analytics setup documentation.

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

username STRING

The username of the database user.

Example Azure Synapse Analytics destination connection property object with form properties
{
  "azure_storage_account_token":"<AZURE_STORAGE_ACCESS_KEY>",
  "azure_storage_sas_url":"<AZURE_STORAGE_SAS_URL>",
  "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":"1433",
  "username":"<USERNAME>"
}

Back to connection property object search


DESTINATION

The Microsoft SQL Server destination connection property object

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

Microsoft SQL Server connections write data to and correspond to destination type: mssql_server.

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

ssl BOOLEAN

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

username STRING

The username of the database user.

Example Microsoft SQL Server 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":"1433",
  "ssl":true,
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The Microsoft SQL Server source connection property object

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

Microsoft SQL Server connections read data from Microsoft SQL Server databases and correspond to source type: platform.mssql.

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.

database STRING

The name of the logical database to connect to.

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

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.

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

Back to connection property object search


SOURCE

The Microsoft Teams source connection property object

Property type: platform.ms-teams Connection type: Source
Documentation: Stitch docs

Microsoft Teams connections read data from the Microsoft Teams API and correspond to source type: platform.ms-teams.

Microsoft Teams source connection property objects can contain two types of properties:

You will need to have an Azure App set up to connect to Stitch for the integration. Refer to the Microsoft Teams documentation in Singer for instructions on how to set up the app.

Microsoft Teams 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 Microsoft Teams 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

Microsoft Teams 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 Teams's documentation for more info on performing OAuth with Microsoft Teams.

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

Name Type Required Description
client_id STRING

Your OAuth application’s client ID, obtained when you create an app with Azure. Refer to the Microsoft Teams documentation in Singer for instructions on obtaining this credential.

client_secret STRING

Your OAuth application’s client secret, obtained when you create an app with Azure. Refer to the Microsoft Teams documentation in Singer for instructions on obtaining this credential.

tenant_id STRING

Your Office 365 tenant ID. This is ID is located on the Properties page in your Azure Active Directory.

Example Microsoft Teams source connection property object with OAuth properties
{
  "client_id":"<YOUR_CLIENT_ID>",
  "client_secret":"<YOUR_CLIENT_SECRET>",
  "tenant_id":"<YOUR_TENANT_ID>"
}

Back to connection property object search


SOURCE

The Mixpanel source connection property object

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

Mixpanel connections read data from the Mixpanel API and correspond to source type: platform.mixpanel.

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_secret STRING

The API secret of your project in your Mixpanel account. Refer to the Mixpanel documentation for instructions on obtaining this information.

attribution_window STRING

Defines the number, in days, Stitch should use as an attribution window. To ensure your Mixpanel and Stitch settings align, we recommend using the same attribution window in Stitch that you use in Mixpanel. Mixpanel’s default attribution window is five days (5).

Refer to the Mixpanel documentation for more information about attribution windows for this integration.

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

Defines the number, in days, for a date looping window for the export, funnel, and revenue tables. Date looping will return records whose from_date and to_date fall between the number of days in the defined window size.

Note: If your project has large volumes of events, you may want to set the number of days to 14, 7, or even to 1 or 2 days.

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.

project_timezone STRING

The timezone in which your date-time fields are stored for your project. You can find your project timezone in the project settings in the Mixpanel console. For more information on Mixpanel’s project timezones, click here.

select_properties_by_default STRING

A confifguration parameter - the only accepted values are true and false. When set to true, this parameter captures new properties in the events and engage tables’ records. If set to false, new properties will be ignored.

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 Mixpanel source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_secret":"<YOUR_API_SECRET>",
  "attribution_window":"<XX>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "date_window_size":"<XX>",
  "frequency_in_minutes":"60",
  "project_timezone":"US/Pacific",
  "select_properties_by_default":"true",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The MongoDB source connection property object

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

MongoDB connections read data from MongoDB databases and correspond to source type: platform.mongodb.

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.

database STRING

The name of the authentication database for the user connecting the source.

Note: For Atlas-based instances, this must be the admin database.

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.

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

replica_set STRING

The name of the replica set to be used for Log-based Incremental Replication.

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.

user STRING

The username of the database user.

Example MongoDB source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "database":"admin",
  "frequency_in_minutes":"30",
  "host":"<HOST_ADDRESS>",
  "include_schemas_in_destination_stream_name":"false",
  "password":"<PASSWORD>",
  "port":"27017",
  "replica_set":"<REPLICA_SET>",
  "ssh":"true",
  "ssh_host":"<SSH_HOST>",
  "ssh_port":"22",
  "ssh_user":"<SSH_USERNAME>",
  "ssl":"false",
  "user":"<USERNAME>"
}

Back to connection property object search


SOURCE

The MySQL (HP) source connection property object

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

MySQL (HP) connections read data from MySQL databases and correspond to source type: platform.hp-mysql.

Note: This version of the MySQL source differs from the version used by the platform.mysql form property. Refer to the MySQL (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.

filter_dbs ARRAY

Optional: An array of strings that specifies the name of the databases that can be discovered by Stitch.

If no value is specified, Stitch will discover all databases on the host.

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.

ssl_ca STRING

Optional: The certificate (typically a CA or server certificate) Stitch should verify the SSL connection against. The connection will succeed only if the server’s certifcate verifies against the certificate provided.

Note: Providing a certifcate via this property isn’t required to use SSL. This is only if Stitch should verify the connection against a specific certificate.

ssl_cert STRING

Optional: If ssl_client_auth_enabled: true, the SSL client authentication cerficiate Stitch should use. The ssl_key property must also be provided to ensure the connection is successful.

ssl_key STRING

Optional: If ssl_client_auth_enabled: true, the SSL client authentication key stitch should use. The ssl_ca property must also be provided to ensure the connection is successful.

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

verify_mode STRING

Optional: SSL certificate verification is enabled when a Certificate Authority (CA) is provided. If true, Stitch will enforce it in lieu of a custom CA. Accepted values are:

  • true
  • `false’

Note: If you don’t want to use a custom CA, this property and the check_hostname property should both be enabled (true).

dbname STRING

The name of the logical database to connect to.

Example MySQL (HP) source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "filter_dbs":["<DATABASE_NAME>", "<OTHER_DATABASE_NAME>"],
  "frequency_in_minutes":"60",
  "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",
  "ssl_ca":"<SSL_CERTIFICATE>",
  "ssl_cert":"<CA_CERTIFICATE>",
  "ssl_key":"<CA_KEY>",
  "start_date":"2018-01-10T00:00:00Z",
  "use_log_based_replication":"true",
  "user":"<USERNAME>",
  "verify_mode":"true",
  "dbname
":"<DATABASE_NAME>"
}

Back to connection property object search


DESTINATION

The MySQL destination connection property object

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

MySQL connections write data to and correspond to destination type: mysql_destination.

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

Name Type Required Description
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 ``.

ssl BOOLEAN

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

username STRING

The username of the database user.

Example MySQL destination connection property object with form properties
{
  "encryption_host":"<ENCRYPTION_HOST_ADDRESS>",
  "encryption_port":"<ENCRYPTION_PORT>",
  "encryption_type":"ssh",
  "encryption_username":"<ENCRYPTION_USERNAME>",
  "host":"<HOST_ADDRESS>",
  "password":"<PASSWORD>",
  "port":"",
  "ssl":true,
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The MySQL source connection property object

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

MySQL connections read data from MySQL databases and correspond to source type: platform.mysql.

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.

check_hostname STRING

Optional: This property works with the verify_mode property to validate that the hostname of the database server matches the name in the provided certificate. Accepted values are:

  • true
  • false

Note: If you don’t want to use a custom CA, this property and the verify_mode property should both be enabled (true).

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.

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.

ssl_ca STRING

Optional: The certificate (typically a CA or server certificate) Stitch should verify the SSL connection against. The connection will succeed only if the server’s certifcate verifies against the certificate provided.

Note: Providing a certifcate via this property isn’t required to use SSL. This is only if Stitch should verify the connection against a specific certificate.

ssl_cert STRING

Optional: If ssl_client_auth_enabled: true, the SSL client authentication cerficiate stitch should use. The ssl_key property must also be provided to ensure the connection is successful.

ssl_client_auth_enabled STRING

Optional: Indicates if SSL client authentication should be used. Accepted values are:

  • true
  • false
ssl_key STRING

Optional: If ssl_client_auth_enabled: true, the SSL client authentication key stitch should use. The ssl_ca property must also be provided to ensure the connection is successful.

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.

verify_mode STRING

Optional: SSL certificate verification is enabled when a Certificate Authority (CA) is provided. If true, Stitch will enforce it in lieu of a custom CA. Accepted values are:

  • true
  • `false’

Note: If you don’t want to use a custom CA, this property and the check_hostname property should both be enabled (true).

database STRING

The name of the logical database to connect to.

Example MySQL source connection property object with form properties
{
  "allow_non_auto_increment_pks":"true",
  "anchor_time":"2018-04-30T17:00:00Z",
  "check_hostname":"true",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "filter_dbs":"",
  "frequency_in_minutes":"60",
  "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",
  "ssl_ca":"<SSL_CERTIFICATE>",
  "ssl_cert":"<CA_CERTIFICATE>",
  "ssl_client_auth_enabled":"true",
  "ssl_key":"<CA_KEY>",
  "use_log_based_replication":"true",
  "user":"<USERNAME>",
  "verify_mode":"true",
  "database
":"<DATABASE_NAME>"
}

Back to connection property object search


SOURCE

The NetSuite source connection property object

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

NetSuite connections read data from the NetSuite SuiteTalk API (v2017_2) and correspond to source type: platform.netsuite.

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

Name Type Required Description
account STRING

Your NetSuite account ID. If the account ID includes a suffix, it should be included. For example: 1234567_sb2

Refer to the NetSuite 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.

consumer_key STRING

The consumer key for Stitch’s integration record in the user’s NetSuite account. This is used when performing token-based authentication to NetSuite.

Refer to the NetSuite documentation for instructions on retrieving this info.

consumer_secret STRING

The consumer secret for Stitch’s integration record in the user’s NetSuite account. This is used when performing token-based authentication to NetSuite.

Refer to the NetSuite 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 (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_id STRING

The token ID, created as part of generating access tokens for Stitch’s integration record in the user’s NetSuite account. This is used when performing token-based authentication to NetSuite.

Refer to the NetSuite documentation for instructions on retrieving this info.

token_secret STRING

The token secret, created as part of generating access tokens for Stitch’s integration record in the user’s NetSuite account. This is used when performing token-based authentication to NetSuite.

Refer to the NetSuite documentation for instructions on retrieving this info.

Example NetSuite source connection property object with form properties
{
  "account":"1234567_sb2",
  "anchor_time":"2018-04-30T17:00:00Z",
  "consumer_key":"<NETSUITE_CONSUMER_KEY>",
  "consumer_secret":"<NETSUITE_CONSUMER_SECRET>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z",
  "token_id":"<NETSUITE_TOKEN_ID>",
  "token_secret":"<NETSUITE_TOKEN_SECRET>"
}

Back to connection property object search


SOURCE

The NetSuite SuiteAnalytics source connection property object

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

NetSuite SuiteAnalytics connections read data from NetSuite SuiteAnalytics and correspond to source type: platform.netsuite-suite-analytics.

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

Name Type Required Description
account_id STRING

The account ID for the NetSuite account being connected, as found on the account’s Set Up SuiteAnalytics Connect page. Refer to the NetSuite SuiteAnalytics docs 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.

host STRING

The host address for the NetSuite account being connected, as found on the account’s Set Up SuiteAnalytics Connect page. Refer to the NetSuite SuiteAnalytics docs for more info.

password STRING

The password for the Stitch NetSuite user. Refer to the NetSuite SuiteAnalytics docs for more info.

port STRING

The port for the NetSuite account being connected, as found on the account’s Set Up SuiteAnalytics Connect page. Refer to the NetSuite SuiteAnalytics docs for more info.

role_id STRING

The internal ID of the role assigned to the Stitch NetSuite user. Refer to the NetSuite SuiteAnalytics docs for more info.

username STRING

The username for the Stitch NetSuite user. Refer to the NetSuite SuiteAnalytics docs for more info.

Example NetSuite SuiteAnalytics source connection property object with form properties
{
  "account_id":"123456",
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "host":"<NETSUITE_ACCOUNT_ID>.connect.api.netsuite.com",
  "password":"<PASSWORD>",
  "port":"1708",
  "role_id":"1001",
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The Onfleet source connection property object

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

Onfleet connections read data from the Onfleet API and correspond to source type: platform.onfleet.

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 Onfleet API key. Refer to the Onfleet 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.

quota_limit STRING

The percentage of the Onfleet API quota Stitch is allowed to use for this connection.

Onfleet limits API requests to 20 requests per second across all API keys in a given Onfleet account.

For example: If this value is 10, Stitch would be allowed to use 10% of the API quota, or 2 requests per second.

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 Onfleet source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<ONFLEET_API_KEY>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "quota_limit":"10",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Oracle source connection property object

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

Oracle connections read data from Oracle databases and correspond to source type: platform.oracle.

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.

default_replication_method STRING

The replication method to be used as the default method for tables set to replicate. Accepted values are:

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

sid STRING

The database’s Oracle System ID (SID). A SID is used to uniquely identify a specific database in Oracle.

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.

user STRING

The username of the database user.

Example Oracle source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "default_replication_method":"LOG_BASED",
  "filter_schemas":"",
  "frequency_in_minutes":"30",
  "host":"<HOST_ADDRESS>",
  "password":"<PASSWORD>",
  "port":"1521",
  "sid":"<ORACLE_SID>",
  "ssh":"true",
  "ssh_host":"<SSH_HOST>",
  "ssh_port":"22",
  "ssh_user":"<SSH_USERNAME>",
  "user":"<USERNAME>"
}

Back to connection property object search


SOURCE

The Outbrain source connection property object

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

Outbrain connections read data from the Outbrain API and correspond to source type: platform.outbrain.

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

Name Type Required Description
account_id STRING

Your Outbrain account (or marketer) ID.

You can find this info by looking at the URL when you’re logged into your Outbrain account. The Account ID looks something like this: 0f4b02153ee75f3c9dc4fc128ab041962 and is located between marketers and campaigns, if you’re looking at the Overview dashboard:

https://my.outbrain.com/amplify/site/marketers/[account-id-will-be-here]/campaigns/overview

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.

password STRING

Your Outbrain 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

Your Outbrain username.

Example Outbrain source connection property object with form properties
{
  "account_id":"0f4b02153ee75f3c9dc4fc128ab041962",
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "password":"<PASSWORD>",
  "start_date":"2018-01-10T00:00:00Z",
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The Outreach source connection property object

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

Outreach connections read data from the Outreach API and correspond to source type: platform.outreach.

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_limit STRING

The percentage of your standard Outreach API quota Stitch is allowed to use. Refer to the Outreach documentation for more information on defining this limit.

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 Outreach 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_limit":"XX",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


DESTINATION

The Panoply destination connection property object

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

Panoply connections write data to a Panoply and correspond to destination type: panoply.

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.

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 Panoply destination connection property object with form properties
{
  "database":"<DATABASE_NAME>",
  "host":"<HOST_ADDRESS>",
  "password":"<PASSWORD>",
  "port":"5439",
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The Pardot source connection property object

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

Pardot connections read data from the Pardot API and correspond to source type: platform.pardot.

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

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

email STRING

The email address used for your account.

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.

pardot_business_unit_id STRING

The 18-character long business unit ID for your account. Refer to the Pardot documentation for instructions on retrieving this credential.

password STRING

The password used for your 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

user_key STRING

32-character hexadecimal user key for your user account. This allows Stitch to access your account’s API. You can retrieve your user key in the API User Key row on the settings page of your Pardot account.

Example Pardot source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "email":"<YOUR_EMAIL_ADDRESS>",
  "frequency_in_minutes":"60",
  "pardot_business_unit_id":"<YOUR_BUSINESS_UNIT_ID>",
  "password":"<YOUR_PASSWORD>",
  "start_date":"2018-01-10T00:00:00Z",
  "user_key":"<YOUR_USER_KEY>"
}

Back to connection property object search

Pardot 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 Pardot's documentation for more info on performing OAuth with Pardot.

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

Name Type Required Description
client_id STRING

Your Salesforce connected app’s consumer key. This info can be found on the connected app’s Manage Connected Apps page or from the connected app’s definition. Refer to Salesforce’s documentation for more info.

client_secret STRING

Your Salesforce connected app’s consumer secret. This info can be found on the connected app’s Manage Connected Apps page or from the connected app’s definition. Refer to Salesforce’s documentation for more info.

refresh_token STRING

A token that your Salesforce connected app will use to obtain new access tokens, when needed.

Example Pardot source connection property object with OAuth properties
{
  "client_id":"<YOUR_CONNECTED_APP_CLIENT_ID>",
  "client_secret":"<YOUR_CONNECTED_APP_CLIENT_SECRET>",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Pendo source connection property object

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

Pendo connections read data from the Pendo API and correspond to source type: platform.pendo.

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.

include_anonymous_visitors STRING

If true, anonymous visitors will be included when extracting visitor data. The default is false.

period STRING

The time period by which data is aggregated for event streams. Accepted values are:

  • dayRange
  • hourRange

Refer to the Pendo 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

x_pendo_integration_key STRING

A Pendo integration key. Refer to the Pendo documentation for instructions on creating this credential.

Example Pendo 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",
  "include_anonymous_visitors":"false",
  "period":"dayRange",
  "start_date":"2018-01-10T00:00:00Z",
  "x_pendo_integration_key":"<PENDO_INTEGRATION_KEY>"
}

Back to connection property object search


SOURCE

The Pepperjam source connection property object

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

Pepperjam connections read data from the Pepperjam API and correspond to source type: platform.pepperjam.

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 Pepperjam API key. Refer to the Pepperjam documentation for instructions on obtaining 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 Pepperjam source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<YOUR_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 Pipedrive source connection property object

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

Pipedrive connections read data from the Pipedrive API and correspond to source type: platform.pipedrive.

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 Pipedrive API token, used to authenticate to Pipedrive’s API.

Note: In Pipedrive, API tokens are unique to each Pipedrive user. The API token provided should be associated with a Pipedrive user with Admin permissions, which will ensure Stitch can successfully access and replicate all data from Pipedrive.

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 Pipedrive 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":"30",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The PostgreSQL (HP) source connection property object

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

PostgreSQL (HP) connections read data from PostgreSQL databases and correspond to source type: platform.hp-postgres.

Note: This version of the PostgreSQL source differs from the version used by the platform.postgres form property. Refer to the 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.

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.

Example 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",
  "ssh":"true",
  "ssh_host":"<SSH_HOST>",
  "ssh_port":"22",
  "ssh_user":"<SSH_USERNAME>",
  "ssl":"false",
  "use_log_based_replication":"true",
  "user":"<USERNAME>"
}

Back to connection property object search


DESTINATION

The PostgreSQL destination connection property object

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

PostgreSQL connections write data to a PostgreSQL and correspond to destination type: postgres.

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

ssl BOOLEAN

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

sslrootcert STRING

Optional: The certificate (typically a CA or server certificate) Stitch should verify the SSL connection against. The connection will succeed only if the server’s certificate verifies against the certificate provided.

Note: Providing a certificate via this property isn’t required to use SSL. This is only if Stitch should verify the connection against a specific certificate.

username STRING

The username of the database user.

Example PostgreSQL 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":"5432",
  "ssl":true,
  "sslrootcert":"<OPTIONAL_SSL_CERTIFICATE>",
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The PostgreSQL source connection property object

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

PostgreSQL connections read data from PostgreSQL databases and correspond to source type: platform.postgres.

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.

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.

wal2json_message_format STRING

The message format version the wal2json plugin on Stitch’s server should use when performing Log-based Incremental Replication.

Accepted values are:

  • 1 - Use the v1 message format. This is the default.
  • 2 - Use the v2 message format
Example 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",
  "ssh":"true",
  "ssh_host":"<SSH_HOST>",
  "ssh_port":"22",
  "ssh_user":"<SSH_USERNAME>",
  "ssl":"false",
  "use_log_based_replication":"true",
  "user":"<USERNAME>",
  "wal2json_message_format":"2"
}

Back to connection property object search


SOURCE

The Quick Base source connection property object

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

Quick Base connections read data from the Quick Base API and correspond to source type: platform.quickbase.

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.

qb_appid STRING

The ID of the Quick Base app the user wants to connect. This is a unique alpha-numeric string that can be found in the app’s URL when the user is logged into Quick Base.

For example: If the app URL is https://stitchdata.quickbase.com/db/bngf9ix7e, the app ID is bngf9ix7e.

qb_url STRING

The URL of the user’s Quick Base realm. This value must include the https:// and the trailing backslash after db/.

For example: If the realm URL is https://stitchdata.quickbase.com/db/main?a=myqb, the URL required is https://stitchdata.quickbase.com/db/.

qb_user_token STRING

The user’s Quick Base user token. Refer to Stitch’s Quick Base documentation for creation instructions.

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 Quick Base 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",
  "qb_appid":"<APPID>",
  "qb_url":"https://<your-subdomain-here>.quickbase.com/db/",
  "qb_user_token":"<QUICK_BASE_USER_TOKEN>",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Quickbooks source connection property object

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

Quickbooks connections read data from the Quickbooks API and correspond to source type: platform.quickbooks.

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

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

max_results STRING

The maximum amount of rows of data you want replicated from your Quickbooks account. If the amount is not specified, the default amount of rows replicated will be 100. The maximum amount of rows of data you can replicate at a time is 1000.

sandbox STRING

Whether to replicate data from your Quickbooks sandbox or prod account for this integration. If false, Stitch will connect to your prouction account. The default value is false.

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 Quickbooks 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",
  "max_results":"`true` or `false`",
  "sandbox":"`true` or `false`",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Quickbooks 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 Quickbooks's documentation for more info on performing OAuth with Quickbooks.

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

Name Type Required Description
client_id STRING

Your Quickbooks OAuth application’s client ID, obtained when you create an OAuth app.

client_secret STRING

Your Quickbooks OAuth application’s client secret, obtained when you create an OAuth app.

realm_id STRING

Your company ID in your Quickbooks account.

refresh_token STRING

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

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

Back to connection property object search


SOURCE

The ReCharge source connection property object

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

ReCharge connections read data from the ReCharge API and correspond to source type: platform.recharge.

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

Name Type Required Description
access_token STRING

Your ReCharge access token. Refer to the ReCharge documentation for instructions on obtaining 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.

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 ReCharge source connection property object with form properties
{
  "access_token":"<RECHARGE_ACCESS_TOKEN>",
  "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


SOURCE

The Recurly source connection property object

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

Recurly connections read data from the Recurly API and correspond to source type: platform.recurly.

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 Recurly API key. Refer to the Recurly 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.

quota_limit STRING

The percentage of the API rate limit that should be allocated to Stitch replicating from Recurly. For example: A value of 30 would be 30% of the rate limit. Refer to Recurly’s 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

subdomain STRING

Your Recurly subdomain. For example: If the full URL were https://stitchdata.recurly.com, the value of this property would be stitchdata.

Example Recurly 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":"60",
  "quota_limit":"30",
  "start_date":"2018-01-10T00:00:00Z",
  "subdomain":"<RECURLY_SUBDOMAIN>"
}

Back to connection property object search


SOURCE

The Referral SaaSquatch source connection property object

Property type: platform.referral-saasquatch Connection type: Source
Documentation: Stitch docs

Referral SaaSquatch connections read data from the Referral SaaSquatch API and correspond to source type: platform.referral-saasquatch.

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 Referral SaaSquatch API key. Refer to the Referral SaaSquatch 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.

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

tenant_alias STRING

Your Referral SaaSquatch tenant alias.

Example Referral SaaSquatch 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",
  "tenant_alias":"<TENANT_ALIAS>"
}

Back to connection property object search


SOURCE

The Responsys source connection property object

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

Responsys connections read data from Responsys databases and correspond to source type: platform.responsys.

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:

  • 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 host address of the Responsys SFTP server. If the server is hosted by Oracle, this will likely be files.responsys.net.

path STRING

The file server path where completed Responsys export files are stored.

port STRING

The port of the SFTP server. As Stitch uses an SSH tunnel to connect to Responsys, this will likely be the default SSH port (22).

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.

Example Responsys 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",
  "host":"<HOST_ADDRESS>",
  "path":"<PATH>",
  "port":"22",
  "start_date":"2018-01-10T00:00:00Z",
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The Revinate source connection property object

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

Revinate connections read data from the Revinate API and correspond to source type: platform.revinate.

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 Revinate API key. You can obtain this by contacting your Revinate sales representative or account manager.

api_secret STRING

Your Revinate API secret. The user can obtain this by contacting their Revinate sales representative or account manager.

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

username STRING

Your Revinate username.

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

Back to connection property object search


SOURCE

The RingCentral source connection property object

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

RingCentral connections read data from the RingCentral API and correspond to source type: platform.ringcentral.

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 API URL used by the RingCentral developer application. Refer to the RingCentral documentation for instructions on generating this info.

client_id STRING

The client ID for the RingCentral developer application. Refer to the RingCentral documentation for instructions on generating this credential.

client_secret STRING

The client secret for the RingCentral developer application. Refer to the RingCentral 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.

password STRING

The password for the RingCentral developer application.

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 for the RingCentral application. This is typically the phone number used to create the app.

Example RingCentral source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_url":"https://platform.ringcentral.com",
  "client_id":"<CLIENT_ID>",
  "client_secret":"<CLIENT_SECRET>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "password":"<PASSWORD>",
  "start_date":"2018-01-10T00:00:00Z",
  "username":"9991234567"
}

Back to connection property object search


SOURCE

The SaaSOptics source connection property object

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

SaaSOptics connections read data from the SaaSOptics API and correspond to source type: platform.saasoptics.

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

Name Type Required Description
account_name STRING

Your account name. Refer to the SaaSOptics documentation for instructions on retrieving this information.

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.

date_window_size STRING

This is an internal field for Stitch use. The value is defaulted to 60.

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.

server_subdomain STRING

The subdomain of your SaaSOptics account. When enterting this information, do not include the .saasoptics.com portion of the web address. Refer to the SaaSOptics documentation for instructions on retrieving this information.

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

A API token. Refer to the SaaSOptics documentation for instructions on retrieving this credential.

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

Back to connection property object search


SOURCE

The Sailthru source connection property object

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

Sailthru connections read data from the Sailthru API and correspond to source type: platform.sailthru.

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 Sailthru API key. Refer to the Sailthru documentation to retrieve this information.

api_secret STRING

Your Sailthru API secret. Refer to the Sailthru documentation to retrieve 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.

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 Sailthru source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<YOUR_API_KEY>",
  "api_secret":"<YOUR_API_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 Salesforce Marketing Cloud source connection property object

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

Salesforce Marketing Cloud connections read data from the Salesforce Marketing Cloud API and correspond to source type: platform.exacttarget.

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.

batch_size STRING

This field is for Stitch internal use only.

client_id STRING

A Salesforce Marketing Cloud client ID. Refer to the Salesforce Marketing Cloud documentation for instructions on generating this credential.

client_secret STRING

A Salesforce Marketing Cloud client secret. Refer to the Salesforce Marketing Cloud 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.

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

tenant_subdomain STRING

The tenant subdomain ID for your Salesforce Marketing Cloud account. Refer to the Salesforce Marketing Cloud documentation for instructions on retrieving this info.

Example Salesforce Marketing Cloud source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "batch_size":"",
  "client_id":"<CLIENT_ID>",
  "client_secret":"<CLIENT_SECRET>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z",
  "tenant_subdomain":"mcx21dt54chc0gprl638px2g7r48"
}

Back to connection property object search


SOURCE

The Salesforce source connection property object

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

Salesforce connections read data from the Salesforce API and correspond to source type: platform.salesforce.

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

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

api_type STRING

The Salesforce API Stitch should use to extract data. Possible values are REST or BULK. Read about the pros and cons of each API here.

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 Salesforce account being connected is a sandbox.

quota_percent_per_run STRING

The maximum percentage of Salesforce API quota allowed per replication job.

quota_percent_total STRING

The maximum percentage of Salesforce API quota allowed per day.

select_fields_by_default STRING

If true, Stitch will automatically set new fields added in Salesforce to replicate.

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 Salesforce source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_type":"BULK",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "is_sandbox":"false",
  "quota_percent_per_run":"20",
  "quota_percent_total":"80",
  "select_fields_by_default":"false",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Salesforce 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 Salesforce's documentation for more info on performing OAuth with Salesforce.

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

Name Type Required Description
client_id STRING

Your Salesforce connected app’s consumer key. This info can be found on the connected app’s Manage Connected Apps page or from the connected app’s definition. Refer to Salesforce’s documentation for more info.

client_secret STRING

Your Salesforce connected app’s consumer secret. This info can be found on the connected app’s Manage Connected Apps page or from the connected app’s definition. Refer to Salesforce’s documentation for more info.

instance_url STRING

The URL indicating the instance of the authorizing user’s org.

orgid STRING

The ID of the org the authorizing user belongs to.

refresh_token STRING

A token that your Salesforce connected app will use to obtain new access tokens, when needed.

Example Salesforce source connection property object with OAuth properties
{
  "client_id":"<YOUR_CONNECTED_APP_CLIENT_ID>",
  "client_secret":"<YOUR_CONNECTED_APP_CLIENT_SECRET>",
  "instance_url":"https://yourInstance.salesforce.com",
  "orgid":"<USER_ORG>",
  "refresh_token":"<REFRESH_TOKEN>"
}

Back to connection property object search


SOURCE

The Selligent source connection property object

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

Selligent connections read data from and correspond to source type: platform.selligent.

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 Selligent API key. Contact your Selligent account manager for assistance in generating your API key.

base_url STRING

The base URL for your Selligent installation.

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.

organization STRING

The name of your organization in Selligent.

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 Selligent source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<API_KEY>",
  "base_url":"https://organization.yourhost.com:443",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "organization":"Organization",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The SendGrid source connection property object

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

SendGrid connections read data from the SendGrid API and correspond to source type: platform.sendgrid.

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 SendGrid API key. Refer to SendGrid’s documentation for info about permissions and creating 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 SendGrid 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 SFTP source connection property object

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

SFTP connections read data from CSV files on an FTP server and correspond to source type: platform.sftp.

Refer to the SFTP 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
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:

  • 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 host address (endpoint) of the SFTP server.

password STRING

Optional: You only need to provide a password if you aren’t using SSH.

port INTEGER

The port of the SFTP server. The default is 22.

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 SFTP 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 SFTP 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 SFTP documentation for more info.

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

    • , - Comma
    • | - Pipe
    • \t - Tab
username STRING

The username of the SFTP user. If using SSH, this should be the same user that adds the Stitch public key to their authorized_keys file. Refer to the SFTP documentation for instructions.

Example SFTP 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",
  "host":"ftp.example-website.com",
  "password":"<PASSWORD>",
  "port":"22",
  "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\":\",\"}]",
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The ShipHero source connection property object

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

ShipHero connections read data from the ShipHero API and correspond to source type: platform.shiphero.

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 ShipHero API token, used to authenticate to ShipHero’s API.

Note: In the ShipHero app, this is referred to as an API Key.

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 ShipHero 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",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Shippo source connection property object

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

Shippo connections read data from the Shippo API and correspond to source type: platform.shippo.

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

token STRING

Your Shippo API token. Refer to the Shippo documentation for instructions on retrieving this credential.

Example Shippo 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",
  "token":"<API_TOKEN>"
}

Back to connection property object search


SOURCE

The Shopify source connection property object

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

Shopify connections read data from the Shopify API and correspond to source type: platform.shopify.

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

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

shop STRING

The name of the Shopify shop.

For example: If the shop URL was stitch-data.shopify.com, this value would be stitch-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 Shopify 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",
  "shop":"stitch-data",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Shopify 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 Shopify's documentation for more info on performing OAuth with Shopify.

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

Name Type Required Description
api_key STRING

The API key for your Shopify shop, generated via an OAuth handshake.

Example Shopify source connection property object with OAuth properties
{
  "api_key":"<API_KEY>"
}

Back to connection property object search


SOURCE

The Slack source connection property object

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

Slack connections read data from the Slack API and correspond to source type: platform.slack.

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.

date_window_size STRING

The number of days to replicate for each request made for applicable streams during a replication job. The default is 7.

This property applies to the following streams:

  • files
  • messages
  • remote_files

For example: If this value is 7, Stitch will replicate 7 days’ worth of data for each request made for the files stream.

Note: This doesn’t mean only seven days’ worth of data is replicated for each replication job, as Stitch can make several API requests for the same stream over the course of a job. This is implemented to more efficiently replicate data and prevent issues with Slack’s API.

exclude_archived STRING

If false, then the integration will replicate data for archived channels in your Slack workspace. The default is false.

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.

join_public_channels STRING

If true, then the integration will have your Slack app join all public channels in your Slack workspace and not just the ones you have personally joined. The default is true.

lookback_window STRING

The number of historical days’ worth of data to replicate from the start_date value for each replication job for the files and remote_files streams. The default is 14.

private_channels STRING

If true, then the integration will replicate data for private channels in your Slack workspace. The default is true.

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

A Slack app bot user OAuth access token, generated after you create a Slack app, assign the required scopes, and install the app in your workspace. Refer to the Slack documentation for instructions on retrieving this information.

Example Slack source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "date_window_size":"7",
  "exclude_archived":"false",
  "frequency_in_minutes":"60",
  "join_public_channels":"true",
  "lookback_window":"7",
  "private_channels":"true",
  "start_date":"2018-01-10T00:00:00Z",
  "token":"<YOUR_APP_BOT_USER_OAUTH_ACCESS_TOKEN>"
}

Back to connection property object search


SOURCE

The Snapchat Ads source connection property object

Property type: platform.snapchat-ads Connection type: Source
Documentation: Stitch docs

Snapchat Ads connections read data from and correspond to source type: platform.snapchat-ads.

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 Snapchat 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":"60",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


DESTINATION

The Snowflake destination connection property object

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

Snowflake connections write data to a Snowflake and correspond to destination type: snowflake.

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.

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

role STRING

The role to use.

username STRING

The username of the database user.

warehouse STRING

The name of the Snowflake warehouse Stitch will connect to.

Example Snowflake destination connection property object with form properties
{
  "database":"<DATABASE_NAME>",
  "host":"<HOST_ADDRESS>",
  "password":"<PASSWORD>",
  "port":"443",
  "role":"<OPTIONAL_ROLE>",
  "username":"<USERNAME>",
  "warehouse":"<WAREHOUSE>"
}

Back to connection property object search


SOURCE

The Square source connection property object

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

Square connections read data from the Square API and correspond to source type: platform.square.

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

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

sandbox STRING

If true, Stitch will connect to your Square sandbox environment. The default is false.

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 Square 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",
  "sandbox":"`true` or `false`",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

Square 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 Square's documentation for more info on performing OAuth with Square.

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

Name Type Required Description
client_id STRING

The ID generated by Square to identify your OAuth application.

client_secret STRING

A secret key generated by Square to verify your client_id.

refresh_token STRING

An access token generated by a Square OAuth handshake.

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

Back to connection property object search


SOURCE

The Stripe source connection property object

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

Stripe connections read data from the Stripe API and correspond to source type: platform.stripe.

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

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

date_window_size STRING

Internal field.

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.

lookback_window INTEGER

The number of historical days’ worth of data to replicate from the start_date value for each replication job for your streams. The maximum lookback window is 600 days.”

request_timeout STRING

Internal 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

whitelist_map STRING

An optional parameter used to select individual fields from the data attribute in the events stream.

The fields in a data object are dependent on the event’s type. For example: For an invoice.* event, the data object will contain an invoice object. Refer to Stripe’s documentation for a list of supported event types and the fields a data object may contain for each event type.

The value for this property is typed as a STRING and takes the following form:

{
  "events": [
    ["data","<field_1_breadcrumb>"],
    ["data","<field_2_breadcrumb>"],
    ...
    ["data","<field_n_breadcrumb>"]
  ]
}

The <field_breadcrumb> value is the path to the field you want to track. For example: The following would select the id, amount, plan, plan.id, and plan.active fields:

{
  "events": [
    ["data","id"],
    ["data","amount"],
    ["data","plan"],
    ["data","plan","id"],
    ["data","plan","active"]
  ]
}

Fields for multiple event types may be included in the whitelist_map value.

Example Stripe source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "date_window_size":"",
  "frequency_in_minutes":"60",
  "lookback_window":"600",
  "request_timeout":"",
  "start_date":"2018-01-10T00:00:00Z",
  "whitelist_map":""{\"events\":[[\"data\",\"id\"],[\"data\",\"amount\"],[\"data\",\"plan\"],[\"data\",\"plan\",\"id\"],[\"data\",\"plan\",\"active\"]]}""
}

Back to connection property object search

Stripe 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 Stripe's documentation for more info on performing OAuth with Stripe.

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

Name Type Required Description
account_id STRING

The ID of the Stripe account being connected to Stitch.

client_secret STRING

The secret key of the Stripe account being connected to Stitch, available in the account’s Stripe dashboard.

Example Stripe source connection property object with OAuth properties
{
  "account_id":"<ACCOUNT_ID>",
  "client_secret":"<CLIENT_SECRET>"
}

Back to connection property object search


SOURCE

The SurveyMonkey source connection property object

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

SurveyMonkey connections read data from the SurveyMonkey API and correspond to source type: platform.surveymonkey.

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

Name Type Required Description
access_token STRING

The access token. This access token allows Stitch to access your account’s API. Refer to the SurveyMonkey 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.

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

survey_id STRING

The survey ID. These survey IDs are used to pull simplified responses for specific surveys. Refer to the SurveyMonkey documentation for instructions on locating this info.

Example SurveyMonkey source connection property object with form properties
{
  "access_token":"<YOUR_ACCESS_TOKEN>",
  "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",
  "survey_id":"<YOUR_SURVEY_ID"
}

Back to connection property object search


SOURCE

The Taboola source connection property object

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

Taboola connections read data from the Taboola API and correspond to source type: platform.taboola.

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

Name Type Required Description
account_id STRING

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

client_id STRING

Your Taboola client ID.

client_secret STRING

Your Taboola 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 (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

Your Taboola 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

Your Taboola username.

Example Taboola source connection property object with form properties
{
  "account_id":"<ACCOUNT_ID>",
  "anchor_time":"2018-04-30T17:00:00Z",
  "client_id":"<CLIENT_ID>",
  "client_secret":"<CLIENT_SECRET>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"30",
  "password":"<PASSWORD>",
  "start_date":"2018-01-10T00:00:00Z",
  "username":"<USERNAME>"
}

Back to connection property object search


SOURCE

The TikTok Ads source connection property object

Property type: platform.tiktok-ads Connection type: Source
Documentation: Stitch docs

TikTok Ads connections read data from and correspond to source type: platform.tiktok-ads.

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 TikTok 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":"60",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Toggl source connection property object

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

Toggl connections read data from the Toggl API and correspond to source type: platform.toggl.

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 Toggl API token. For more info and instructions on retrieving this credential, refer to our Toggl setup documentation.

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.

detailed_report_trailing_days STRING

The number of days Stitch should replicate time entry data for during each replication job. This is only applicable to the time_entries stream.

For example: If this value is 5, Stitch will replicate the past five days’ worth of data for the time_entries stream during every replication job.

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 Toggl 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 *",
  "detailed_report_trailing_days":"5",
  "frequency_in_minutes":"30",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Trello source connection property object

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

Trello connections read data from the Trello API and correspond to source type: platform.trello.

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

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

Trello 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 Trello's documentation for more info on performing OAuth with Trello.

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

Name Type Required Description
access_token STRING
access_token_secret STRING
consumer_key STRING
consumer_secret STRING
Example Trello source connection property object with OAuth properties
{
  "access_token":"<ACCESS_TOKEN>",
  "access_token_secret":"<ACCESS_TOKEN_SECRET>",
  "consumer_key":"<CONSUMER_KEY>",
  "consumer_secret":"<CONSUMER_SECRET>"
}

Back to connection property object search


SOURCE

The Twilio source connection property object

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

Twilio connections read data from the Twilio API and correspond to source type: platform.twilio.

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

Name Type Required Description
account_sid STRING

Your Twilio account SID. Refer to the Twilio documentation to retrieve this information.

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.

auth_token STRING

Your Twilio auth token. Refer to the Twilio documentation to retrieve 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.

date_window_days INTEGER

The number of days of data to replicate at a time. The default value is 30.

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 Twilio source connection property object with form properties
{
  "account_sid":"<YOUR_ACCOUNT_SID>",
  "anchor_time":"2018-04-30T17:00:00Z",
  "auth_token":"<YOUR_AUTH_TOKEN>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "date_window_days":"XX",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Twitter Ads source connection property object

Property type: platform.twitter-ads Connection type: Source
Documentation: Stitch docs

Twitter Ads connections read data from the Twitter Ads API and correspond to source type: platform.twitter-ads.

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

Twitter 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
account_ids STRING

A Twitter Ads account ID, or a comma-delimited list of account IDs. For example: accountId1, accountId2

Refer to the Twitter Ads documentation to retrieve this information.

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

The number of days of historical records to replicate for custom report tables during each replication job.

country_codes STRING

A comma-delimited list of ISO 2-letter country codes for targeting and segmentation. Note: This value is required to use some segment types in custom reports. Refer to the Segment compatibility reference 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.

reports ARRAY

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

Note: If provided, each property in this object must be provided to fully configure the custom report.

Name Type Required Description
name STRING

The name of the custom report.

entity STRING

The entity (object) to report on. The entity determines the metrics (fields) available for selection and the segments you can apply to those metrics. Refer to the Custom report options compatibility reference for more info.

Accepted values are:

  • ACCOUNT

  • CAMPAIGN

  • FUNDING_INVESTMENT

  • LINE_ITEM

  • MEDIA_CREATIVE

  • ORGANIC_TWEET

  • PROMOTED_ACCOUNT

  • PROMOTED_TWEET

segment STRING

The segment to apply to the entity’s available metrics. Note: Some entity and segment combinations may be incompatible. Refer to the Segment compatibility reference for more info.

Accepted values are:

  • NO_SEGMENT

  • AGE

  • AMPLIFY_MARKETPLACE_PREROLL_VIDEOS

  • AMPLIFY_PUBLISHER_TWEETS

  • APP_STORE_CATEGORY

  • AUDIENCES

  • CONVERSIONS

  • CONVERSION_TAGS

  • DEVICES

  • EVENTS

  • GENDER

  • INTERESTS

  • KEYWORDS

  • LANGUAGES

  • LOCATION

  • METROS

  • PLATFORM_VERSIONS

  • PLATFORMS

  • POSTAL_CODES

  • REGIONS

  • SIMILAR_TO_FOLLOWERS_OF_USER

  • SWIPEABLE_MEDIA

  • TV_ADS

  • TV_SHOWS

granularity STRING

The granularity of the custom report data. Accepted values are:

  • DAY
  • HOUR
  • TOTAL
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

with_deleted STRING

Whether to include logically deleted records, that fall outside of the attribution window, in the results. This value will be true or false.

Example Twitter Ads source connection property object with form properties
{
  "account_ids":"<YOUR_ACCOUNT_ID_1>,<YOUR_ACCOUNT_ID_2>",
  "anchor_time":"2018-04-30T17:00:00Z",
  "attribution_window":"14",
  "country_codes":"US,MX,CA,DE",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "reports":[
   {
        "name": "campaigns_genders_hourly_report",
        "enitity": "CAMPAIGN",
        "segment": "GENDER",
        "granularity": "HOUR"
     },
     {
        "name": "line_items_regions_daily_report",
        "enitity": "LINE_ITEM",
        "segment": "REGIONS",
        "granularity": "DAY"
     }
   ],
  "start_date":"2018-01-10T00:00:00Z",
  "with_deleted":""
}

Back to connection property object search

Twitter 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 Twitter Ads's documentation for more info on performing OAuth with Twitter Ads.

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

Name Type Required Description
access_token STRING

The access token of the Twitter Ads account being connected to Stitch.

access_token_secret STRING

The token secret key of the Twitter Ads account being connected to Stitch.

consumer_key STRING

Your Twitter Ads OAuth application’s consumer key. This is obtained when you create an OAuth app with Twitter.

consumer_secret STRING

Your Twitter Ads OAuth application’s consumer secret. This is obtained when you create an OAuth app with Twitter.

Example Twitter Ads source connection property object with OAuth properties
{
  "access_token":"<ACCESS_TOKEN>",
  "access_token_secret":"<ACCESS_TOKEN_SECRET>",
  "consumer_key":"<CONSUMER_KEY>",
  "consumer_secret":"<CONSUMER_SECRET>"
}

Back to connection property object search


SOURCE

The Typeform source connection property object

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

Typeform connections read data from the Typeform API and correspond to source type: platform.typeform.

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.

forms STRING

The Typeform form ID(s) Stitch should replicate. If replicating multiple forms, enter the IDs as a comma-separated list. For example: "<FORM_ID_1>, <FORM_ID_2>" Refer to our Typeform documentation for instructions on retrieving form IDs.

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

The type of data aggregation Stitch should use when replicating Typeform data. Accepted values are:

  • daily
  • 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

Your Typeform API token. Refer to our Typeform documentation for instructions on generating the token.

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

Back to connection property object search


SOURCE

The UJET source connection property object

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

UJET connections read data from and correspond to source type: platform.ujet.

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.

company_key STRING

Your UJET company key. Refer to the UJET documentation to retrieve this information.

company_secret STRING

Your UJET company secret code. Refer to the UJET documentation to retrieve 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.

date_window_size STRING

This is an internal field for Stitch use.

domain STRING

The domain of your UJET account’s URL.

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 account’s URL. For example: If the URL were stitch.ujet.com, the subdomain would be stitch.

Example UJET source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "company_key":"<YOUR_COMPANY_KEY>",
  "company_secret":"<YOUR_COMPANY_SECRET_CODE>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "date_window_size":"",
  "domain":"ujet",
  "frequency_in_minutes":"60",
  "start_date":"2018-01-10T00:00:00Z",
  "subdomain":"your-subdomain"
}

Back to connection property object search


SOURCE

The Urban Airship source connection property object

Property type: platform.urban-airship Connection type: Source
Documentation: Stitch docs

Urban Airship connections read data from the Urban Airship API and correspond to source type: platform.urban-airship.

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.

app_key STRING

Your Urban Airship app key. Refer to the Urban Airship documentation for instructions on retrieving this credential.

app_secret STRING

Your Urban Airship app secret. Refer to the Urban Airship 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.

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 Urban Airship source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "app_key":"<APP_KEY>",
  "app_secret":"<APP_SECRET>",
  "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 UserVoice source connection property object

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

UserVoice connections read data from the UserVoice API and correspond to source type: platform.uservoice.

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 UserVoice API key. API keys must be generated by a user who can access Settings in their UserVoice account. Refer to UserVoice’s documentation for credential generation instructions.

api_secret STRING

The UserVoice API secret. API secrets must be generated by a user who can access Settings in their UserVoice account. Refer to UserVoice’s documentation for credential generation instructions.

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

The subdomain of the UserVoice account to replicate data from. For example: If the full subdomain were stitch.uservoice.com, only stitch would be provided.

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

Back to connection property object search


SOURCE

The Workday RaaS source connection property object

Property type: platform.workday-raas Connection type: Source
Documentation: Stitch docs

Workday RaaS connections read data from the Workday RaaS API and correspond to source type: platform.workday-raas.

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

Your password for your Workday RaaS account.

reports STRING

A stringified JSON array containing objects with report_url and report_name keys. For every report you want to replicate from Workday RaaS, include an object with these keys:

  • report_url - A report’s Workday XML REST link. Refer to the Workday RaaS documentation for instructions on retrieving this info from Workday RaaS.
  • report_name - A report name of your choice

Refer to the example object below to see what this value should look like.

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 username for your Workday RaaS account.

Example Workday RaaS 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":"<YOUR_PASSWORD>",
  "reports":"[{\"report_url\": \"<REPORT_URL_1>", \"table_name\": \"REPORT_ONE\"},{\"report_url\": \"<REPORT_URL_2>", \"table_name\": \"REPORT_TWO\"}]",
  "start_date":"2018-01-10T00:00:00Z",
  "username":"<YOUR_USERNAME>"
}

Back to connection property object search


SOURCE

The Xero source connection property object

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

Xero connections read data from the Xero API and correspond to source type: platform.xero.

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

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

oauth_s3_bucket STRING

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

This is an internal Stitch field.

oauth_s3_path STRING

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

This is an internal Stitch 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 Xero 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",
  "oauth_s3_bucket":"<STITCH_OAUTH_S3_BUCKET>",
  "oauth_s3_path":"<STITCH_OAUTH_S3_PATH>",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search

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

<p>When configuring OAuth for Xero sources, note that:</p>
  • Only Partner Applications are supported. Stitch’s Xero source is designed to work only with Xero Partner Applications. Private Applications aren’t currently supported.
  • This version of the source uses Xero’s OAuth 1.0a implementation. Upgrading to OAuth 2.0 is on the roadmap, but there currently isn’t a release timeline.

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

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

Name Type Required Description
consumer_key STRING

Your OAuth 1.0a application’s consumer key, generated when you register your application with Xero.

consumer_secret STRING

Your OAuth 1.0a application’s consumer secret, generated when you register your application with Xero.

oauth_session_handle STRING

An OAuth 1.0a session handle, used to refresh the oauth_token.

oauth_token STRING

An OAuth 1.0a access token.

oauth_token_secret STRING

An OAuth 1.0a access token secret.

organization_name STRING

The name of the organization allowing access.

rsa_key STRING

An RSA Key, generated when you register your application with Xero. Refer to Xero’s documentation for more info.

Example Xero source connection property object with OAuth properties
{
  "consumer_key":"<OAUTH_1.0A_CONSUMER_KEY>",
  "consumer_secret":"<OAUTH_1.0A_CONSUMER_SECRET>",
  "oauth_session_handle":"<OAUTH_1.0A_SESSION_HANDLE>",
  "oauth_token":"<OAUTH_1.0A_ACCESS_TOKEN>",
  "oauth_token_secret":"<OAUTH_1.0A_ACCESS_TOKEN_SECRET>",
  "organization_name":"<ORGANIZATION_NAME>",
  "rsa_key":"<RSA_KEY>"
}

Back to connection property object search


SOURCE

The Yotpo source connection property object

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

Yotpo connections read data from the Yotpo API and correspond to source type: platform.yotpo.

Note: Creating a Yotpo source requires Yotpo API credentials. Retrieving these credentials requires Yotpo Account Administrator permissions. Refer to Yotpo’s 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.

api_key STRING

The API Key for the Yotpo account Stitch should replicate data from. This is the App Key field in the Yotpo app, accessed by clicking User menu (people icon) > Account Settings > Store tab.

api_secret STRING

The API Secret for the Yotpo account Stitch should replicate data from. This is the Secret Key field in the Yotpo app, accessed by clicking User menu (people icon) > Account Settings > Store tab.

Note: Yotpo Account Administrator permissions are required to retrieve 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.

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 Yotpo source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "api_key":"<API_KEY>",
  "api_secret":"<API_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 Zendesk Chat source connection property object

Property type: platform.zendesk-chat Connection type: Source
Documentation: Stitch docs

Zendesk Chat connections read data from the Zendesk Chat API and correspond to source type: platform.zendesk-chat.

Zendesk Chat source connection property objects can contain two types of properties:

Zendesk Chat 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 Advanced or Premium 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

subdomain STRING

The subdomain of your Zendesk Chat account URL.

Example Zendesk Chat 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",
  "subdomain":"<YOUR_SUBDOMAIN>"
}

Back to connection property object search

Zendesk Chat 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 Zendesk Chat's documentation for more info on performing OAuth with Zendesk Chat.

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

Name Type Required Description
access_token STRING

The access token of the Zendesk Chat account being connected to Stitch.

Example Zendesk Chat source connection property object with OAuth properties
{
  "access_token":"<ACCESS_TOKEN>"
}

Back to connection property object search


SOURCE

The Zendesk source connection property object

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

Zendesk connections read data from the Zendesk API and correspond to source type: platform.zendesk.

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

Zendesk 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 (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

subdomain STRING

The prefix of the Zendesk subdomain Stitch should replicate data from.

For example: If the address is stitchdata.zendesk.com, only stitchdata would be entered as the value.

Example Zendesk 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",
  "subdomain":"<YOUR_ZENDESK_SUBDOMAIN>"
}

Back to connection property object search

Zendesk 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 Zendesk's documentation for more info on performing OAuth with Zendesk.

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

Name Type Required Description
access_token STRING

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

client_id STRING

Your Zendesk OAuth application’s client ID.

client_secret STRING

Your Zendesk OAuth application’s client secret.

marketplace_app_id STRING

The app ID assigned when you submit your app to the Zendesk Marketplace.

marketplace_name STRING

The name of the integration in the Zendesk Marketplace.

marketplace_organization_id STRING

The organization ID of your organization from the Zendesk Marketplace developer portal.

oauth_token STRING

An OAuth token associated with the client_id. Refer to Zendesk’s documentation for more info.

Example Zendesk source connection property object with OAuth properties
{
  "access_token":"<ACCESS_TOKEN>",
  "client_id":"<YOUR_OAUTH_CLIENT_ID>",
  "client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
  "marketplace_app_id":"<YOUR_MARKETPLACE_APP_ID>",
  "marketplace_name":"<YOUR_MARKETPLACE_INTEGRATION_NAME>",
  "marketplace_organization_id":"<YOUR_MARKETPLACE_ORGANIZATION_ID>",
  "oauth_token":"<YOUR_OAUTH_TOKEN>"
}

Back to connection property object search


SOURCE

The Zoom source connection property object

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

Zoom connections read data from the Zoom API and correspond to source type: platform.zoom.

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

Your Zoom client ID. Only use this if you plan to connect to Stitch using an OAuth app. Refer to the Zoom documentation to retrieve this information.

client_secret STRING

Your Zoom client secret key. Only use this if you plan to connect to Stitch using an OAuth app. Refer to the Zoom documentation to retrieve 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.

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.

jwt STRING

Your Zoom JSON Web Token (JWT). Only use this if you plan to connect to Stitch using a JWT app. Refer to the Zoom documentation to retrieve this information.

refresh_token STRING

Your Zoom refresh token. Only use this if you plan to connect to Stitch using an OAuth app. Refer to the Zoom documentation to retrieve this information.

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 Zoom source connection property object with form properties
{
  "anchor_time":"2018-04-30T17:00:00Z",
  "client_id":"<YOUR_CLIENT_ID>",
  "client_secret":"<YOUR_CLIENT_SECRET>",
  "cron_expression":"0 0 12 ? * MON-FRI *",
  "frequency_in_minutes":"60",
  "jwt":"<YOUR_JWT>",
  "refresh_token":"<YOUR_REFRESH_TOKEN>",
  "start_date":"2018-01-10T00:00:00Z"
}

Back to connection property object search


SOURCE

The Zuora source connection property object

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

Zuora connections read data from the Zuora API and correspond to source type: platform.zuora.

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.

european STRING

If true, the Zuora account being connected is based in Europe.

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 Zuora user authorizing the connection.

sandbox STRING

If true, the Zuora account being connected 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

username STRING

The username of the Zuora user authorizing the connection. To successfully create a connection, this user must:

  1. Have Standard user permissions across the board,
  2. Have two-factor authentication disabled. Refer to this Zuora article for assistance in disabling this setting.
  3. Have credentials that don’t expire. This is only applicable if Password Expiration rules are enforced. Refer to Zuora’s documentation for a workaround.

For more info, refer to our Zuora integration documentation.

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

Back to connection property object search