Introduction

The Stitch Connect API enables you to seamlessly integrate Stitch’s data pipeline functionality into your own platform. 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 and access Stitch client accounts
  • Create and update destinations
  • Create and update data sources

Accessing the API

To use the API, you’ll need partner credentials. These are necessary for authenticating successfully.

To request access, please complete and submit this form.

Terminology

Stitch client account

An individual account for the Stitch web application.

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

Connection check

A test performed by Stitch that checks the configuration of a source’s connection parameters.

Structure sync

The first step in the replication process, this process will detect the tables and columns available in the source, along with any changes to the structure of those tables and columns.


Quick Start

Step 1: Register as an API Client

Request access by completing this form. Once approved, you’ll receive a partner_id and partner_key for authenticating your API calls.

Step 2: Obtain an Access Token

After you receive your partner_id and partner_key, you’ll need to obtain an access token. Calls to the API are authenticated with an access token associated with a Stitch account. Your application can get an access token in one of two ways:

Either method will provide your application with an access token and a Stitch client ID. This information should be stored somewhere safe and passed into the header of every API request for the Stitch client’s account. The token will never expire, but the user may revoke access at any time.

Keep in mind that Stitch client accounts are both owned and managed by the users themselves. For more information on authenticating with the API, refer to the Authentication guide.

Step 3: Create a Destination

If you’re providing a destination for the Stitch client’s account, we recommend connecting the destination immediately after the account is created. This ensures that Stitch will have a place to load replicated data as soon as data sources are added.

The first step to creating a destination is providing the attributes required for the destination’s configuration, or form. These attributes are passed in the body of your request as the connection argument, along with the destination’s type:

curl -X POST https://api.stitchdata.com/v3/destinations
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
     -d "{
          "type":"redshift",
          "connection": {
            "host": "<HOST>",
            "port": 5439,
            "username": "<USERNAME>",
            "database": "<DATABASE>",
            "password": "<PASSWORD>",
            "ssl": false
            }
         }"

Refer to the Destination Form Properties object to retrieve the attributes required for the connection argument for each destination type. Note: Each destination has its own unique configuration and set of form attributes.

Step 4: Create a Source

Source creation is performed through a sequence of connection steps. The required steps and the order of those steps are unique to the source type and are defined in its Report Card object. All source creation, however, begins at the form step.

In the example below, we’ll use the Source Types endpoint to retrieve the source form properties for HubSpot, which has a type of platform.hubspot.

Step 4.1: Get the Source's Report Card

Using the Source Types endpoint, retrieve the report card for platform.hubspot:

curl -X GET https://api.stitchdata.com/v4/source-types/platform.hubspot
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

The response, or the report card for platform.hubspot, will include HubSpot’s Source Form Properties. These are the parameters that are required to complete a source’s form step.

Step 4.2: Locate Required Form Properties in the Report Card

Use the response from the previous step to locate the required properties for the form step.

Note: You do not have to provide system-provided properties to create a source.

{  
   "type":"platform.hubspot",
   "current_step":1,
   "current_step_hints":{  
      "api":{  
         "method":"POST",
         "url":"/v4/sources"
      },
      "js":{  
         "function":"addSource",
         "options":{  
            "type":"platform.hubspot"
         }
      }
   },
   "steps":[  
      {  
         "type":"form",                                 /* form step */
         "properties":[
            {  
               "name":"image_version",                  /* system-provided property */
               "required_to_be_fully_configured":true,
               "provided":false,
               "is_credential":false,
               "system_provided":true
            },
            {  
               "name":"frequency_in_minutes",           /* required property */
               "required_to_be_fully_configured":true,
               "provided":false,
               "is_credential":false,
               "system_provided":false
            },
            {  
               "name":"start_date",                     /* required property */
               "required_to_be_fully_configured":true,
               "provided":false,
               "is_credential":false,
               "system_provided":false
            }
         ]
      },
      {  
         "type":"oauth",
         "properties":[...]
      },
      {  
         "type":"discover_schema",
         "properties":[ ]
      },
      {  
         "type":"field_selection",
         "properties":[ ]
      },
      {  
         "type":"fully_configured",
         "properties":[ ]
      }
   ]
}

For platform.hubspot, the frequency_in_minutes and start_date properties must be provided to complete the form step.

Step 4.3: Create the Source

Now that the required properties for HubSpot have been retrieved, we can create the HubSpot source:

  curl -X POST https://api.stitchdata.com/v4/sources
       -H "Authorization: Bearer <ACCESS_TOKEN>" 
       -H "Content-Type: application/json"
       -d "{  
               "type":"platform.hubspot",
               "display_name":"HubSpot",
               "properties":{  
                  "start_date":"2018-01-01T00:00:00Z",
                  "frequency_in_minutes":"30"
               }
            }"

If successful, the API will return a 200 OK status and a Source object with a report_card property:

{
   "properties":{
      "frequency_in_minutes":"30",
      "image_version":"1.latest",
      "start_date":"2018-01-01T00:00:00Z"
   },
   "updated_at":"2018-02-06T16:25:06Z",
   "check_job_name":null,
   "name":"hubspot",
   "type":"platform.hubspot",
   "deleted_at":null,
   "system_paused_at":null,
   "stitch_client_id":<ACCOUNT_ID>,
   "paused_at":null,
   "id":45612,                                          /* Source ID */
   "display_name":"HubSpot",
   "created_at":"2018-02-06T16:25:06Z",
   "report_card":{
      "type":"platform.hubspot",
      "current_step":2,
      "steps":[
         {
            "type":"form",
            "properties":[
               {
                  "name":"image_version",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {
                  "name":"start_date",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         },
         {
            "type":"oauth",
            "properties":[
               {
                  "name":"client_id",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"client_secret",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"redirect_uri",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string",
                     "format":"uri"
                  }
               },
               {
                  "name":"refresh_token",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               }
            ]
         },
         {
            "type":"discover_schema",
            "properties":[ ]
         },
         {
            "type":"field_selection",
            "properties":[ ]
         },
         {
            "type":"fully_configured",
            "properties":[ ]
         }
      ],
      "current_step_hints":{
         "js":{
            "function":"authorizeSource",
            "options":{
               "id":45612
            }
         }
      }
   }
}

After a source’s form is created, the report_card object within the source should be used to complete its configuration.

Step 4.4: Identify the Current Step

The Report Card object provides information about the steps required to configure the connection, their sequence, and the progress towards completing the steps.

Looking at the report card for our HubSpot source, we can see that we’re now on step 2 of configuration, which is the oauth step:

{
   "current_step_hints":{
      "js":{
         "function":"authorizeSource",
         "options":{
            "id":45612
         }
      }
   },
   "report_card":{
      "type":"platform.hubspot",
      "current_step":2,                                           /* Current step */
      "steps":[
         {
            "type":"form",
            "properties":[ ... ]
         },
         {
            "type":"oauth",
            "properties":[
               {
                  "name":"client_id",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"client_secret",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"redirect_uri",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string",
                     "format":"uri"
                  }
               },
               {
                  "name":"refresh_token",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               }
            ]
         },
         {
            "type":"discover_schema",
            "properties":[ ]
         },
         {
            "type":"field_selection",
            "properties":[ ]
         },
         {
            "type":"fully_configured",
            "properties":[ ]
         }
      ]
   }
}

Now that we know what step we need to complete next, we can use the current_step_hints object to identify how to complete the step:

{
   "current_step_hints":{
      "js":{
         "function":"authorizeSource",
         "options":{
            "id":45612
         }
      }
   }
}

In this case, we need to use the Connect JavaScript Client to initiate and complete the OAuth step required for platform.hubspot:

  • The function attribute contains the JavaScript client function required to complete the step, and
  • The options object contains the source’s ID, which we need to pass to the JavaScript client to complete the OAuth flow

Step 5: Use the Connect JavaScript Client to Complete Source Configuration

To initiate the OAuth flow, use the authorizeSource function in the Connect JavaScript Client. This function expects an options argument containing the source’s id:

Stitch.authorizeSource({
    "id": 45612
}).then((result) => {
    console.log(`Integration created, type=${result.type}, id=${result.id}`);
}).catch((error) => {
    console.log("Integration not created.", error);
});

This function will send the user to Stitch, where they will be prompted to sign into their Stitch account and grant access to HubSpot.

After the user grants access, Stitch will automatically prompt the user to complete the remaining steps to configure the source, including selecting table and field for replication.


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 -X GET https://api.stitchdata.com/v4/sources
     -H "Authorization: Bearer <ACCESS_TOKEN>"

Before you can make requests, you must complete this form. Once approved, you’ll receive the credentials required to authenticate your API calls.

All requests must be made over HTTPS or they will fail. API requests that don’t contain authentication will also fail.

Generate Access Tokens

Access tokens are obtained by performing an OAuth2 handshake with an existing Stitch client account or by creating a new account via the API.

New Stitch Clients

As an API client, you can create a new Stitch client account with the Create Account endpoint:

curl -X POST https://api.stitchdata.com/v3/accounts
     -H "Content-Type: application/json"
     -d "{
          "email": "stitch-api-test@stitchdata.com",
          "last_name": "Product Team",
          "partner_id": "<PARTNER_ID>",
          "first_name": "Stitch",
          "partner_secret": "<PARTNER_SECRET>",
          "company": "Stitch Product Team"
        }"

When successful, this endpoint return a status of 200 OK and an access token:

{
  "access_token":"<ACCESS_TOKEN>"
}

The created account is owned and managed by the user it is created for, and that user will be able to login to the Stitch web interface and receive emails from Stitch.

Existing Stitch Clients, Using OAuth2

You can connect to a user’s existing Stitch client account by having the user complete a standard OAuth flow. Registering your application with Stitch is a prerequisite to generating tokens with OAuth, so do that first. Then, follow these steps to complete the OAuth flow:

Step 1: Send the user to Stitch

To initiate the authorization flow, the user will click a link to Stitch that includes your application’s API client ID. This is the partner_id you obtained when you registered your application:

https://app.stitchdata.com/oauth/authorization?client_id={CLIENT_ID}

While only your client_id (partner_id) is required, the URL may also include the following parameters:

client_id
REQUIRED

Your application’s client ID. This is the partner_id that is obtained when your API access request is approved.

redirect_uri
OPTIONAL

The callback URL for your application, which will be used in Step 3.

Note: If provided in Step 1 as a URL parameter, then the value must match one of the redirect URIs provided with your application’s registration.

If not provided in Step 1 as a URL parameter, Stitch will fallback to the first redirect_uri associated with your API client.

email
OPTIONAL

The email address of the Stitch client owner. If provided, this value will be used to pre-populate the signup form.

first_name
OPTIONAL

The user’s first name. If provided, this value will be used to pre-populate the signup form.

last_name
OPTIONAL

The user’s last name. If provided, this value will be used to pre-populate the signup form.

company
OPTIONAL

The name of the company or organization to associate with the Stitch client account. If provided, this value will be used to pre-populate the signup form.

If the user isn’t already logged into their Stitch client account, they will be prompted to do so or create a new account, if need be.

Once logged in, the user will be shown a screen explaining that your application has requested access to their Stitch account. They will be prompted to accept or reject this request.

Step 3: Callback to your application

When the user accepts or denies the request, they will be re-directed to the callback URL you provided when you registered your application with Stitch.

If the user denies the request, Stitch will include error details:

https://yourapplication.com/callback?error=access_denied

If the user accepts the request, the callback will include a temporary authorization code to be used in the next step:

https://yourapplication.com/callback?code=AUTHORIZATION_CODE
Step 4: Exchange tokens

Lastly, when your application receives the user’s request to the callback URL, it should make a request to the Stitch OAuth URL to exchange the temporary authorization code for a permanent access token:

curl https://api.stitchdata.com/oauth/token 
     -d client_secret=<CLIENT_SECRET>
     -d code=<AUTHORIZATION_CODE>
     -d grant_type=authorization_code

Note: Each temporary authorization code can only be used once and will expire five minutes after creation.

If successful, Stitch will respond with the following:

{
  "token_type": "bearer",
  "access_token": <ACCESS_TOKEN>,
  "stitch_account_id": <STITCH_ACCOUNT_ID>
}

Your application should store the access_token and stitch_account_id somewhere secure, and use them to make calls to the API:

curl GET https://api.stitchdata.com/v4/sources
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response Codes

The API will attempt to return HTTP status codes for every request.

Code Text Description
200

OK

Success!

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:

  • The URI requested is invalid
  • The requested resource, such as a specific source, doesn’t exist
  • Method is not allowed by the endpoint
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.


Versioning

The API is currently versioned by object.

Object Version Endpoints
Account v3
Session v3
Destination v3
Source Type v4
Source v4

Core Objects

Accounts

OBJECT Account Object

An object representing a Stitch client account.

POST /v3/accounts

Creates a new Stitch client account and receives an API access token in return.


OBJECT

The Account Object

An object representing a Stitch client account.

company
STRING

A name for the Stitch client. This is typically the name of the company using the Stitch client account.

email
STRING

The email address of the user signing up for a Stitch client account. Upon successful account creation, Stitch will send an email to this address with instructions for completing the setup.

first_name
STRING

The first name of the user signing up for a Stitch client account.

last_name
STRING

The last name of the user signing up for a Stitch client account.

partner_id
STRING

The unique ID for your API client, obtained when you register to use the API.

partner_secret
STRING

The secret for your API client, obtained when you registered to use the API.


POST

/v3/accounts

Creates a new Stitch client account and receives an API access token in return.

Before creating a Stitch account, you’ll need to request access to the API and obtain partner credentials by submitting this form to our team.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Request Body

The request body must be valid JSON and contain the required arguments.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Errors

See the Errors tab, below.

Arguments

This endpoint accepts the following parameters:

company
STRING
REQUIRED

A name for the Stitch client. This is typically the name of the company using the Stitch client account.

email
STRING
REQUIRED

The email address of the user signing up for a Stitch client account. Upon successful account creation, Stitch will send an email to this address with instructions for completing the setup.

first_name
STRING
REQUIRED

The first name of the user signing up for a Stitch client account.

last_name
STRING
REQUIRED

The last name of the user signing up for a Stitch client account.

partner_id
STRING
REQUIRED

The unique ID for your API client, obtained when you register to use the API.

partner_secret
STRING
REQUIRED

The secret for your API client, obtained when you registered to use the API.

Returns

If successful, the API will return a status of 200 OK and an access_token property containing an API access token for the Stitch client’s account will be returned.

Otherwise, an error will be returned. For example: If a Stitch client account associated with the user already exists, the request will return This email address is already associated with an active user. See the Errors tab below for additional possibilities.

curl -X POST https://api.stitchdata.com/v3/accounts
     -H "Content-Type: application/json"
     -d "{
          "email": "stitch-api-test@stitchdata.com",
          "last_name": "Product Team",
          "partner_id": "<PARTNER_ID>",
          "first_name": "Stitch",
          "partner_secret": "<PARTNER_SECRET>",
          "company": "Stitch Product Team"
        }"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

{
  "access_token":"<ACCESS_TOKEN>"
}
Code Condition Response Body
400

A Stitch account is already associated with the provided email address.

{
  "code":"ExistingUser",
  "message":"This email address is already associated with an active user."
}
400

Request body contains malformed data.

{
  "code":"BadRequest",
  "message":"Invalid form data.",
  "errors":{}
}


Sessions

OBJECT Session Object

This object represents a browser session in the Stitch web application.

POST /v3/sessions/ephemeral

Generates an ephemeral token to create a session in the Stitch web application. Ephemeral tokens expire after one hour.


OBJECT

The Session Object

This object represents a browser session in the Stitch web application.

ephemeral_token
STRING

A token that is passed to the Connect JavaScript Client to create a session.


POST

/v3/sessions/ephemeral

Generates an ephemeral token to create a session in the Stitch web application. Ephemeral tokens expire after one hour.

Ephemeral tokens are used to create a session with the Connect JavaScript client. The session will be for the user for whom the API access token was created.

After the ephemeral token is used to create a session, the created session will expire once terminated or after 12 hours.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Returns

If successful, the API will return a status of 200 OK and a Session object.

curl -X POST https://api.stitchdata.com/v3/sessions/ephemeral
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

{
  "ephemeral_token":"<EPHEMERAL_TOKEN>"
}


Destinations

OBJECT Destination Object

An object representing a destination. Destinations are the data warehouses into which Stitch writes data.

POST /v3/destinations

Creates a new destination.

PUT /v3/destinations/{id}

Updates an existing destination. Modifications to the type attribute are not supported.

GET /v3/destinations

Lists the destination currently in use for a Stitch account.


OBJECT

The Destination Object

An object representing a destination. Destinations are the data warehouses into which Stitch writes data.

id
INTEGER

A unique identifier for this destination.

connection
OBJECT (DESTINATION FORM PROPERTIES)

Parameters for connecting to the destination, excluding any sensitive credentials.

The parameters must adhere to the type of destination.

created_at
TIMESTAMP

The time at which the destination object was created.

last_check
OBJECT (CONNECTION CHECK)

The status and results of the most recent check run for this destination connection.

type
STRING

The destination type. Must be one of:

  • redshift
  • postgres
  • snowflake
updated_at
TIMESTAMP

The time at which the destination object was last updated.


POST

/v3/destinations

Creates a new destination. Only a single destination is supported per Stitch client account.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Request Body

The request body must be valid JSON and contain the required arguments.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Errors

See the Errors tab, below.

Arguments

This endpoint accepts the following parameters:

type
STRING
REQUIRED

The destination type. Must be one of:

  • redshift
  • postgres
  • snowflake
connection
OBJECT
REQUIRED

A Destination Form Properties object corresponding to the value of type.

Returns

If successful, the API will return a status of 200 OK and a Destination object.

curl -X POST https://api.stitchdata.com/v3/destinations
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
     -d "{
          "type":"redshift",
          "connection": {
            "host": "<HOST>",
            "port": 5439,
            "username": "<USERNAME>",
            "database": "<DATABASE>",
            "password": "<PASSWORD>",
            "ssl": false
            }
         }"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

{
  "id":"<DESTINATION_ID>",
  "type":"redshift",
  "created_at":"2018-02-06T15:36:36Z",
  "updated_at":"2018-02-06T15:36:36Z",
  "connection": {
      "host":"<HOST>",
      "port":5439,
      "username":"<USERNAME>",
      "database":"<DATABASE>",
      "password":"<PASSWORD>",
      "ssl":false
  },
  "last_check":{
      "error": false,
      "started_at":"2018-02-06T16:15:19Z",
      "completed_at":"2018-02-06T16:16:21Z"
  }
}
Code Condition Response Body
400

Accounts can have one destination

an account can have at most one destination

400

Missing or prohibited arguments

body must be a map with type = redshift, postgres, or snowflake. required-keys = type, connection


PUT

/v3/destinations/{id}

Updates an existing destination. Modifications to the type attribute are not supported.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Request Body

The request body must be valid JSON and contain the required arguments.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Errors

See the Errors tab, below.

Arguments

This endpoint accepts the following parameters:

id
PATH PARAMETER
REQUIRED

A path parameter corresponding to the unique ID of the destination to be updated.

type
STRING
REQUIRED

The destination type. Must be one of:

  • redshift
  • postgres
  • snowflake
connection
OBJECT
REQUIRED

A Destination Form Properties object corresponding to the value of type.

Returns

If successful, the API will return a status of 200 OK and a Destination object.

curl -X PUT https://api.stitchdata.com/v3/destinations/{id}
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
     -d "{
          "type":"postgres",
          "connection": {
            "host": "<HOST>",
            "port": 5432,
            "username": "<USERNAME>",
            "database": "<DATABASE>",
            "password": "<PASSWORD>",
            "ssl": false
            }
        }"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

{
  "id":"<DESTINATION_ID>",
  "type":"postgres",
  "created_at":"2018-02-06T15:36:36Z",
  "updated_at":"2018-02-06T18:55:43Z",
  "connection": {
      "host":"<HOST>",
      "port":5432,
      "username":"<USERNAME>",
      "database":"<DATABASE>",
      "password":"<PASSWORD>",
      "ssl":false
  },
  "last_check":{
      "error": false,
      "started_at":"2018-02-06T16:15:19Z",
      "completed_at":"2018-02-06T16:16:21Z"
  }
}
Code Condition Response Body
400

Modifications to type are unsupported

this API endpoint does not support modifying destination type

400

Invalid destination ID

invalid connection id


GET

/v3/destinations

Lists the destination currently in use for a Stitch account. Only a single data warehouse is supported per Stitch client account.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Returns

If successful, the API will return a status of 200 OK and an array (of length zero or one) of Destination objects.

curl -X GET https://api.stitchdata.com/v3/destinations
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

[
  {  
    "id":"<DESTINATION_ID>",
    "type":"redshift",
    "created_at":"2018-02-06T15:36:36Z",
    "updated_at":"2018-02-06T15:36:36Z",
    "connection": {  
        "host":"<HOST>",
        "port":5439,
        "username":"<USERNAME>",
        "database":"<DATABASE>",
        "password":"<PASSWORD>",
        "ssl":false
    },
    "last_check":{
      "error": false,
      "started_at":"2018-02-06T16:15:19Z",
      "completed_at":"2018-02-06T16:16:21Z"
    }
  }
]


Source Types

OBJECT Source Type Object

The Source Type object contains the information needed to configure a data source.

GET /v4/source-types/{type}

Retrieves general information about the configuration required for a data source type.

GET /v4/source-types

Retrieves general information about the configuration required for all support data source types.


OBJECT

The Source Type Object

The Source Type object contains the information needed to configure a data source.

report_card
OBJECT (REPORT CARD)

The Report Card object corresponding to the source’s type. For example: platform.marketo or platform.hubspot.


GET

/v4/source-types/{type}

Retrieves general information about the configuration required for a data source type.

Note: This endpoint doesn’t retrieve information about the specific configuration of sources in a single account. Instead, it will return general configuration information for the specified type.

To retrieve information about a specific data source, use the Get a Source endpoint.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Request Body

The request body must be valid JSON and contain the required arguments.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Arguments

This endpoint accepts the following parameters:

type
STRING
REQUIRED

A path parameter indicating the type of source to retrieve, such as platform.marketo or platform.hubspot.

Returns

If successful, the API will return a status of 200 OK and a Report Card object corresponding to type.

curl -X GET https://api.stitchdata.com/v4/source-types/{type}
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

{  
   "type":"platform.hubspot",
   "current_step":1,
   "current_step_hints":{  
      "api":{  
         "method":"POST",
         "url":"/v4/sources"
      },
      "js":{  
         "function":"addSource",
         "options":{  
            "type":"platform.hubspot"
         }
      }
   },
   "steps":[  
      {  
         "type":"form",
         "properties":[  
            {  
               "name":"image_version",
               "is_required":true,
               "provided":false,
               "is_credential":false,
               "system_provided":true,
               "json_schema":null
            },
            {  
               "name":"frequency_in_minutes",
               "is_required":true,
               "provided":false,
               "is_credential":false,
               "system_provided":false,
               "json_schema":{  
                  "type":"string",
                  "pattern":"^\\d+$"
               }
            },
            {  
               "name":"start_date",
               "is_required":true,
               "provided":false,
               "is_credential":false,
               "system_provided":false,
               "json_schema":{  
                  "type":"string",
                  "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
               }
            }
         ]
      },
      {  
         "type":"oauth",
         "properties":[  
            {  
               "name":"client_id",
               "is_required":true,
               "provided":false,
               "is_credential":true,
               "system_provided":true,
               "json_schema":{  
                  "type":"string"
               }
            },
            {  
               "name":"client_secret",
               "is_required":true,
               "provided":false,
               "is_credential":true,
               "system_provided":true,
               "json_schema":{  
                  "type":"string"
               }
            },
            {  
               "name":"redirect_uri",
               "is_required":true,
               "provided":false,
               "is_credential":true,
               "system_provided":true,
               "json_schema":{  
                  "type":"string",
                  "format":"uri"
               }
            },
            {  
               "name":"refresh_token",
               "is_required":true,
               "provided":false,
               "is_credential":true,
               "system_provided":true,
               "json_schema":{  
                  "type":"string"
               }
            }
         ]
      },
      {  
         "type":"discover_schema",
         "properties":[  ]
      },
      {  
         "type":"field_selection",
         "properties":[  ]
      },
      {  
         "type":"fully_configured",
         "properties":[  ]
      }
   ]
}

GET

/v4/source-types

Retrieves general information about the configuration required for all support data source types.

Note: This endpoint doesn’t retrieve information about the specific configuration of sources in a single account. Instead, it will return general configuration information for all supported source types.

To retrieve specific information about all data sources for an account, use the List Sources endpoint.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Returns

If successful, the API will return a status of 200 OK and an array of Report Card objects, one for each supported source type.

curl -X GET https://api.stitchdata.com/v4/source-types
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

[  
   {  
      "type":"platform.hubspot",                                /* HubSpot source */
      "current_step":1,
      "current_step_hints":{  
         "api":{  
            "method":"POST",
            "url":"/v4/sources"
         },
         "js":{  
            "function":"addSource",
            "options":{  
               "type":"platform.hubspot"
            }
         }
      },
      "steps":[  
         {  
            "type":"form",
            "properties":[  
               {  
                  "name":"image_version",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {  
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"start_date",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         },
         {  
            "type":"oauth",
            "properties":[  
               {  
                  "name":"client_id",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"client_secret",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"redirect_uri",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{  
                     "type":"string",
                     "format":"uri"
                  }
               },
               {  
                  "name":"refresh_token",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{  
                     "type":"string"
                  }
               }
            ]
         },
         {  
            "type":"discover_schema",
            "properties":[  ]
         },
         {  
            "type":"field_selection",
            "properties":[  ]
         },
         {  
            "type":"fully_configured",
            "properties":[  ]
         }
      ]
   },
   {  
      "type":"platform.marketo",                                /* Marketo source */
      "current_step":1,
      "current_step_hints":{  
         "api":{  
            "method":"POST",
            "url":"/v4/sources"
         },
         "js":{  
            "function":"addSource",
            "options":{  
               "type":"platform.marketo"
            }
         }
      },
      "steps":[  
         {  
            "type":"form",
            "properties":[  
               {  
                  "name":"image_version",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {  
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"client_id",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"client_secret",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"endpoint",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "format":"uri"
                  }
               },
               {  
                  "name":"identity",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "format":"uri"
                  }
               },
               {  
                  "name":"max_daily_calls",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"start_date",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         },
         {  
            "type":"fully_configured",
            "properties":[  ]
         }
      ]
   },
   {  
      "type":"platform.zuora",                                  /* Zuora source */
      "current_step":1,
      "current_step_hints":{  
         "api":{  
            "method":"POST",
            "url":"/v4/sources"
         },
         "js":{  
            "function":"addSource",
            "options":{  
               "type":"platform.zuora"
            }
         }
      },
      "steps":[  
         {  
            "type":"form",
            "properties":[  
               {  
                  "name":"image_version",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {  
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"european",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^(true|false)$"
                  }
               },
               {  
                  "name":"password",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"sandbox",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^(true|false)$"
                  }
               },
               {  
                  "name":"start_date",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               },
               {  
                  "name":"username",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               }
            ]
         },
         {  
            "type":"discover_schema",
            "properties":[  ]
         },
         {  
            "type":"field_selection",
            "properties":[  ]
         },
         {  
            "type":"fully_configured",
            "properties":[  ]
         }
      ]
   },
   {  
      "type":"platform.salesforce",                             /* Salesforce source */
      "current_step":1,
      "current_step_hints":{  
         "api":{  
            "method":"POST",
            "url":"/v4/sources"
         },
         "js":{  
            "function":"addSource",
            "options":{  
               "type":"platform.salesforce"
            }
         }
      },
      "steps":[  
         {  
            "type":"form",
            "properties":[  
               {  
                  "name":"image_version",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {  
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"api_type",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^(REST|BULK)$"
                  }
               },
               {  
                  "name":"is_sandbox",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^(true|false)$"
                  }
               },
               {  
                  "name":"quota_percent_per_run",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"quota_percent_total",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"select_fields_by_default",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^(true|false)$"
                  }
               },
               {  
                  "name":"start_date",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         },
         {  
            "type":"oauth",
            "properties":[  
               {  
                  "name":"client_id",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"client_secret",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"instance_url",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "format":"uri"
                  }
               },
               {  
                  "name":"orgid",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"refresh_token",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               }
            ]
         },
         {  
            "type":"discover_schema",
            "properties":[  ]
         },
         {  
            "type":"field_selection",
            "properties":[  ]
         },
         {  
            "type":"fully_configured",
            "properties":[  ]
         }
      ]
   },
   {  
      "type":"platform.yotpo",                                  /* Yotpo source */
      "current_step":1,
      "current_step_hints":{  
         "api":{  
            "method":"POST",
            "url":"/v4/sources"
         },
         "js":{  
            "function":"addSource",
            "options":{  
               "type":"platform.yotpo"
            }
         }
      },
      "steps":[  
         {  
            "type":"form",
            "properties":[  
               {  
                  "name":"image_version",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {  
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"api_key",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"api_secret",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"start_date",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         },
         {  
            "type":"discover_schema",
            "properties":[  ]
         },
         {  
            "type":"field_selection",
            "properties":[  ]
         },
         {  
            "type":"fully_configured",
            "properties":[  ]
         }
      ]
   },
   {  
      "type":"platform.sendgrid",                               /* SendGrid source */
      "current_step":1,
      "current_step_hints":{  
         "api":{  
            "method":"POST",
            "url":"/v4/sources"
         },
         "js":{  
            "function":"addSource",
            "options":{  
               "type":"platform.sendgrid"
            }
         }
      },
      "steps":[  
         {  
            "type":"form",
            "properties":[  
               {  
                  "name":"image_version",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {  
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"api_key",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"start_date",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         },
         {  
            "type":"discover_schema",
            "properties":[  ]
         },
         {  
            "type":"field_selection",
            "properties":[  ]
         },
         {  
            "type":"fully_configured",
            "properties":[  ]
         }
      ]
   }
]


Sources

OBJECT Source Object

An object representing a data source. Sources are the databases, APIs, and other data applications that Stitch replicates data from. Sources can be retrieved in a list or individually by ID.

POST /v4/sources

Creates a source object, which is the first step in setting up a new data source.

PUT /v4/sources/{id}

Updates an existing data source.

GET /v4/sources

List the sources for an account, including active, paused, and deleted sources.

GET /v4/sources/{id}

Retrieves a previously created data source by its unique identifier.


OBJECT

The Source Object

An object representing a data source. Sources are the databases, APIs, and other data applications that Stitch replicates data from. Sources can be retrieved in a list or individually by ID.

id
INTEGER

The unique identifier for this source.

created_at
TIMESTAMP

The time at which the source object was created.

deleted_at
TIMESTAMP

The time at which the source object was deleted.

display_name
STRING

The display name of the source connection.

name
STRING

The name of the source connection, dynamically generated from display_name. The name corresponds to the destination schema name that the data from this source will be loaded into.

Names must:

  • Contain only lowercase alphanumerics and underscores
  • Be unique within each Stitch client account
paused_at
TIMESTAMP

If the connection was paused by the user, the time the pause began. Otherwise, or if the connection is active, this will be null.

properties
OBJECT (PROPERTIES)

A source Properties object corresponding to the value of type.

report_card
OBJECT (REPORT CARD)

A description of the source’s configuration state.

stitch_client_id
INTEGER

The ID of the Stitch client account.

system_paused_at
TIMESTAMP

If the connection was paused by the system, the time the pause began. Otherwise, or if the connection is active, this will be null.

type
STRING

The source type.

updated_at
TIMESTAMP

The time at which the object was last updated.


POST

/v4/sources

Creates a source object, which is the first step in setting up a new data source. After the source object is created, additional configuration steps must be completed.

The configuration process is unique for each type of source. Use the source’s report_card object’s current_step attribute to identify the current step in configuring the source.

The report_card object’s current_step_hints attribute will assist you in guiding the user to the Connect JavaScript Client to complete the current step.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Request Body

The request body must be valid JSON and contain the required arguments.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Errors

See the Errors tab, below.

Arguments

This endpoint accepts the following parameters:

display_name
STRING
REQUIRED

A descriptive name for the source. This will be used to dynamically generate the name corresponding to the schema name or dataset name that the data from this source will be loaded into.

type
STRING
REQUIRED

The source type. For example: platform.marketo or platform.hubspot.

properties
OBJECT
OPTIONAL

A source Properties object corresponding to the value of type.

Returns

If successful, the API will return a status of 200 OK and a Source object with a report_card property.

The report_card property contains the Report Card object for the source’s configuration status.

curl -X POST https://api.stitchdata.com/v4/sources
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
     -d "{
             "type":"platform.hubspot",
             "display_name":"HubSpot",
             "properties":{
                "start_date":"2017-01-01T00:00:00Z",
                "frequency_in_minutes":"30"
             }
          }"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

{
   "properties":{
      "frequency_in_minutes":"30",
      "image_version":"1.latest",
      "start_date":"2017-01-01T00:00:00Z"
   },
   "updated_at":"2018-02-06T16:25:06Z",
   "check_job_name":null,
   "name":"hubspot",
   "type":"platform.hubspot",
   "deleted_at":null,
   "system_paused_at":null,
   "stitch_client_id":<ACCOUNT_ID>,
   "paused_at":null,
   "id":<SOURCE_ID>,
   "display_name":"HubSpot",
   "created_at":"2018-02-06T16:25:06Z",
   "report_card":{
      "type":"platform.hubspot",
      "current_step":2,
      "steps":[
         {
            "type":"form",
            "properties":[
               {
                  "name":"image_version",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {
                  "name":"start_date",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         },
         {
            "type":"oauth",
            "properties":[
               {
                  "name":"client_id",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"client_secret",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"redirect_uri",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string",
                     "format":"uri"
                  }
               },
               {
                  "name":"refresh_token",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               }
            ]
         },
         {
            "type":"discover_schema",
            "properties":[ ]
         },
         {
            "type":"field_selection",
            "properties":[ ]
         },
         {
            "type":"fully_configured",
            "properties":[ ]
         }
      ],
      "current_step_hints":{
         "js":{
            "function":"authorizeSource",
            "options":{
               "id":<SOURCE_ID>
            }
         }
      }
   }
}
Code Condition Response Body
400

Source’s display_name is already in use

a source of name <NAME> already exists

400

Prohibited arguments

POST body may only include a type, a display_name and map of string properties

400

Invalid properties data

An array of the property names containing invalid data:

{
   "bad_properties":[
      "start_date",
      "frequency_in_minutes"
   ],
   ...
}

May result from incorrect formatting, incorrect typing (all property values must be strings), or a property has a value that is an empty string.


PUT

/v4/sources/{id}

Updates an existing data source.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Request Body

The request body must be valid JSON and contain the required arguments.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Errors

See the Errors tab, below.

Arguments

This endpoint accepts the following parameters:

id
PATH PARAMETER
REQUIRED

A path parameter corresponding to the unique ID of the source to be updated.

display_name
STRING
OPTIONAL

A descriptive name for the source. This will be used to dynamically generate the name corresponding to the schema name or dataset name that the data from this source will be loaded into.

properties
OBJECT
OPTIONAL

A source Properties object corresponding to the value of type.

Returns

If successful, the API will return a status of 200 OK and a Source object.

curl -X PUT https://api.stitchdata.com/v4/sources/{id}
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
     -d "{
             "display_name":"Salesforce",
             "properties":{
                "frequency_in_minutes":"60"
             }
         }"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

{
   "properties":{
      "frequency_in_minutes":"60",
      "image_version":"1.latest",
      "start_date":"2017-01-01T00:00:00Z"
   },
   "updated_at":"2018-02-06T17:37:14Z",
   "check_job_name":null,
   "name":"salesforce",
   "type":"platform.salesforce",
   "deleted_at":null,
   "system_paused_at":null,
   "stitch_client_id":<ACCOUNT_ID>,
   "paused_at":null,
   "id":<SOURCE_ID>,
   "display_name":"Salesforce",
   "created_at":"2018-02-06T17:36:02Z",
   "report_card":{
      "type":"platform.salesforce",
      "current_step":1,
      "steps":[
         {
            "type":"form",
            "properties":[
               {
                  "name":"image_version",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {
                  "name":"api_type",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^(REST|BULK)$"
                  }
               },
               {
                  "name":"is_sandbox",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^(true|false)$"
                  }
               },
               {
                  "name":"quota_percent_per_run",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {
                  "name":"quota_percent_total",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {
                  "name":"select_fields_by_default",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^(true|false)$"
                  }
               },
               {
                  "name":"start_date",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         },
         {
            "type":"oauth",
            "properties":[
               {
                  "name":"client_id",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"client_secret",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"instance_url",
                  "is_required":true,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "format":"uri"
                  }
               },
               {
                  "name":"orgid",
                  "is_required":false,
                  "provided":false,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"refresh_token",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string"
                  }
               }
            ]
         },
         {
            "type":"discover_schema",
            "properties":[  ]
         },
         {
            "type":"field_selection",
            "properties":[  ]
         },
         {
            "type":"fully_configured",
            "properties":[  ]
         }
      ],
      "current_step_hints":{
         "api":{
            "method":"PUT",
            "url":"/v4/sources/{id}"
         }
      }
   }
}
Code Condition Response Body
400

Invalid source ID

unable to locate source(<SOURCE_ID>) for client (<ACCOUNT_ID>) to update

400

Prohibited arguments

PUT body many only include the keys: display_name and properties

400

Invalid properties data

An array of the property names containing invalid data:

{
   "bad_properties":[
      "start_date",
      "frequency_in_minutes"
   ],
   ...
}

May result from incorrect formatting, incorrect typing (all property values must be strings), or a property has a value that is an empty string.


GET

/v4/sources

List the sources for an account, including active, paused, and deleted sources.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Returns

If successful, the API will return a status of 200 OK and an array of Source Objects, including paused and deleted sources.

curl -X GET https://api.stitchdata.com/v4/sources
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

[
   {
      "properties":{
         "frequency_in_minutes":"30",
         "image_version":"1.latest",
         "start_date":"2017-01-01T00:00:00Z"
      },
      "updated_at":"2018-02-06T18:04:59Z",
      "name":"hubspot_api_test",
      "type":"platform.hubspot",
      "deleted_at":"2018-02-06T18:04:58Z",
      "system_paused_at":null,
      "stitch_client_id":<ACCOUNT_ID>,
      "paused_at":null,
      "id":<SOURCE_ID>,
      "display_name":"HubSpot",
      "created_at":"2018-02-06T16:25:06Z",
      "report_card":{
         "type":"platform.hubspot",
         "current_step":2,
         "steps":[
            {
               "type":"form",
               "properties":[ ... ]
            },
            {
               "type":"oauth",
               "properties":[ ... ]
            },
            {
               "type":"discover_schema",
               "properties":[  ]
            },
            {
               "type":"field_selection",
               "properties":[  ]
            },
            {
               "type":"fully_configured",
               "properties":[  ]
            }
         ],
         "current_step_hints":{  
            "js":{
               "function":"authorizeSource",
               "options":{  
                  "id":<SOURCE_ID>
               }
            }
         }
      }
   },
   {  
      "properties":{
         "frequency_in_minutes":"30",
         "image_version":"1.latest",
         "start_date":"2017-01-01T00:00:00Z"
      },
      "updated_at":"2018-02-06T18:12:41Z",
      "name":"hubspot",
      "type":"platform.hubspot",
      "deleted_at":null,
      "system_paused_at":null,
      "stitch_client_id":<ACCOUNT_ID>,
      "paused_at":null,
      "id":<SOURCE_ID>,
      "display_name":"HubSpot",
      "created_at":"2018-02-06T18:12:41Z",
      "report_card":{
         "type":"platform.hubspot",
         "current_step":2,
         "steps":[  
            {
               "type":"form",
               "properties":[ ... ]
            },
            {
               "type":"oauth",
               "properties":[ ... ]
            },
            {
               "type":"discover_schema",
               "properties":[  ]
            },
            {
               "type":"field_selection",
               "properties":[  ]
            },
            {
               "type":"fully_configured",
               "properties":[  ]
            }
         ],
         "current_step_hints":{
            "js":{
               "function":"authorizeSource",
               "options":{  
                  "id":<SOURCE_ID>
               }
            }
         }
      }
   },
   {  
      "properties":{
         "frequency_in_minutes":"30",
         "image_version":"1.latest",
         "start_date":"2017-01-01T00:00:00Z"
      },
      "updated_at":"2018-02-06T18:10:44Z",
      "name":"salesforce_api_test",
      "type":"platform.salesforce",
      "deleted_at":"2018-02-06T18:05:06Z",
      "system_paused_at":null,
      "stitch_client_id":<ACCOUNT_ID>,
      "paused_at":null,
      "id":<SOURCE_ID>,
      "display_name":"Salesforce",
      "created_at":"2018-02-06T17:36:02Z",
      "report_card":{
         "type":"platform.salesforce",
         "current_step":1,
         "steps":[
            {  
               "type":"form",
               "properties":[ ... ]
            },
            {  
               "type":"oauth",
               "properties":[ ... ]
            },
            {  
               "type":"discover_schema",
               "properties":[  ]
            },
            {  
               "type":"field_selection",
               "properties":[  ]
            },
            {  
               "type":"fully_configured",
               "properties":[  ]
            }
         ],
         "current_step_hints":{
            "api":{
               "method":"PUT",
               "url":"/v4/sources{id}"
            }
         }
      }
   },
   {  
      "properties":{
         "frequency_in_minutes":"30",
         "image_version":"1.latest",
         "start_date":"2017-01-01T00:00:00Z"
      },
      "updated_at":"2018-02-06T18:05:30Z",
      "name":"salesforce_api_test",
      "type":"platform.salesforce",
      "deleted_at":null,
      "system_paused_at":null,
      "stitch_client_id":<ACCOUNT_ID>,
      "paused_at":null,
      "id":<SOURCE_ID>,
      "display_name":"Salesforce",
      "created_at":"2018-02-06T18:05:30Z",
      "report_card":{
         "type":"platform.salesforce",
         "current_step":1,
         "steps":[
            {
               "type":"form",
               "properties":[ ... ]
            },
            {
               "type":"oauth",
               "properties":[ ... ]
            },
            {
               "type":"discover_schema",
               "properties":[  ]
            },
            {
               "type":"field_selection",
               "properties":[  ]
            },
            {
               "type":"fully_configured",
               "properties":[  ]
            }
         ],
         "current_step_hints":{
            "api":{
               "method":"PUT",
               "url":"/v4/sources{id}"
            }
         }
      }
   }
]

GET

/v4/sources/{id}

Retrieves a previously created data source by its unique identifier.

Resource List
Authorization

Required. The request header must contain Authorization and your access token.

Request Header

The request header must contain the following:

  • Authorization: Must specify Bearer Auth, e.g. Bearer: <ACCESS_TOKEN>
  • Content-Type: Must specify JSON, e.g. application/json

See the Request tab below for an example request.

Request Body

The request body must be valid JSON and contain the required arguments.

Response Format

Whether the request succeeds or fails, the API will return JSON.

Arguments

This endpoint accepts the following parameters:

id
PATH PARAMETER
REQUIRED

A path parameter corresponding to the unique ID of the data source to be retrieved.

Returns

If successful and a valid identifier was provided, the API will return a status of 200 OK and a single Source Object.

curl -X GET https://api.stitchdata.com/v4/sources/{id}
     -H "Authorization: Bearer <ACCESS_TOKEN>" 
     -H "Content-Type: application/json"
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1

{  
   "properties":{  
      "frequency_in_minutes":"30",
      "image_version":"1.latest",
      "start_date":"2017-01-01T00:00:00Z"
   },
   "updated_at":"2018-02-06T18:04:59Z",
   "name":"hubspot",
   "type":"platform.hubspot",
   "deleted_at":"2018-02-06T18:04:58Z",
   "system_paused_at":null,
   "stitch_client_id":<ACCOUNT_ID>,
   "paused_at":null,
   "id":<SOURCE_ID>,
   "display_name":"HubSpot",
   "created_at":"2018-02-06T16:25:06Z",
   "report_card":{  
      "type":"platform.hubspot",
      "current_step":2,
      "steps":[  
         {  
            "type":"form",
            "properties":[  
               {  
                  "name":"image_version",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {  
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"start_date",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         },
         {  
            "type":"oauth",
            "properties":[  
               {  
                  "name":"client_id",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"client_secret",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{  
                     "type":"string"
                  }
               },
               {  
                  "name":"redirect_uri",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{  
                     "type":"string",
                     "format":"uri"
                  }
               },
               {  
                  "name":"refresh_token",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{  
                     "type":"string"
                  }
               }
            ]
         },
         {  
            "type":"discover_schema",
            "properties":[  

            ]
         },
         {
            "type":"field_selection",
            "properties":[ ]
         },
         {
            "type":"fully_configured",
            "properties":[  ]
         }
      ],
      "current_step_hints":{
         "js":{
            "function":"authorizeSource",
            "options":{
               "id":<SOURCE_ID>
            }
         }
      }
   }
}

Data Structures

OBJECT Connection Check

A connection check object shows the results from a test of a connection’s parameters. The nature of the test varies by connection type.

OBJECT Connection Step

Contained in the Report Card object, the Connection Steps object contains the steps necessary to configure a data source or destination.

OBJECT Current Step Hint

Contained within the Report Card object, the Current Step Hint object provides the function to call and properties to pass to the Connect JavaScript Client.

Otherwise, this object will provide information about the next call to make to the API.

OBJECT Properties

A Properties object contains the properties necessary to complete a connection step. Returned within a Source or Destination object, these properties provide information about the configuration status of the connection.

OBJECT Report Card

A Report Card object contains information about a connection’s configuration.


OBJECT

The Connection Check Object

A connection check object shows the results from a test of a connection’s parameters. The nature of the test varies by connection type.

error
BOOLEAN

Indicates if the last connection check resulted in an error.

started_at
TIMESTAMP

The time the last check started.

completed_at
TIMESTAMP

The time the last check completed.

Example Object

{
    "last_check":{
      "error": false,
      "started_at":"2018-02-06T16:15:19Z",
      "completed_at":"2018-02-06T16:16:21Z"
    }
}

OBJECT

The Connection Step Object

Contained in the Report Card object, the Connection Steps object contains the steps necessary to configure a data source or destination.

type
STRING

The type of step. Possible values are:

  • form - The first step in every source’s creation.
  • oauth - If required, the OAuth step for the source’s creation.
  • profile - If required, the profile selection step. For example: Selecting a Facebook Ads profile.
  • discover_schema - The step in which Stitch performs a structure sync to detect the tables and attributes available in the source.
  • field_selection - The step in which tables and columns are selected for replication.
  • fully_configured - Achieved when the source has a successful connection and field_selection is complete.
properties
ARRAY

An array of Properties objects.

Example Object

{  
   "report_card":{  
      "type":"platform.hubspot",
      "current_step":2,
      "steps":[  
         {  
            "type":"form",
            "properties":[]
         },
         {  
            "type":"oauth",
            "properties":[]
         },
         {  
            "type":"discover_schema",
            "properties":[]
         },
         {  
            "type":"field_selection",
            "properties":[]
         },
         {  
            "type":"fully_configured",
            "properties":[]
         }
      ]
   }
}

OBJECT

The Current Step Hint Object

Contained within the Report Card object, the Current Step Hint object provides the function to call and properties to pass to the Connect JavaScript Client.

Otherwise, this object will provide information about the next call to make to the API.

api
OBJECT (API HINT)

This object describes the actions requires to complete the current connection step using the API, if applicable.

js
OBJECT (JAVASCRIPT HINT)

This object describes the actions required to complete the current connection step using the Connect JavaScript Client, if applicable.

SUB-OBJECT

The API Hint Object

method
STRING

The API method required to complete the current step.

url
STRING

The API endpoint path associated with method.

SUB-OBJECT

The JavaScript Hint Object

function
STRING

The JavaScript client function required to complete the current step.

options
OBJECT

The option values to pass into the corresponding JavaScript client function.

Example Object

{
   "current_step_hints":{
      "api":{
         "method":"POST",
         "url":"/v4/sources"
      },
      "js":{
         "function":"authorizeSource",
         "options":{
            "id":<SOURCE_ID>
         }
      }
   }
}

OBJECT

The Properties Object

A Properties object contains the properties necessary to complete a connection step. Returned within a Source or Destination object, these properties provide information about the configuration status of the connection.

name
STRING

The name of the property.

required_to_be_fully_configured
BOOLEAN

If true, the property is required for complete configuration.

provided
BOOLEAN

If true, the property has been provided.

is_credential
BOOLEAN

If true, the property is a credential or otherwise sensitive data.

system_provided
BOOLEAN

If true, the system provides this property.

json_schema
ARRAY

An array containing:

  • type - The expected data type of the property’s value. For example: string
  • pattern - The expected pattern of the property’s value. For example: ^\\d+$

Data will only be returned for this array if system_provided: false.

Example Object

{
  "report_card":{  
      "type":"platform.hubspot",
      "current_step":2,
      "steps":[  
         {  
            "type":"form",
            "properties":[  
               {  
                  "name":"image_version",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {  
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {  
                  "name":"start_date",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{  
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         }
      ]
   }
}

OBJECT

The Report Card Object

A Report Card object contains information about a connection’s configuration.

current_step
INTEGER

The index (in the steps array) of the current step needed to configure the data source.

current_step_hints
OBJECT (CURRENT STEP HINTS)

If the current step requires the user to interact with the Stitch interface, this object will provide the function to call and properties to pass to the Connect JavaScript Client.

Otherwise, this object will provide information about the next call to make to the API.

steps
ARRAY

A sequential list of Connection Step objects required to complete configuration for the connection type.

type
STRING

The connection type. Ex: platform.salesforce or platform.hubspot

Example Object

{
   "report_card":{
      "type":"platform.hubspot",
      "current_step":2,
      "steps":[
         {
            "type":"form",
            "properties":[
               {
                  "name":"image_version",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":true,
                  "json_schema":null
               },
               {
                  "name":"frequency_in_minutes",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^\\d+$"
                  }
               },
               {
                  "name":"start_date",
                  "is_required":true,
                  "provided":true,
                  "is_credential":false,
                  "system_provided":false,
                  "json_schema":{
                     "type":"string",
                     "pattern":"^\\d{4}-\\d{2}-\\d{2}T00:00:00Z$"
                  }
               }
            ]
         },
         {
            "type":"oauth",
            "properties":[
               {
                  "name":"client_id",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"client_secret",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               },
               {
                  "name":"redirect_uri",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string",
                     "format":"uri"
                  }
               },
               {
                  "name":"refresh_token",
                  "is_required":true,
                  "provided":false,
                  "is_credential":true,
                  "system_provided":true,
                  "json_schema":{
                     "type":"string"
                  }
               }
            ]
         },
         {
            "type":"discover_schema",
            "properties":[

            ]
         },
         {
            "type":"field_selection",
            "properties":[

            ]
         },
         {
            "type":"fully_configured",
            "properties":[

            ]
         }
      ],
      "current_step_hints":{
         "js":{
            "function":"authorizeSource",
            "options":{
               "id":<SOURCE_ID>
            }
         }
      }
   }
}

Form Properties

Stitch connects to a large, diverse universe of applications and data warehouses, each of which is configured differently.

The properties objects contain the properties necessary to create a source or destination object.

For sources, these properties can also be found in the source’s report card step: form.

OBJECT Amazon Aurora Source Form Property

An Amazon Aurora connection reads data from an Amazon Aurora database and corresponds to source type: aurora.

OBJECT Amazon S3 CSV Source Form Property

An Amazon S3 CSV connection reads data from an Amazon S3 CSV database and corresponds to source type: s3-csv.

OBJECT Amplitude Source Form Property

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

OBJECT Bing Ads Source Form Property

Bing Ads connections read data from the Bing Ads API and correspond to source type: bing-ads.

OBJECT Bronto Source Form Property

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

OBJECT Close.io Source Form Property

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

OBJECT DoubleClick Campaign Manager Source Form Property

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

OBJECT Facebook Ads Source Form Property

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

OBJECT FullStory Source Form Property

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

OBJECT GitHub Source Form Property

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

OBJECT Google AdWords Source Form Property

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

OBJECT Google CloudSQL MySQL Source Form Property

A Google CloudSQL MySQL connection reads data from a Google CloudSQL MySQL database and corresponds to source type: cloudsql.

OBJECT Google CloudSQL PostgreSQL Source Form Property

A Google CloudSQL PostgreSQL connection reads data from a Google CloudSQL PostgreSQL database and corresponds to source type: cloudsql_pg.

OBJECT Heroku Source Form Property

A Heroku connection reads data from a Heroku database and corresponds to source type: heroku_pg.

OBJECT HubSpot Source Form Property

HubSpot connections read data from the HubSpot API and correspond to source type: hubspot.

OBJECT Listrak Source Form Property

Listrak connections read data from the Listrak API and correspond to source type: listrak.

OBJECT MariaDB Source Form Property

A MariaDB connection reads data from a MariaDB database and corresponds to source type: mariadb.

OBJECT Marketo Bulk Source Form Property

Marketo Bulk connections read data from the Marketo Bulk API and correspond to source type: marketobulk.

OBJECT Marketo Source Form Property

Marketo connections read data from the Marketo API and correspond to source type: marketo.

OBJECT MySQL Source Form Property

A MySQL connection reads data from a MySQL database and corresponds to source type: mysql.

OBJECT Oracle Source Form Property

An Oracle connection reads data from an Oracle database and corresponds to source type: oracle.

OBJECT PostgreSQL Destination Form Property

A PostgreSQL connection writes data to a PostgreSQL database and corresponds to destination type: postgres.

OBJECT PostgreSQL Source Form Property

A PostgreSQL connection reads data from a PostgreSQL database and corresponds to source type: postgres.

OBJECT Quick Base Source Form Property

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

OBJECT Redshift Destination Form Property

A Redshift connection writes data to a Redshift database and corresponds to destination type: redshift.

OBJECT Salesforce Source Form Property

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

OBJECT SendGrid Source Form Property

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

OBJECT Snowflake Destination Form Property

A Snowflake connection writes data to a Snowflake database and corresponds to destination type: snowflake.

OBJECT Xero Source Form Property

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

OBJECT Yotpo Source Form Property

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

OBJECT Zendesk Source Form Property

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

OBJECT Zuora Source Form Property

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


Destination Form Properties

Destination form properties should be sent in the connection argument when using the Create or Update a Destination endpoints.

OBJECT PostgreSQL Destination Form Property

A PostgreSQL connection writes data to a PostgreSQL database and corresponds to destination type: postgres.

OBJECT Redshift Destination Form Property

A Redshift connection writes data to a Redshift database and corresponds to destination type: redshift.

OBJECT Snowflake Destination Form Property

A Snowflake connection writes data to a Snowflake database and corresponds to destination type: snowflake.


OBJECT

The PostgreSQL Destination Form Property Object

A PostgreSQL connection writes data to a PostgreSQL database and corresponds to destination type: postgres.

Note: Attributes marked as REQUIRED must be provided in the connection argument for Creating a Destination.

database
STRING
REQUIRED

The name of the logical database to connect to.

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

ssl
STRING
OPTIONAL

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

user
STRING
REQUIRED

The username of the database user.

Example Object
{
 "type":"platform.postgres",
 "properties":{
   "database":"<database_name>",
   "host":"<host_address>",
   "password":"<password>",
   "port":5432,
   "ssl":false,
   "user":"<username>"
  }
}

OBJECT

The Redshift Destination Form Property Object

A Redshift connection writes data to a Redshift database and corresponds to destination type: redshift.

Note: Attributes marked as REQUIRED must be provided in the connection argument for Creating a Destination.

database
STRING
REQUIRED

The name of the logical database to connect to.

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

ssl
STRING
OPTIONAL

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

user
STRING
REQUIRED

The username of the database user.

Example Object
{
 "type":"platform.redshift",
 "properties":{
   "database":"<database_name>",
   "host":"<host_address>",
   "password":"<password>",
   "port":5439,
   "ssl":false,
   "user":"<username>"
  }
}

OBJECT

The Snowflake Destination Form Property Object

A Snowflake connection writes data to a Snowflake database and corresponds to destination type: snowflake.

Note: Attributes marked as REQUIRED must be provided in the connection argument for Creating a Destination.

database
STRING
REQUIRED

The name of the logical database to connect to.

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

role
STRING
OPTIONAL

The role to use.

ssl
STRING
OPTIONAL

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

user
STRING
REQUIRED

The username of the database user.

Example Object
{
 "type":"platform.snowflake",
 "properties":{
   "database":"<database_name>",
   "host":"<host_address>",
   "password":"<password>",
   "port":443,
   "role":<OPTIONAL_ROLE>,
   "ssl":false,
   "user":"<username>"
  }
}

Source Form Properties

Source form properties should be sent in the properties argument when using the Create or Update a Source endpoints.

All properties should be sent as strings.

OBJECT Amazon Aurora Source Form Property

An Amazon Aurora connection reads data from an Amazon Aurora database and corresponds to source type: aurora.

OBJECT Amazon S3 CSV Source Form Property

An Amazon S3 CSV connection reads data from an Amazon S3 CSV database and corresponds to source type: s3-csv.

OBJECT Amplitude Source Form Property

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

OBJECT Bing Ads Source Form Property

Bing Ads connections read data from the Bing Ads API and correspond to source type: bing-ads.

OBJECT Bronto Source Form Property

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

OBJECT Close.io Source Form Property

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

OBJECT DoubleClick Campaign Manager Source Form Property

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

OBJECT Facebook Ads Source Form Property

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

OBJECT FullStory Source Form Property

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

OBJECT GitHub Source Form Property

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

OBJECT Google AdWords Source Form Property

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

OBJECT Google CloudSQL MySQL Source Form Property

A Google CloudSQL MySQL connection reads data from a Google CloudSQL MySQL database and corresponds to source type: cloudsql.

OBJECT Google CloudSQL PostgreSQL Source Form Property

A Google CloudSQL PostgreSQL connection reads data from a Google CloudSQL PostgreSQL database and corresponds to source type: cloudsql_pg.

OBJECT Heroku Source Form Property

A Heroku connection reads data from a Heroku database and corresponds to source type: heroku_pg.

OBJECT HubSpot Source Form Property

HubSpot connections read data from the HubSpot API and correspond to source type: hubspot.

OBJECT Listrak Source Form Property

Listrak connections read data from the Listrak API and correspond to source type: listrak.

OBJECT MariaDB Source Form Property

A MariaDB connection reads data from a MariaDB database and corresponds to source type: mariadb.

OBJECT Marketo Bulk Source Form Property

Marketo Bulk connections read data from the Marketo Bulk API and correspond to source type: marketobulk.

OBJECT Marketo Source Form Property

Marketo connections read data from the Marketo API and correspond to source type: marketo.

OBJECT MySQL Source Form Property

A MySQL connection reads data from a MySQL database and corresponds to source type: mysql.

OBJECT Oracle Source Form Property

An Oracle connection reads data from an Oracle database and corresponds to source type: oracle.

OBJECT PostgreSQL Source Form Property

A PostgreSQL connection reads data from a PostgreSQL database and corresponds to source type: postgres.

OBJECT Quick Base Source Form Property

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

OBJECT Salesforce Source Form Property

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

OBJECT SendGrid Source Form Property

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

OBJECT Xero Source Form Property

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

OBJECT Yotpo Source Form Property

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

OBJECT Zendesk Source Form Property

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

OBJECT Zuora Source Form Property

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


OBJECT

The Amazon Aurora Source Form Property Object

An Amazon Aurora connection reads data from an Amazon Aurora database and corresponds to source type: aurora.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

database
STRING
REQUIRED

The name of the logical database to connect to.

filter_dbs
STRING
REQUIRED

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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 3306.

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 true, an SSH tunnel will be used to connect to the database.

ssh_host
STRING
OPTIONAL

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

ssh_port
STRING
OPTIONAL

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

ssh_user
STRING
OPTIONAL

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

start_date
STRING
REQUIRED

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

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

use_log_based_replication
STRING
OPTIONAL

This field is not currently in use, but will be part of a future release.

user
STRING
REQUIRED

The username of the Amazon Aurora database user.

Example Object
{
 "type":"platform.aurora",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "database":"<DATABASE_NAME>",
   "filter_dbs":"",
   "frequency_in_minutes":"360",
   "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>",
   "start_date":"2018-01-10T00:00:00Z",
   "use_log_based_replication":"true",
   "user":"<USERNAME>"
   }
}

OBJECT

The Amazon S3 CSV Source Form Property Object

An Amazon S3 CSV connection reads data from an Amazon S3 CSV database and corresponds to source type: s3-csv.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

bucket
STRING
REQUIRED

The name of the bucket Stitch should replicate data from.

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.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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: 2018-01-01T00:00:00Z

Example Object
{
 "type":"platform.s3-csv",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "bucket":"com-test-stitch-bucket",
   "external_id":"stitch_connection_12345",
   "frequency_in_minutes":"360",
   "role_name":"<ROLE_NAME>",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The Amplitude Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

account
STRING
REQUIRED

The account ID for the Amplitude Snowflake warehouse.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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: 2018-01-01T00:00:00Z

username
STRING
REQUIRED

The username of the Amplitude database user.

warehouse
STRING
REQUIRED

The name of the Amplitude Snowflake warehouse.

Example Object
{
 "type":"platform.amplitude",
 "properties":{
   "account":"<AMPLITUDE_SNOWFLAKE_ACCOUNT>",
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z",
   "username":"<username>",
   "warehouse":"<AMPLITUDE_WAREHOUSE>"
   }
}

OBJECT

The Bing Ads Source Form Property Object

Bing Ads connections read data from the Bing Ads API and correspond to source type: bing-ads.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
start_date
STRING
REQUIRED

The date from which Stitch should begin replicating data from Bing 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: 2018-01-01T00:00:00Z

Example Object
{
 "type":"platform.bing-ads",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The Bronto Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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: 2018-01-01T00:00:00Z

token
STRING
REQUIRED

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

Example Object
{
 "type":"platform.bronto",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z",
   "token":"<API_TOKEN>"
   }
}

OBJECT

The Close.io Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

api_key
STRING
REQUIRED

The user’s API key. API keys can be generated in by navigating to Settings > Your API Keys.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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: 2018-01-01T00:00:00Z

Example Object
{
 "type":"platform.closeio",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "api_key":"<API_KEY>",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The DoubleClick Campaign Manager Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
Example Object
{
 "type":"platform.doubleclick-campaign-manager",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360"
   }
}

OBJECT

The Facebook Ads Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

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:

  • 1
  • 7
  • 28

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

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
include_deleted
STRING
OPTIONAL

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

start_date
STRING
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: 2018-01-01T00:00:00Z

Example Object
{
 "type":"platform.facebook",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "attribution_window":"7",
   "frequency_in_minutes":"360",
   "include_deleted":"true",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The FullStory Source Form Property Object

FullStory connections read data from the FullStory API and correspond to source type: 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 before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

api_key
STRING
REQUIRED

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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: 2018-01-01T00:00:00Z

Example Object
{
 "type":"platform.fullstory",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "api_key":"<API_KEY>",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The GitHub Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

access_token
STRING
REQUIRED

An access token which allows access to any project the user wants to replicate data from.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
repository
STRING
REQUIRED

The name of the repository to be tracked.

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: 2018-01-01T00:00:00Z

Example Object
{
 "type":"platform.github",
 "properties":{
   "access_token":"<ACCESS_TOKEN>",
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360",
   "repository":"<REPOSITORY_NAME>",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The Google AdWords Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
start_date
STRING
REQUIRED

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

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

Example Object
{
 "type":"platform.adwords",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The Google CloudSQL MySQL Source Form Property Object

A Google CloudSQL MySQL connection reads data from a Google CloudSQL MySQL database and corresponds to source type: cloudsql.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

database
STRING
REQUIRED

The name of the logical database to connect to.

filter_dbs
STRING
REQUIRED

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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 3306.

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.

start_date
STRING
REQUIRED

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

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

use_log_based_replication
STRING
OPTIONAL

This field is not currently in use, but will be part of a future release.

user
STRING
REQUIRED

The username of the Google CloudSQL MySQL database user.

Example Object
{
 "type":"platform.cloudsql",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "database":"<DATABASE_NAME>",
   "filter_dbs":"",
   "frequency_in_minutes":"360",
   "host":"<HOST_ADDRESS>",
   "password":"<PASSWORD>",
   "port":"3306",
   "server_id":"<UNIQUE_SERVER_ID>",
   "start_date":"2018-01-10T00:00:00Z",
   "use_log_based_replication":"true",
   "user":"<USERNAME>"
   }
}

OBJECT

The Google CloudSQL PostgreSQL Source Form Property Object

A Google CloudSQL PostgreSQL connection reads data from a Google CloudSQL PostgreSQL database and corresponds to source type: cloudsql_pg.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

dbname
STRING
REQUIRED

The name of the logical database to connect to.

filter_dbs
STRING
REQUIRED

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
host
STRING
REQUIRED

The IP address or hostname of the database server.

include_schemas_in_destination_stream_name
STRING
REQUIRED

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

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

itersize
STRING
REQUIRED

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

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

start_date
STRING
REQUIRED

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

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

user
STRING
REQUIRED

The username of the Google CloudSQL PostgreSQL database user.

Example Object
{
 "type":"platform.cloudsql_pg",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "dbname":"<DATABASE_NAME>",
   "filter_dbs":"",
   "frequency_in_minutes":"360",
   "host":"<HOST_ADDRESS>",
   "include_schemas_in_destination_stream_name":"false",
   "itersize":"",
   "password":"<PASSWORD>",
   "port":"5432",
   "start_date":"2018-01-10T00:00:00Z",
   "user":"<USERNAME>"
   }
}

OBJECT

The Heroku Source Form Property Object

A Heroku connection reads data from a Heroku database and corresponds to source type: heroku_pg.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

dbname
STRING
REQUIRED

The name of the logical database to connect to.

filter_dbs
STRING
REQUIRED

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
host
STRING
REQUIRED

The IP address or hostname of the database server.

include_schemas_in_destination_stream_name
STRING
REQUIRED

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

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

itersize
STRING
REQUIRED

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

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

ssl
STRING
OPTIONAL

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

start_date
STRING
REQUIRED

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

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

user
STRING
REQUIRED

The username of the Heroku database user.

Example Object
{
 "type":"platform.heroku_pg",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "dbname":"<DATABASE_NAME>",
   "filter_dbs":"",
   "frequency_in_minutes":"360",
   "host":"<HOST_ADDRESS>",
   "include_schemas_in_destination_stream_name":"false",
   "itersize":"",
   "password":"<PASSWORD>",
   "port":"5432",
   "ssl":"false",
   "start_date":"2018-01-10T00:00:00Z",
   "user":"<USERNAME>"
   }
}

OBJECT

The HubSpot Source Form Property Object

HubSpot connections read data from the HubSpot API and correspond to source type: hubspot.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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: 2018-01-01T00:00:00Z

Example Object
{
 "type":"platform.hubspot",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The Listrak Source Form Property Object

Listrak connections read data from the Listrak API and correspond to source type: listrak.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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: 2018-01-01T00:00:00Z

username
STRING
REQUIRED

The user’s Listrak username.

Example Object
{
 "type":"platform.listrak",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360",
   "password":"<PASSWORD>",
   "start_date":"2018-01-10T00:00:00Z",
   "username":"<USERNAME>"
   }
}

OBJECT

The MariaDB Source Form Property Object

A MariaDB connection reads data from a MariaDB database and corresponds to source type: mariadb.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

database
STRING
REQUIRED

The name of the logical database to connect to.

filter_dbs
STRING
REQUIRED

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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 3306.

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 true, an SSH tunnel will be used to connect to the database.

ssh_host
STRING
OPTIONAL

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

ssh_port
STRING
OPTIONAL

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

ssh_user
STRING
OPTIONAL

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

start_date
STRING
REQUIRED

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

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

use_log_based_replication
STRING
OPTIONAL

This field is not currently in use, but will be part of a future release.

user
STRING
REQUIRED

The username of the MariaDB database user.

Example Object
{
 "type":"platform.mariadb",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "database":"<DATABASE_NAME>",
   "filter_dbs":"",
   "frequency_in_minutes":"360",
   "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>",
   "start_date":"2018-01-10T00:00:00Z",
   "use_log_based_replication":"true",
   "user":"<USERNAME>"
   }
}

OBJECT

The Marketo Bulk Source Form Property Object

Marketo Bulk connections read data from the Marketo Bulk API and correspond to source type: marketobulk.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

client_id
STRING
REQUIRED

The user’s Marketo client ID.

client_secret
STRING
REQUIRED

The user’s Marketo client secret.

endpoint
STRING
REQUIRED

The user’s Marketo REST endpoint URL. For example: https://457-RFG-234.mktorest.com/rest

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
identity
STRING
REQUIRED

The user’s Marketo REST identity URL. For example: https://457-RFG-234.mktorest.com/identity

start_date
STRING
REQUIRED

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

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

Example Object
{
 "type":"platform.marketobulk",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "client_id":"<MARKETO_CLIENT_ID>",
   "client_secret":"<MARKETO_CLIENT_SECRET>",
   "endpoint":"https://<some-id-here>.mktorest.com/rest",
   "frequency_in_minutes":"360",
   "identity":"https://<some-id-here>.mktorest.com/identity",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The Marketo Source Form Property Object

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

client_id
STRING
REQUIRED

The user’s Marketo client ID.

client_secret
STRING
REQUIRED

The user’s Marketo client secret.

endpoint
STRING
REQUIRED

The user’s Marketo REST endpoint URL. For example: https://457-RFG-234.mktorest.com/rest

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
identity
STRING
REQUIRED

The user’s Marketo REST identity URL. For example: https://457-RFG-234.mktorest.com/identity

max_daily_calls
STRING
OPTIONAL

The maximum number of daily API calls that Stitch may make to the Marketo API.

start_date
STRING
REQUIRED

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

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

Example Object
{
 "type":"platform.marketo",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "client_id":"<MARKETO_CLIENT_ID>",
   "client_secret":"<MARKETO_CLIENT_SECRET>",
   "endpoint":"https://<some-id-here>.mktorest.com/rest",
   "frequency_in_minutes":"360",
   "identity":"https://<some-id-here>.mktorest.com/identity",
   "max_daily_calls":"2000",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The MySQL Source Form Property Object

A MySQL connection reads data from a MySQL database and corresponds to source type: mysql.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

database
STRING
REQUIRED

The name of the logical database to connect to.

filter_dbs
STRING
REQUIRED

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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 3306.

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 true, an SSH tunnel will be used to connect to the database.

ssh_host
STRING
OPTIONAL

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

ssh_port
STRING
OPTIONAL

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

ssh_user
STRING
OPTIONAL

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

ssl
STRING
OPTIONAL

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

start_date
STRING
REQUIRED

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

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

use_log_based_replication
STRING
OPTIONAL

This field is not currently in use, but will be part of a future release.

user
STRING
REQUIRED

The username of the MySQL database user.

Example Object
{
 "type":"platform.mysql",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "database":"<DATABASE_NAME>",
   "filter_dbs":"",
   "frequency_in_minutes":"360",
   "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",
   "start_date":"2018-01-10T00:00:00Z",
   "use_log_based_replication":"true",
   "user":"<USERNAME>"
   }
}

OBJECT

The Oracle Source Form Property Object

An Oracle connection reads data from an Oracle database and corresponds to source type: oracle.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

default_replication_method
STRING
OPTIONAL

This field is not currently in use, but will be part of a future release.

filter_schemas
STRING
OPTIONAL

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
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 3306.

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.

sid
STRING
OPTIONAL

The site identifier associated with the Oracle instance.

ssh
STRING
OPTIONAL

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

ssh_host
STRING
OPTIONAL

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

ssh_port
STRING
OPTIONAL

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

ssh_user
STRING
OPTIONAL

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

ssl
STRING
OPTIONAL

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

start_date
STRING
REQUIRED

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

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

use_log_based_replication
STRING
OPTIONAL

This field is not currently in use, but will be part of a future release.

user
STRING
REQUIRED

The username of the Oracle database user.

Example Object
{
 "type":"platform.oracle",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "default_replication_method":"",
   "filter_schemas":"",
   "frequency_in_minutes":"360",
   "host":"<HOST_ADDRESS>",
   "password":"<PASSWORD>",
   "port":"3306",
   "server_id":"<UNIQUE_SERVER_ID>",
   "sid":"<ORACLE_SID>",
   "ssh":"true",
   "ssh_host":"<SSH_HOST>",
   "ssh_port":"22",
   "ssh_user":"<SSH_USERNAME>",
   "ssl":"false",
   "start_date":"2018-01-10T00:00:00Z",
   "use_log_based_replication":"true",
   "user":"<USERNAME>"
   }
}

OBJECT

The PostgreSQL Source Form Property Object

A PostgreSQL connection reads data from a PostgreSQL database and corresponds to source type: postgres.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

dbname
STRING
REQUIRED

The name of the logical database to connect to.

filter_dbs
STRING
REQUIRED

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
host
STRING
REQUIRED

The IP address or hostname of the database server.

include_schemas_in_destination_stream_name
STRING
REQUIRED

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

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

itersize
STRING
REQUIRED

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

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

ssh
STRING
OPTIONAL

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

ssh_host
STRING
OPTIONAL

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

ssh_port
STRING
OPTIONAL

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

ssh_user
STRING
OPTIONAL

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

ssl
STRING
OPTIONAL

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

start_date
STRING
REQUIRED

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

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

user
STRING
REQUIRED

The username of the PostgreSQL database user.

Example Object
{
 "type":"platform.postgres",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "dbname":"<DATABASE_NAME>",
   "filter_dbs":"",
   "frequency_in_minutes":"360",
   "host":"<HOST_ADDRESS>",
   "include_schemas_in_destination_stream_name":"false",
   "itersize":"",
   "password":"<PASSWORD>",
   "port":"5432",
   "ssh":"true",
   "ssh_host":"<SSH_HOST>",
   "ssh_port":"22",
   "ssh_user":"<SSH_USERNAME>",
   "ssl":"false",
   "start_date":"2018-01-10T00:00:00Z",
   "user":"<USERNAME>"
   }
}

OBJECT

The Quick Base Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
qb_appid
STRING
REQUIRED

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

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

qb_url
STRING
REQUIRED

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

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

qb_user_token
STRING
REQUIRED

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

start_date
STRING
REQUIRED

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

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

Example Object
{
 "type":"platform.quickbase",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360",
   "qb_appid":"<APPID>",
   "qb_url":"https://<your-subdomain-here>.quickbase.com/db/",
   "qb_user_token":"<QUICK_BASE_USER_TOKEN>",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The Salesforce Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

api_type
STRING
REQUIRED

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
is_sandbox
STRING
OPTIONAL

If true, the Salesforce account being connected is a sandbox.

quota_percent_per_run
STRING
OPTIONAL

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

quota_percent_total
STRING
OPTIONAL

The maximum percentage of Salesforce API quota allowed per day.

select_fields_by_default
STRING
REQUIRED

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

start_date
STRING
REQUIRED

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

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

Example Object
{
 "type":"platform.salesforce",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "api_type":"BULK",
   "frequency_in_minutes":"360",
   "is_sandbox":"false",
   "quota_percent_per_run":"20",
   "quota_percent_total":"80",
   "select_fields_by_default":"false",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The SendGrid Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

api_key
STRING
REQUIRED

The SendGrid API key. Refer to SendGrid’s documentation for info about permissions and creating keys.

frequency_in_minutes
STRING
REQUIRED
frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
start_date
STRING
REQUIRED

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

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

Example Object
{
 "type":"platform.sendgrid",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "api_key":"<API_KEY>",
   "frequency_in_minutes":"1440",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The Xero Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
start_date
STRING
REQUIRED

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

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

Example Object
{
 "type":"platform.xero",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The Yotpo Source Form Property Object

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

Note: Creating a Yotpo source requires Yotpo API credentials. Retrieving these credentials requires Yotpo Account Administrator permissions. Refer to Yotpo’s documentation for more info.

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

api_key
STRING
REQUIRED

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

api_secret
STRING
REQUIRED

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

Note: Yotpo Account Administrator permissions are required to retrieve this information.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
start_date
STRING
REQUIRED

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

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

Example Object
{
 "type":"platform.yotpo",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "api_key":"<API_KEY>",
   "api_secret":"<API_SECRET>",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z"
   }
}

OBJECT

The Zendesk Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
start_date
STRING
REQUIRED

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

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

subdomain
STRING
REQUIRED

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

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

Example Object
{
 "type":"platform.zendesk",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "frequency_in_minutes":"360",
   "start_date":"2018-01-10T00:00:00Z",
   "subdomain":"<YOUR_ZENDESK_SUBDOMAIN>"
   }
}

OBJECT

The Zuora Source Form Property Object

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

Note: Attributes marked as REQUIRED must be provided before the source can be considered fully_configured.

anchor_time
STRING
OPTIONAL

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

This field must contain an ISO 8601-compliant date. For example: 2018-04-30T03:30:00Z

For example: If anchor_time is set to 2018-04-30T03:30:00Z and frequency_in_minutes is set to 360, Stitch will run a replication job for the integration every 360 minutes, starting at 03:30:00. This means a job would run at 09:30:00, 15:30:00, 21:30:00, etc.

european
STRING
OPTIONAL

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

frequency_in_minutes
STRING
REQUIRED

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

  • 30
  • 60
  • 360
  • 720
  • 1440
password
STRING
REQUIRED

The password associated with the Zuora user authorizing the connection.

sandbox
STRING
OPTIONAL

If true, the Zuora account being connected is a sandbox.

start_date
STRING
REQUIRED

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

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

username
STRING
REQUIRED

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

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

For more info, refer to our Zuora integration documentation.

Example Object
{
 "type":"platform.zuora",
 "properties":{
   "anchor_time":"2018-04-30T03:30:00Z",
   "european":"false",
   "frequency_in_minutes":"360",
   "password":"<PASSWORD>",
   "sandbox":"false",
   "start_date":"2018-01-10T00:00:00Z",
   "username":"<USERNAME>"
   }
}