Introduction
The Stitch Connect API enables users to programmatically access and manage their Stitch accounts, or Stitch partners to seamlessly integrate Stitch’s data pipleine functionality into their own platforms.
This API is a RESTful, resource-oriented API that allows you to programmatically provision Stitch accounts, create and modify data sources, and configure destination connections.
Each endpoint uses standard HTTP verbs like GET and POST, and will return standard HTTP response codes to indicate request status or errors.
We built the API to accept and return JSON in all responses, including errors.
API functionality
Using the API, you can:
-
Create Stitch client accounts (Partners only)
-
Access Stitch client accounts
-
Retrieve configuration info for destinations
-
Create, update, and delete destinations
-
Retrieve configuration info for data sources
-
Create, update, pause, unpause, and delete data sources
-
Retrieve connection check results for a data source
-
Select and configure streams and fields from data sources for replication
-
Start and stop replication jobs
-
Retrieve status info about recent extraction jobs
-
Retrieve status info about recent data loading attempts
-
Create, pause, unpause, and delete notification settings for a Stitch client account
Tutorials and resources
Check out the tutorials and resources to learn more about using Stitch Connect.
Accessing the API
To use the API, you’ll need to obtain an API access token. This is necessary for authenticating successfully. Refer to the Authentication section for more info.
Terminology
Partner ID |
The unique ID for your partner application, obtained after an interest form is submitted to and approved by Stitch. |
Partner key |
The key associated with your partner application, obtained after an interest form is submitted to and approved by Stitch. |
Partner |
An organization that utilizes Stitch Connect to programmatically create and/or manage Stitch client accounts on behalf of their users. |
Stitch client account |
An individual account for the Stitch web application. |
Client account access token |
An API access token associated with a single Stitch client account. This token must be passed into the header of every request made to the API for the Stitch client account. |
Ephemeral token |
A token that is passed to the Connect JavaScript Client to create a session. Ephemeral tokens expire one hour after generation. When specified as an argument in a Connect JavaScript function, the ephemeral token is exchanged for a session token, creating a temporary Stitch session for the user. The session expires once terminated or 12 hours after its creation. |
Destination |
Destination is the Stitch word for ‘data warehouse.’ A data warehouse is a central repository for data accumulated from a variety of sources. |
Session |
A browser session in the Stitch web application. |
Source |
A database, API, or other data application that Stitch replicates data from. Outside of Connect, known as an ‘integration’. |
Stream |
A table in a data source. |
Connection check |
A test performed by Stitch that checks the configuration of a source’s connection parameters. |
Replication job |
The three-step process by which Stitch replicates data. A replication job includes three distinct steps: Extraction, preparation, and loading. |
Structure sync |
The first step in the replication process, this process takes place during the Extraction phase of a replication job. A structure sync detects the tables and columns available in the source, along with any changes to the structure of those tables and columns. This is also referred to as discovery. |
Authentication
Authenticate your calls to the API by providing an access token in your requests. Each access token is associated with a single Stitch client account. Access tokens do not expire, but they may be revoked by the user at any time.
Additionally, each request’s permissions are limited to that Stitch client account.
In the examples in this documentation, we use bearer auth:
curl "https://api.stitchdata.com
/v4/sources" \
-H 'Authorization: Bearer [ACCESS_TOKEN]' \
-H 'Content-Type: application/json'
All requests must be made over HTTPS or they will fail. API requests that don’t contain authentication will also fail.
Obtain an API access token
How you obtain an access token depends on the type of user you are:
-
Individual Stitch user: You will be using the API to programmatically control your own Stitch client account. You can create, revoke, and delete API access tokens on the Account Settings page of your Stitch client account.
-
Stitch partner: You will be performing actions in Stitch client accounts on behalf of users who authorize your API client. You’ll need to register as an API client and refer to the Partner API Authentication guide for instructions.
Credential reference
This section contains a list of the different credentials refered to throughout the Connect documentation.
Name | Prefix | Details |
API access token | ac_ |
|
Partner ID | oc_ |
|
Partner secret | oc_ |
|
Ephemeral token | Not applicable |
|
Session token | Not applicable |
|
Response codes
The API will attempt to return HTTP status codes for every request.
Code | Text | Description |
200 |
OK |
Success! |
302 |
Found |
TODO |
400 |
Bad Request |
The request is invalid, contains malformed data, or otherwise cannot be served. The reasons for invalid requests can vary by endpoint. An accompanying message will provide detail about the reason for failure. |
401 |
Unauthorized |
The request doesn’t have a valid API access token. Verify your token is correct and re-try the request. |
404 |
Not Found |
Potential causes:
|
500 |
Internal Server Error |
The API is experiencing problems. Try again later. |
502 |
Bad Gateway |
The API is experiencing problems. Try again later. |
Error message format
The API will return error messages in JSON format. Some error messages may be returned as strings:
an account can have at most one destination
While others may be JSON objects:
{
"code":"ExistingUser",
"message":"This email address is already associated with an active user."
}
Error message text
The text in error messages will vary by root cause and endpoint.
Each endpoint section contains a rollup of the errors specific to that endpoint. Refer to the documentation for the endpoint for specifics on errors, their possible causes, and the messages the API will return.
Rate limits
A rate limit defines the maximum number of requests, over a period of time, that can be made to the Connect API.
Rate limits are enforced for endpoints that can return large amounts of data or may require polling to identify updates. To ensure all API consumers receive the same high quality experience, Stitch employs rate limits to ensure API stability and availability.
Rate limit application
Stitch imposes a limit on the number of requests that can be made for a given client ID over a period of time. The number of requests and the time period over which requests can be made varies by resource type.
Endpoints are grouped based on resource type. Usage counting towards the rate limit for a resource type is aggregated across requests made to all endpoints in the resource type group.
For example: The Extractions and Loads endpoints are part of the Jobs resource. Requests made to any extraction- or load-based endpoint counts towards the rate limit usage for the Jobs resource type.
Rate limit types
The resource type for an endpoint determines how many API requests can be made for a given time period. Refer to the table below for details about resource types and the endpoints that are subject to rate limits.
Note: Only endpoints subject to rate limiting are listed in the table. If an endpoint isn’t listed, rate limiting is not currently applicable for that endpoint.
Resource type | API requests | Time period | Affected endpoints |
Jobs |
30 | 10 minutes |
Avoid rate limiting violations
Currently, Stitch takes a DTRT (Do The Right Thing) approach to enforcing rate limits. There isn’t functionality built into the API to programmatically enforce rate limits, but this may change in the future. We’re trusting everyone to be good API consumers.
If a client repeatedly exceeds rate limits, Stitch may block that client from accessing rate limited endpoints.
To avoid rate limit violations, we recommend making requests only for the data you need, only when you need it. Additionally, distribute requests to ensure you stay within the maximum number of requests during the allowed time period for the endpoint.
Pagination
Some endpoints in the API return lists of objects such as extraction jobs, loading records, and so on. As lists can be quite large depending on the number of sources in a client account, several API endpoints will return paginated results.
Per page record limits
Pages are currently limited to 100 records per page.
Result sorting and ordering
Paginated results are sorted and ordered. The data used to sort and order records varies by endpoint.
Refer to the Endpoints with pagination for a list of endpoints with pagination and how results are returned.
Pagination data
Endpoints with paginated results have page
, total
, and links
properties in their responses:
{
"page": 1,
"total": 37,
"links": {}
}
If the result set doesn’t exceed the per page maximum, the links
property will be empty, like in the previous example.
If the result set exceeds the per page maximum, the links
property will have next
and previous
properties. These values are URLs to the next and previous pages of results, respectively:
{
"page": 2,
"total": 237,
"links": {
"next": "/v4/116078/extractions?page=3",
"previous": "/v4/116078/extractions?page=1"
}
}
The next
and previous
values can be used as path parameters to make subsequent requests and retrieve additional pages of results. If there aren’t any pages before or after the current page, the links
object won’t have a previous
or next
property, respectively.
For example: If page: 2
and next: /v4/116078/extractions?page=3
, make a request to the endpoint using this URL to retrieve page 3 of the results:
curl "https://api.stitchdata.com
/v4/{stitch_client_id/extractions?page=3" \
-H 'Authorization: Bearer [ACCESS_TOKEN]' \
-H 'Content-Type: application/json'
To retrieve all pages, continue paging until the response no longer contains a next
property:
{
"page": 3,
"total": 237,
"links": {
"previous": "/v4/116078/extractions?page=2"
}
}
Limitations
A request made for a specific page returns only the results for that page, not the entire result set.
To determine which records display on each page, Stitch divides the total record count by the per page maximum. Keep in mind that if the total number of records changes, records may shift between pages. This means that some records may appear multiple times or be skipped all together while iterating over the entire list.
As a result, multiple requests will be required to retrieve all the data from a paginated endpoint. When making subsequent requests, keep in mind that some endpoints are subject to rate limiting.
Consider the following example:

Endpoints with pagination
Note: Only endpoints with pagination are listed in this section. If an endpoint isn’t listed, pagination is not currently applicable for that endpoint.
Endpoint | Ordered by | Sorting |
GET /v4/{stitch_client_id}/extractions | source_id | Ascending (0-9) |
GET /v4/{stitch_client_id}/loads | stream_name | Ascending (A-Z) |
Connection property objects
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 object. Connection object 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 property object
Search all supported destination and source connection properties below. Note: If a connection isn’t listed here, it isn’t currently available in the API. Refer to the Destination and Source API availability reference for a full list of Stitch’s connections.
Connection property name | Connection type | Connection property type |
---|---|---|
3PL Central | Source | platform.3plcentral |
AdRoll | Source | platform.adroll |
Amazon Aurora | Source | platform.aurora |
Amazon DynamoDB | Source | platform.dynamodb |
Amazon Redshift | Destination | redshift |
Amazon S3 CSV | Source | platform.s3-csv |
Amazon S3 | Destination | s3 |
Amplitude | Source | platform.amplitude |
AppsFlyer | Source | platform.appsflyer |
Asana | Source | platform.asana |
Autopilot | Source | platform.autopilot |
BigCommerce | Source | platform.bigcommerce |
Braintree | Source | platform.braintree |
Bronto | Source | platform.bronto |
Campaign Manager | Source | platform.doubleclick-campaign-manager |
Campaign Monitor | Source | platform.campaign-monitor |
Chargebee | Source | platform.chargebee |
Chargify | Source | platform.chargify |
Close.io | Source | platform.closeio |
Club Speed | Source | platform.clubspeed |
Codat | Source | platform.codat |
COVID-19 Public Data | Source | platform.covid-19 |
Darksky | Source | platform.darksky |
Databricks Delta Lake | Destination | databricks_delta |
Deputy | Source | platform.deputy |
eBay | Source | platform.ebay |
Eloqua | Source | platform.eloqua |
Facebook Ads | Source | platform.facebook |
Freshdesk | Source | platform.freshdesk |
Front | Source | platform.frontapp |
FullStory | Source | platform.fullstory |
GitHub | Source | platform.github |
GitLab | Source | platform.gitlab |
Google Ads | Source | platform.adwords |
Google Analytics 360 | Source | platform.ga360 |
Google Analytics | Source | platform.google-analytics |
Google BigQuery | Destination | bigquery_v2 |
Google CloudSQL MySQL | Source | platform.cloudsql |
Google CloudSQL PostgreSQL | Source | platform.cloudsql_pg |
Google Search Console | Source | platform.google-search-console |
Google Sheets | Source | platform.google-sheets |
Harvest Forecast | Source | platform.harvest-forecast |
Harvest | Source | platform.harvest |
Heap | Source | platform.heap |
Help Scout | Source | platform.helpscout |
Heroku | Source | platform.heroku_pg |
HubSpot | Source | platform.hubspot |
iLEVEL | Source | platform.ilevel |
Impact | Source | platform.impact |
Import API | Source | import_api |
Intacct | Source | platform.intacct |
Invoiced | Source | platform.invoiced |
Jira | Source | platform.jira |
Klaviyo | Source | platform.klaviyo |
Kustomer | Source | platform.kustomer |
Lever | Source | platform.lever |
Listrak | Source | platform.listrak |
LivePerson | Source | platform.liveperson |
Looker | Source | platform.looker |
MailChimp | Source | platform.mailchimp |
Mailshake | Source | platform.mailshake |
Mambu | Source | platform.mambu |
MariaDB | Source | platform.mariadb |
Marketo Bulk | Source | platform.marketobulk |
Marketo | Source | platform.marketo |
Microsoft Advertising (Bing Ads) | Source | platform.bing-ads |
Microsoft Azure Synapse Analytics | Destination | azure_sqldw |
Microsoft SQL Server | Source | platform.mssql |
Microsoft Teams | Source | platform.ms-teams |
Mixpanel | Source | platform.mixpanel |
MongoDB | Source | platform.mongodb |
MySQL | Source | platform.mysql |
NetSuite | Source | platform.netsuite |
NetSuite SuiteAnalytics | Source | platform.netsuite-suite-analytics |
Onfleet | Source | platform.onfleet |
Oracle | Source | platform.oracle |
Outbrain | Source | platform.outbrain |
Outreach | Source | platform.outreach |
Panoply | Destination | panoply |
Pardot | Source | platform.pardot |
Pendo | Source | platform.pendo |
Pepperjam | Source | platform.pepperjam |
Pipedrive | Source | platform.pipedrive |
PostgreSQL | Destination | postgres |
PostgreSQL | Source | platform.postgres |
Quick Base | Source | platform.quickbase |
Quickbooks | Source | platform.quickbooks |
ReCharge | Source | platform.recharge |
Recurly | Source | platform.recurly |
Referral SaaSquatch | Source | platform.referral-saasquatch |
Responsys | Source | platform.responsys |
Revinate | Source | platform.revinate |
RingCentral | Source | platform.ringcentral |
SaaSOptics | Source | platform.saasoptics |
Salesforce Marketing Cloud | Source | platform.exacttarget |
Salesforce | Source | platform.salesforce |
Selligent | Source | platform.selligent |
SendGrid | Source | platform.sendgrid |
SFTP | Source | platform.sftp |
ShipHero | Source | platform.shiphero |
Shippo | Source | platform.shippo |
Shopify | Source | platform.shopify |
Slack | Source | platform.slack |
Snowflake | Destination | snowflake |
Square | Source | platform.square |
Stripe | Source | platform.stripe |
SurveyMonkey | Source | platform.surveymonkey |
Taboola | Source | platform.taboola |
Toggl | Source | platform.toggl |
Trello | Source | platform.trello |
Twitter Ads | Source | platform.twitter-ads |
Typeform | Source | platform.typeform |
UJET | Source | platform.ujet |
Urban Airship | Source | platform.urban-airship |
UserVoice | Source | platform.uservoice |
Workday RaaS | Source | platform.workday-raas |
Xero | Source | platform.xero |
Yotpo | Source | platform.yotpo |
Zendesk | Source | platform.zendesk |
Zoom | Source | platform.zoom |
Zuora | Source | platform.zuora |
All connection property objects
The 3PL Central source connection property object
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
base_url
STRING REQUIRED |
The API URL to which /endpoints are appended. |
client_id
STRING REQUIRED |
The secure OAuth 2.0 identifier for the 3PL Central application/client. |
client_secret
STRING REQUIRED |
The secure OAuth 2.0 secret key for the 3PL Central application/client authentication. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
customer_id
STRING REQUIRED |
The ID for the 3PL Central customer organization. |
facility_id
STRING REQUIRED |
The ID for the 3PL Central warehouse facility. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from 3PL Central. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from 3PL Central. 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: |
tpl_key
STRING REQUIRED |
A 3PL Central warehouse-specific 3PL key. |
user_login_id
STRING REQUIRED |
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>"
}
The AdRoll source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
AdRoll source form properties
Form properties are used to complete the form
step in source configuration.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
end_date
STRING OPTIONAL |
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 OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from AdRoll. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from AdRoll. 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: |
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"
}
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.
access_token
STRING REQUIRED |
An access token generated by a NextRoll OAuth handshake. |
client_secret
STRING REQUIRED |
The secret key of the AdRoll account to use when extracting data. |
refresh_token
STRING REQUIRED |
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>"
}
The Amazon Aurora source connection property object
Amazon Aurora connections read data from Amazon Aurora databases and correspond to source type: platform.aurora
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
allow_non_auto_increment_pks
STRING OPTIONAL |
If Unless set, this property will default to |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
database
STRING OPTIONAL |
The name of the logical database to connect to. |
filter_dbs
STRING INTERNAL |
This is an internal field and is for Stitch use only. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Amazon Aurora. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
host
STRING REQUIRED |
The IP address or hostname of the database server. |
password
STRING REQUIRED |
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 REQUIRED |
The port of the database server. The default is |
server_id
STRING OPTIONAL |
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 OPTIONAL |
If |
ssh_host
STRING OPTIONAL |
The IP address or hostname of the SSH server. This property is only required if |
ssh_port
STRING OPTIONAL |
The port of the SSH server. This property is only required if |
ssh_user
STRING OPTIONAL |
The username of the SSH user. This property is only required if |
ssl
STRING OPTIONAL |
If |
use_log_based_replication
STRING OPTIONAL |
If |
user
STRING REQUIRED |
The username of the database user. |
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 *",
"database":"<DATABASE_NAME>",
"filter_dbs":"",
"frequency_in_minutes":"30",
"host":"<HOST_ADDRESS>",
"password":"<PASSWORD>",
"port":"3306",
"server_id":"<UNIQUE_SERVER_ID>",
"ssh":"true",
"ssh_host":"<SSH_HOST>",
"ssh_port":"22",
"ssh_user":"<SSH_USERNAME>",
"ssl":"false",
"use_log_based_replication":"true",
"user":"<USERNAME>"
}
The Amazon DynamoDB source connection property object
Amazon DynamoDB connections read data from Amazon DynamoDB databases and correspond to source type: platform.dynamodb
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
account_id
STRING REQUIRED |
The user’s Amazon Web Services (AWS) Account ID. Refer to the Amazon DynamoDB documentation for more info. |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
external_id
STRING REQUIRED |
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 OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Amazon DynamoDB. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
region_name
STRING REQUIRED |
The name of the region your Amazon DynamoDB instance resides in. |
role_name
STRING REQUIRED |
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 REQUIRED |
The date from which Stitch should begin replicating data from Amazon DynamoDB. 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: |
use_local_dynamo
STRING OPTIONAL |
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":""
}
The Amazon Redshift destination connection property object
Amazon Redshift connections write data to a Amazon Redshift database and correspond to destination type: redshift
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Destination.
database
STRING REQUIRED |
The name of the logical database to connect to. |
encryption_host
STRING OPTIONAL |
If using SSH encryption, the host of the SSH server. Required only if |
encryption_port
STRING OPTIONAL |
If using SSH encryption, the port of the SSH server. Required only if |
encryption_type
STRING REQUIRED |
Indicates that SSH encryption should be used to connect to the destination. Valid values are:
|
encryption_username
STRING OPTIONAL |
If using SSH encryption, the name of the SSH user. Required only if |
host
STRING REQUIRED |
The IP address or hostname of the database server. |
password
STRING REQUIRED |
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 REQUIRED |
The port of the database server. The default is |
username
STRING REQUIRED |
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>"
}
The Amazon S3 CSV source connection property object
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 in the properties
argument for Creating or Updating a Source.
account_id
STRING REQUIRED |
The user’s Amazon Web Services (AWS) Account ID. Refer to the Amazon S3 CSV documentation for more info. |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
bucket
STRING REQUIRED |
The name of the bucket Stitch should replicate data from. This value should not contain any URLs, |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
external_id
STRING REQUIRED |
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 OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Amazon S3 CSV. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
role_name
STRING REQUIRED |
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 REQUIRED |
The date from which Stitch should begin replicating data from Amazon S3 CSV. 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: |
tables
STRING REQUIRED |
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.
|
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\":\",\"}]"
}
The Amazon S3 destination connection property object
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:
- Create a bucket policy that grants Stitch permission to write to the bucket
- 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 in the properties
argument for Creating or Updating a Destination.
csv_delimiter
STRING OPTIONAL |
Defines the delimiter used if
|
csv_force_quote
STRING OPTIONAL |
If For example: Numerical fields will appear as |
output_file_format
STRING REQUIRED |
Defines the type of file Stitch will write to the bucket. Possible values are:
For examples of what data will look like in each format, refer to our Amazon S3 documentation. |
s3_bucket
STRING REQUIRED |
The name of the Amazon S3 bucket Stitch will write to. |
s3_key_format_string
STRING REQUIRED |
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:
For more info on construcing an S3 Object Key, refer to our Amazon S3 documentation. |
sentinel_key
STRING REQUIRED |
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:
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"
}
The Amplitude source connection property object
Amplitude connections read data from the Amplitude API and correspond to source type: platform.amplitude
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
account
STRING REQUIRED |
The account ID for the Amplitude Snowflake warehouse. |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Amplitude. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Amplitude. 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: |
username
STRING REQUIRED |
The username of the database user. |
warehouse
STRING REQUIRED |
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>"
}
The AppsFlyer source connection property object
AppsFlyer connections read data from the AppsFlyer API and correspond to source type: platform.appsflyer
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_token
STRING REQUIRED |
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 REQUIRED |
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 OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from AppsFlyer. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from AppsFlyer. 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: |
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"
}
The Asana source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
Asana source form properties
Form properties are used to complete the form
step in source configuration.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Asana. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Asana. 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: |
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"
}
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.
access_token
STRING REQUIRED |
The Asana token to use in future requests to the Asana API, created after a successful OAuth handshake. |
client_id
STRING REQUIRED |
Your Asana OAuth application client ID. |
client_secret
STRING REQUIRED |
Your Asana OAuth application client secret. |
redirect_uri
STRING REQUIRED |
Your Asana OAuth application redirect URL. This is provided to Asana when you register your OAuth application. |
refresh_token
STRING REQUIRED |
If exchanging a code with Asana, a long-lived token that can be used to retrieve new |
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>"
}
The Autopilot source connection property object
Autopilot connections read data from the Autopilot API and correspond to source type: platform.autopilot
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_key
STRING REQUIRED |
An API key for the Autopilot account that Stitch should replicate data from. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Autopilot. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Autopilot. 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: |
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"
}
The BigCommerce source connection property object
BigCommerce connections read data from the BigCommerce API and correspond to source type: platform.bigcommerce
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
access_token
STRING REQUIRED |
The user’s BigCommerce API access token. Refer to the BigCommerce documentation for instructions on retrieving this credential. |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
client_id
STRING REQUIRED |
The user’s BigCommerce API client ID. Refer to the BigCommerce documentation for instructions on retrieving this credential. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from BigCommerce. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from BigCommerce. 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: |
store_hash
STRING REQUIRED |
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>"
}
The Braintree source connection property object
Braintree connections read data from the Braintree API and correspond to source type: platform.braintree
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Braintree. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
merchant_id
STRING REQUIRED |
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 REQUIRED |
The Braintree account’s private key. Refer to the Braintree documentation for instructions on retrieving this info. |
public_key
STRING REQUIRED |
The Braintree account’s public key. Refer to the Braintree documentation for instructions on retrieving this info. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Braintree. 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: |
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"
}
The Bronto source connection property object
Bronto connections read data from the Bronto API and correspond to source type: platform.bronto
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Bronto. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Bronto. 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: |
token
STRING REQUIRED |
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>"
}
The Campaign Manager source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted. A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info. Note: If neither a Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Campaign Manager. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
profile_id
STRING REQUIRED |
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>"
}
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.
client_id
STRING REQUIRED |
Your Campaign Manager OAuth application’s client ID. Refer to Google’s documentation for more info. |
client_secret
STRING REQUIRED |
Your Campaign Manager OAuth application’s client secret. Refer to Google’s documentation for more info. |
refresh_token
STRING REQUIRED |
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>"
}
The Campaign Monitor source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
client_id
STRING REQUIRED |
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 OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Campaign Monitor. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Campaign Monitor. 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: |
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"
}
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.
access_token
STRING REQUIRED |
An Campaign Monitor OAuth token. |
refresh_token
STRING REQUIRED |
A long-lived Campaign Monitor token which can be used to obtain a new Campaign Monitor |
Example Campaign Monitor source connection property object with OAuth properties
{
"access_token":"<CAMPAIGN MONITOR_ACCESS_TOKEN>",
"refresh_token":"<CAMPAIGN MONITOR_REFRESH_TOKEN>"
}
The Chargebee source connection property object
Chargebee connections read data from the Chargebee API and correspond to source type: platform.chargebee
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_key
STRING REQUIRED |
The user’s Chargebee API key. Refer to the Chargebee documentation for info on generating this credential. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Chargebee. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
site
STRING REQUIRED |
The name of the user’s Chargebee site. This can be found in the Chargebee site URL. For example: If the URL was |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Chargebee. 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: |
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"
}
The Chargify source connection property object
Chargify connections read data from the Chargify API and correspond to source type: platform.chargify
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_key
STRING REQUIRED |
A Chargify API key. Refer to the Chargify documentation for instructions on creating this credential. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Chargify. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Chargify. 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: |
subdomain
STRING REQUIRED |
Your Chargify subdomain. For example: If the full URL of your Chargify site were |
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>"
}
The Close.io source connection property object
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_key
STRING REQUIRED |
Your API key. API keys can be generated in by navigating to Settings > Your API Keys. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Close.io. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Close.io. 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: |
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"
}
The Club Speed source connection property object
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Club Speed. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
private_key
STRING REQUIRED |
Your Club Speed private API key. You will need to contact Club Speed support to obtain this credential. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Club Speed. 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: |
subdomain
STRING REQUIRED |
Your Club Speed subdomain. For example: If the full URL is |
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>"
}
The Codat source connection property object
Codat connections read data from the Codat API and correspond to source type: platform.codat
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_key
STRING REQUIRED |
Your Codat API key. Refer to the Codat documentation for instructions on retrieving this credential. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Codat. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Codat. 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: |
uat_urls
STRING OPTIONAL |
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":""
}
The COVID-19 Public Data source connection property object
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_token
STRING REQUIRED |
A GitHub access token which allows access to any project the user wants to replicate data from. Note: This access token must have the |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from COVID-19 Public Data. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from COVID-19 Public Data. 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: |
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"
}
The Darksky source connection property object
Darksky connections read data from the Darksky API and correspond to source type: platform.darksky
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Darksky. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
language
STRING REQUIRED |
The language that Refer to Darksky’s documentation for a list of accepted values. |
location_list
STRING REQUIRED |
The longitude and latitude of the locations to be returned. The locations must be semi-colon delineated. For example: |
secret_key
STRING REQUIRED |
Your Darksky secret API key. Refer to the Darksky documentation for instructions on obtaining this credential. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Darksky. 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: |
units
STRING REQUIRED |
The requested unit of measurement for weather conditions to be returned. For example: |
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"
}
The Databricks Delta Lake destination connection property object
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:
- Configure access for Stitch and Databricks to an existing Amazon S3 bucket
- Generate a Databricks REST API token
- 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 in the properties
argument for Creating or Updating a Destination.
access_token
STRING REQUIRED |
A Databricks REST API access token. Refer to the Databricks Delta Lake documentation for instructions on generating this credential. |
||||||||
jdbc_url
STRING REQUIRED |
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 REQUIRED |
An object containing properties for configuring SSH encryption for the destination. Contains the following properties:
|
||||||||
staging_area
OBJECT REQUIRED |
Connection information for the Amazon S3 bucket Stitch will stage data to before loading into Databricks Delta Lake. Contains the following properties:
|
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>"
}
}
The Deputy source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
Deputy source form properties
Form properties are used to complete the form
step in source configuration.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Deputy. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Deputy. 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: |
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"
}
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.
client_id
STRING REQUIRED |
Your Deputy OAuth application’s client ID. |
client_secret
STRING REQUIRED |
Your Deputy OAuth application’s client secret. |
domain
STRING REQUIRED |
The Deputy subdomain of the user authorizing the connection. |
redirect_uri
STRING REQUIRED |
A URL where Deputy will forward the user with access credentials for your application. |
refresh_token
STRING REQUIRED |
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>"
}
The eBay source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
eBay source form properties
Form properties are used to complete the form
step in source configuration.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from eBay. Accepted values are:
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"
}
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.
client_id
STRING REQUIRED |
This is your App ID in your eBay seller account. |
client_secret
STRING REQUIRED |
This is your Cert ID in your eBay seller account. |
refresh_token
STRING REQUIRED |
A long-lived token, used to generate new eBay access tokens when old ones expire. |
scope
STRING REQUIRED |
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>"
}
The Eloqua source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
Eloqua source form properties
Form properties are used to complete the form
step in source configuration.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
bulk_page_size
STRING OPTIONAL |
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 OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Eloqua. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Eloqua. 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: |
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"
}
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.
client_id
STRING REQUIRED |
Your Eloqua OAuth application’s client ID, obtained when you register your app with Eloqua. |
client_secret
STRING REQUIRED |
Your Eloqua OAuth application’s client secret, obtained when you register your app with Eloqua. |
redirect_uri
STRING REQUIRED |
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 REQUIRED |
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>"
}
The Facebook Ads source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
attribution_window
STRING OPTIONAL |
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:
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 If your click and view windows differ, you should select the greater of the two. For example: If clicks have a window of |
cron_expression
STRING OPTIONAL |
Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted. A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info. Note: If neither a Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Facebook Ads. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
include_deleted
STRING OPTIONAL |
If |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Facebook Ads. 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: |
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"
}
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.
access_token
STRING REQUIRED |
An access token generated by a Facebook OAuth handshake. |
account_id
STRING REQUIRED |
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>"
}
The Freshdesk source connection property object
Freshdesk connections read data from the Freshdesk API and correspond to source type: platform.freshdesk
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_key
STRING REQUIRED |
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 OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
domain
STRING REQUIRED |
The subdomain prefix of the Freshdesk account Stitch should replicate data from. For example: If the URL were |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Freshdesk. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Freshdesk. 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: |
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"
}
The Front source connection property object
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Front. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
incremental_range
STRING REQUIRED |
Defines how data will be aggregated. Accepted values are |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Front. 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: |
token
STRING REQUIRED |
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>"
}
The FullStory source connection property object
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_key
STRING REQUIRED |
A FullStory API key, used to authenticate to FullStory’s Data Export API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from FullStory. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from FullStory. 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: |
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"
}
The GitHub source connection property object
GitHub connections read data from the GitHub API and correspond to source type: platform.github
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
access_token
STRING REQUIRED |
An access token which allows access to any project the user wants to replicate data from. Note: This access token must have the |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from GitHub. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
repository
STRING REQUIRED |
The path or paths of the repository or repositories to be tracked. A repository path is relative to To track multiple repositories, this value should be a space delimited list of the repository paths. For example:
|
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from GitHub. 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: |
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"
}
The GitLab source connection property object
GitLab connections read data from the GitLab API and correspond to source type: platform.gitlab
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_url
STRING REQUIRED |
The URL for the GitLab API. This value must be |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from GitLab. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
groups
STRING OPTIONAL |
Note: While providing this property is optional, either A space separated list of groups you want to track. How data is replicated using this property depends on the value of the
|
private_token
STRING REQUIRED |
A GitLab Personal Access token. Refer to the GitLab documentation for instructions on generating this credential. |
projects
STRING OPTIONAL |
Note: While providing this property is optional, either A space-separated list of projects you want to track. For example: In an organization named A space separated list of groups you want to track. How data is replicated using this property depends on the value of the
|
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from GitLab. 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: |
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"
}
The Google Ads source connection property object
Google Ads connections read data from the Google Ads API and correspond to source type: platform.adwords
.
Google Ads source connection property objects can contain two types of properties:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Google Ads. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Google Ads. 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: |
Example Google Ads source connection property object with form properties
{
"anchor_time":"2018-04-30T17:00:00Z",
"cron_expression":"0 0 12 ? * MON-FRI *",
"frequency_in_minutes":"1440",
"start_date":"2018-01-10T00:00:00Z"
}
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.
customer_ids
STRING REQUIRED |
A comma-separated list of Google Ads account IDs to replicate data from. |
developer_token
STRING REQUIRED |
Your Google Ads developer token, which identifies your app to the AdWords API. Refer to Google’s documentation for more info. |
oauth_client_id
STRING REQUIRED |
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 REQUIRED |
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 REQUIRED |
A long-lived token, used to generate new Google Ads access tokens when old ones expire. |
user_id
STRING REQUIRED |
The ID of the Google user authorizing the connection. |
Example Google Ads source connection property object with OAuth properties
{
"customer_ids":"1234567890,0987654321",
"developer_token":"<YOUR_DEVELOPER_TOKEN>",
"oauth_client_id":"<YOUR_OAUTH_CLIENT_ID>",
"oauth_client_secret":"<YOUR_OAUTH_CLIENT_SECRET>",
"refresh_token":"<REFRESH_TOKEN>",
"user_id":"<USER_ID>"
}
The Google Analytics 360 source connection property object
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
dataset_id
STRING REQUIRED |
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 OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Google Analytics 360. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
page_size
STRING OPTIONAL |
This is an internal field for Stitch use. |
project_id
STRING REQUIRED |
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 REQUIRED |
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 REQUIRED |
The date from which Stitch should begin replicating data from Google Analytics 360. 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: |
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"
}
The Google Analytics source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
||||
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
||||
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Google Analytics. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
||||
quota_user
STRING READ-ONLY |
Note: This is a read-only property and will be returned when the Google Analytics object is successfully created. Including it in |
||||
report_definitions
ARRAY REQUIRED |
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 Contains the following properties:
|
||||
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Google Analytics. 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: |
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"
}
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.
client_id
STRING REQUIRED |
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 REQUIRED |
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 REQUIRED |
A long-lived token, used to generate new Google Analytics access tokens when old ones expire. |
view_id
STRING REQUIRED |
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>"
}
The Google BigQuery destination connection property object
Google BigQuery connections write data to a Google BigQuery database and correspond to destination type: bigquery_v2
.
To set up a Google BigQuery destination, users will need to:
- Create a Google Cloud Platform IAM service account
- Generate a JSON project key file
Refer to our Google BigQuery documentation for additional details.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Destination.
cloud_storage_location
STRING REQUIRED |
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:
|
||||||||||||||||||||
loading_mode
STRING REQUIRED |
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:
Refer to the Understanding loading behavior guide for more info and examples. |
||||||||||||||||||||
project_id
STRING READ-ONLY |
Note: This is a read-only property and will be returned when the Google BigQuery object is successfully created. Including it in The ID of the project associated with the service account. |
||||||||||||||||||||
service_account_credentials
OBJECT REQUIRED |
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. Contains the following properties:
|
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>"
}
}
The Google CloudSQL MySQL source connection property object
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 in the properties
argument for Creating or Updating a Source.
allow_non_auto_increment_pks
STRING OPTIONAL |
If Unless set, this property will default to |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
database
STRING OPTIONAL |
The name of the logical database to connect to. |
filter_dbs
STRING INTERNAL |
This is an internal field and is for Stitch use only. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Google CloudSQL MySQL. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
host
STRING REQUIRED |
The IP address or hostname of the database server. |
password
STRING REQUIRED |
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 REQUIRED |
The port of the database server. The default is |
server_id
STRING OPTIONAL |
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 OPTIONAL |
If |
user
STRING REQUIRED |
The username of the database user. |
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 *",
"database":"<DATABASE_NAME>",
"filter_dbs":"",
"frequency_in_minutes":"30",
"host":"<HOST_ADDRESS>",
"password":"<PASSWORD>",
"port":"3306",
"server_id":"<UNIQUE_SERVER_ID>",
"use_log_based_replication":"true",
"user":"<USERNAME>"
}
The Google CloudSQL PostgreSQL source connection property object
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
dbname
STRING REQUIRED |
The name of the logical database to connect to. |
filter_dbs
STRING INTERNAL |
This is an internal field and is for Stitch use only. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Google CloudSQL PostgreSQL. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
host
STRING REQUIRED |
The IP address or hostname of the database server. |
include_schemas_in_destination_stream_name
STRING REQUIRED |
If For more info, refer to the Database Integration Table Name Collisions guide. |
itersize
STRING INTERNAL |
This is an internal field and is for Stitch use only. |
password
STRING REQUIRED |
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 REQUIRED |
The port of the database server. The default is |
user
STRING REQUIRED |
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>",
"filter_dbs":"",
"frequency_in_minutes":"60",
"host":"<HOST_ADDRESS>",
"include_schemas_in_destination_stream_name":"false",
"itersize":"",
"password":"<PASSWORD>",
"port":"5432",
"user":"<USERNAME>"
}
The Google Search Console source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Google Search Console. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
site_urls
STRING REQUIRED |
The domains and websites that belong to your organization. The URLs should be comma delimited and begin with |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Google Search Console. 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: |
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"
}
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.
client_id
STRING REQUIRED |
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 REQUIRED |
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 REQUIRED |
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>"
}
The Google Sheets source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Google Sheets. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
spreadsheet_id
STRING REQUIRED |
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 REQUIRED |
The date from which Stitch should begin replicating data from Google Sheets. 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: |
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"
}
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.
client_id
STRING REQUIRED |
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 REQUIRED |
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 REQUIRED |
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>"
}
The Harvest Forecast source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted. A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info. Note: If neither a Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Harvest Forecast. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Harvest Forecast. 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: |
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"
}
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.
client_id
STRING REQUIRED |
Your Harvest Forecast OAuth application client ID. |
client_secret
STRING REQUIRED |
Your Harvest Forecast OAuth application client secret. |
refresh_token
STRING REQUIRED |
If exchanging a code with Harvest Forecast, a long-lived token that can be used to retrieve new |
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>"
}
The Harvest source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
Harvest source form properties
Form properties are used to complete the form
step in source configuration.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
account_name
STRING REQUIRED |
Your Harvest account name. For example: if your Harvest account URL is |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted. A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info. Note: If neither a Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Harvest. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Harvest. 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: |
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"
}
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.
client_id
STRING REQUIRED |
Your Harvest OAuth application client ID. |
client_secret
STRING REQUIRED |
Your Harvest OAuth application client secret. |
refresh_token
STRING REQUIRED |
If exchanging a code with Harvest, a long-lived token that can be used to retrieve new |
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>"
}
The Heap source connection property object
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 in the properties
argument for Creating or Updating a Source.
account_id
STRING REQUIRED |
Your Amazon Web Services account ID. Refer to the Heap documentation for instructions on retrieving this info. |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
bucket
STRING REQUIRED |
The name of the bucket Stitch should replicate Heap data from. Heap requires that bucket names be prefixed with |
cron_expression
STRING OPTIONAL |
Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted. A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info. Note: If neither a Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
external_id
STRING REQUIRED |
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 OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Heap. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
role_name
STRING REQUIRED |
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 REQUIRED |
The date from which Stitch should begin replicating data from Heap. 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: |
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"
}
The Help Scout source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted. A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info. Note: If neither a Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Help Scout. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Help Scout. 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: |
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"
}
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.
client_id
STRING REQUIRED |
Your Help Scout OAuth application client ID. |
client_secret
STRING REQUIRED |
Your Help Scout OAuth application client secret. |
refresh_token
STRING REQUIRED |
A long-lived token that can be used to retrieve new |
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>"
}
The Heroku source connection property object
Heroku connections read data from Heroku databases and correspond to source type: platform.heroku_pg
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
dbname
STRING REQUIRED |
The name of the logical database to connect to. |
filter_dbs
STRING INTERNAL |
This is an internal field and is for Stitch use only. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Heroku. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
host
STRING REQUIRED |
The IP address or hostname of the database server. |
include_schemas_in_destination_stream_name
STRING REQUIRED |
If For more info, refer to the Database Integration Table Name Collisions guide. |
itersize
STRING INTERNAL |
This is an internal field and is for Stitch use only. |
password
STRING REQUIRED |
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 REQUIRED |
The port of the database server. The default is |
ssl
STRING OPTIONAL |
If |
user
STRING REQUIRED |
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>"
}
The HubSpot source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
HubSpot source form properties
Form properties are used to complete the form
step in source configuration.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from HubSpot. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from HubSpot. 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: |
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"
}
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.
client_id
STRING REQUIRED |
Your HubSpot OAuth application client ID. |
client_secret
STRING REQUIRED |
Your HubSpot OAuth application client secret. |
redirect_uri
STRING REQUIRED |
The URL that the user will be redirected to after they authorize your app for the requested scopes. |
refresh_token
STRING REQUIRED |
If exchanging a code with HubSpot, a long-lived token that can be used to retrieve new |
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>"
}
The iLEVEL source connection property object
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from iLEVEL. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
is_sandbox
STRING OPTIONAL |
If |
password
STRING REQUIRED |
The iLEVEL API user’s password. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from iLEVEL. 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: |
username
STRING REQUIRED |
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>"
}
The Impact source connection property object
Impact connections read data from the Impact API and correspond to source type: platform.impact
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
account_sid
STRING REQUIRED |
The read-only version of your Impact Account SID. Refer to the Impact documentation for instructions on locating this info. |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_catalog
STRING REQUIRED |
The internal Impact API you’re using for the Stitch Impact integration. Currently the only supported option is |
auth_token
STRING REQUIRED |
The read-only version of your Impact Auth Token. Refer to the Impact documentation for instructions on locating this info. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Impact. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
model_id
STRING/INTEGER OPTIONAL |
Identifies the conversion process and the necessary steps from click to conversion. It is an optional parameter for the |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Impact. 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: |
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"
}
The Import API source connection property object
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"
The Intacct source connection property object
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 in the properties
argument for Creating or Updating a Source.
account_id
STRING REQUIRED |
Your Amazon Web Services account ID. Refer to the Intacct documentation for instructions on retrieving this info. |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
bucket
STRING REQUIRED |
The name of the bucket Stitch should replicate Intacct data from. This value should only include the bucket name: No URLs, |
company_id
STRING REQUIRED |
Your Intacct company ID, used to sign into Intacct. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
external_id
STRING REQUIRED |
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 OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Intacct. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
path
STRING OPTIONAL |
Optional: The path configured in Intacct for use in the S3 bucket. |
role_name
STRING REQUIRED |
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 REQUIRED |
The date from which Stitch should begin replicating data from Intacct. 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: |
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"
}
The Invoiced source connection property object
Invoiced connections read data from the Invoiced API and correspond to source type: platform.invoiced
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_key
STRING REQUIRED |
Your Invoiced API key. Refer to the Invoiced documentation for instructions on generating this credential. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Invoiced. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
sandbox
STRING OPTIONAL |
If |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Invoiced. 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: |
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"
}
The Jira source connection property object
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 in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
base_url
STRING REQUIRED |
The base URL for the user’s Jira instance. Note: If connecting a self-managed (hosted) instance, the server must use the |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Jira. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
password
STRING REQUIRED |
Depending on the type of Jira instance being connected, this value should be one of the following:
|
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Jira. 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: |
username
STRING REQUIRED |
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"
}
The Klaviyo source connection property object
Klaviyo connections read data from and correspond to source type: platform.klaviyo
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_key
STRING REQUIRED |
Your Klaviyo API Key. Refer to the Klaviyo documentation for info on retrieving this credential. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Klaviyo. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Klaviyo. 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: |
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"
}
The Kustomer source connection property object
Kustomer connections read data from the Kustomer API and correspond to source type: platform.kustomer
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_token
STRING REQUIRED |
Your API key. Refer to the Kustomer documentation for instructions on obtaining this. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
date_window_size
STRING OPTIONAL |
This is an internal field for Stitch use. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Kustomer. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
page_size_limit
STRING OPTIONAL |
This is an internal field for Stitch use. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Kustomer. 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: |
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"
}
The Lever source connection property object
Lever connections read data from the Lever API and correspond to source type: platform.lever
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Lever. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Lever. 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: |
token
STRING REQUIRED |
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>"
}
The Listrak source connection property object
Listrak connections read data from the Listrak API and correspond to source type: platform.listrak
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted. A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info. Note: If neither a Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Listrak. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
password
STRING REQUIRED |
The password associated with the Listrak user. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Listrak. 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: |
username
STRING REQUIRED |
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":"<PASSWORD>",
"start_date":"2018-01-10T00:00:00Z",
"username":"<USERNAME>"
}
The LivePerson source connection property object
LivePerson connections read data from the LivePerson Data Access API
and correspond to source type: platform.liveperson
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
access_token
STRING REQUIRED |
Your LivePerson API access token. Refer to the LivePerson documentation for instructions on creating this credential. |
access_token_secret
STRING REQUIRED |
Your LivePerson API access token secret. Refer to the LivePerson documentation for instructions on creating this credential. |
account_id
STRING REQUIRED |
Your LivePerson account ID. |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
app_key
STRING REQUIRED |
Your LivePerson API app key. Refer to the LivePerson documentation for instructions on creating this credential. |
app_secret
STRING REQUIRED |
Your LivePerson API app secret. Refer to the LivePerson documentation for instructions on creating this credential. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from LivePerson. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from LivePerson. 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: |
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"
}
The Looker source connection property object
Looker connections read data from the Looker API and correspond to source type: platform.looker
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_port
STRING REQUIRED |
The Looker API Port number. This value will be |
api_version
STRING REQUIRED |
The Looker API version. This value will be |
client_id
STRING REQUIRED |
The client ID portion of your Looker API3 Key. Refer to the Looker documentation for instructions on obtaining this information. |
client_secret
STRING REQUIRED |
The client secret portion of your Looker API3 Key. Refer to the Looker documentation for instructions on obtaining this information. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
domain
STRING REQUIRED |
The domain of your Looker URL. This value is typically |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Looker. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Looker. 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: |
subdomain
STRING REQUIRED |
The subdomain of your Looker URL. This is the leading part of your Looker URL. For example: If the URL is |
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>"
}
The MailChimp source connection property object
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:
-
Form properties: Required to create the source and complete the source's
form
step. - OAuth properties: Required only if you're performing OAuth for this source yourself. Refer to the Performing OAuth with Stitch Connect guide for more info.
MailChimp source form properties
Form properties are used to complete the form
step in source configuration.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from MailChimp. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
page_size
STRING OPTIONAL |
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 REQUIRED |
The date from which Stitch should begin replicating data from MailChimp. 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: |
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"
}
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.
access_token
STRING REQUIRED |
The MailChimp token to use in future requests to the MailChimp API, created after a successful OAuth handshake. |
client_id
STRING REQUIRED |
Your MailChimp OAuth application’s client ID. |
client_secret
STRING REQUIRED |
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>"
}
The Mailshake source connection property object
Mailshake connections read data from the Mailshake API and correspond to source type: platform.mailshake
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
api_key
STRING REQUIRED |
Your Mailshake API key. Refer to the Mailshake documentation for instructions on retrieving this credential. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Mailshake. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Mailshake. 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: |
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"
}
The Mambu source connection property object
Mambu connections read data from the Mambu API and correspond to source type: platform.mambu
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from Mambu. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
password
STRING REQUIRED |
The password for the Mambu user account. |
start_date
STRING REQUIRED |
The date from which Stitch should begin replicating data from Mambu. 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: |
subdomain
STRING REQUIRED |
The subdomain of the Mambu account. |
username
STRING REQUIRED |
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>"
}
The MariaDB source connection property object
MariaDB connections read data from MariaDB databases and correspond to source type: platform.mariadb
.
Note: Attributes marked as REQUIRED must be provided in the properties
argument for Creating or Updating a Source.
allow_non_auto_increment_pks
STRING OPTIONAL |
If Unless set, this property will default to |
anchor_time
STRING OPTIONAL |
Defines the time that 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. For example: You want to create a schedule that is anchored to Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
cron_expression
STRING OPTIONAL |
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 Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
database
STRING OPTIONAL |
The name of the logical database to connect to. |
filter_dbs
STRING INTERNAL |
This is an internal field and is for Stitch use only. |
frequency_in_minutes
STRING OPTIONAL |
Defines how often, in minutes, Stitch should attempt to replicate data from MariaDB. Accepted values are:
Refer to the Replication Scheduling for API sources guide for more info about replication scheduling using the API. |
host
STRING REQUIRED |
The IP address or hostname of the database server. |
password
STRING REQUIRED |
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 REQUIRED |
The port of the database server. The default is |
server_id
STRING OPTIONAL |
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 OPTIONAL |
If |
ssh_host
STRING OPTIONAL |
The IP address or hostname of the SSH server. This property is only required if |
ssh_port
STRING OPTIONAL |
The port of the SSH server. This property is only required if |
ssh_user
STRING OPTIONAL |
The username of the SSH user. This property is only required if |
ssl
STRING OPTIONAL |
If |
use_log_based_replication
STRING OPTIONAL |
If |
user
STRING REQUIRED |
The username of the database user. |
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 *",
"database":"<DATABASE_NAME>",
"filter_dbs":"",
"frequency_in_minutes":"30",
"host":"<HOST_ADDRESS>",
"password":"<PASSWORD>",
"port":"3306",
"server_id":"<UNIQUE_SERVER_ID>",
"ssh":"true",
"ssh_host":"<SSH_HOST>",
"ssh_port":"22",
"ssh_user":"<SSH_USERNAME>",
"ssl":"false",
"use_log_based_replication":"true",
"user":"<USERNAME>"
}