Sailthru API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "sailthru",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"historic_sync_time_frame": "THREE_MONTHS | SIX_MONTHS | ONE_YEAR | TWO_YEARS | FIVE_YEARS | ALL_TIME",
"historical_sync_limit_date": "2008-03-25",
"packing_mode": "PACKED | UNPACKED",
"historical_sync_limit": "ALL_TIME | DATE_LIMIT",
"s3role_arn": "string",
"s3path": "string",
"s3bucket": "string",
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"is_sailthru_connect_enabled": true,
"api_secret": "your_api_secret",
"schema": "schema_name"
}
}
Config parameters
Name | Description |
---|---|
historic_sync_time_frame | Range of historical data you would like to include in the initial sync. Default value: ALL_TIME . |
historical_sync_limit_date | The start date (YYYY-MM-DD) from which to sync historical data. |
packing_mode | Packing mode for LIST_STATE and USER tables. |
historical_sync_limit | The time range for which historical data should be synced. Default value: All Time . |
s3role_arn | Role ARN of the IAM role created for Fivetran. |
s3path | Copy and use this to configure Sailthru Connect in your sailthru account. |
s3bucket | Name of the bucket configured to receive sailthru connect data. |
api_key | The Sailthru API key. |
is_sailthru_connect_enabled | Enable this if you want to sync Sailthru Connect |
api_secret | The Sailthru API secret. |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
api_key
andapi_secret
parameters in the request.POST https://api.fivetran.com/v1/connections
{ "service": "sailthru", "group_id": "group_id", "config": { "api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "api_secret": "your_api_secret" } }
By using the Connect Card or the Fivetran dashboard.