Sierra API Configuration Lite Private Preview
For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.
Request
POST https://api.fivetran.com/v1/connections
{ "group_id": "group_id", "service": "sierra", "trust_certificates": true, "trust_fingerprints": true, "run_setup_tests": true, "paused": false, "pause_after_trial": false, "sync_frequency": 1440, "data_delay_sensitivity": "LOW", "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, "all_fields": true }, "proxy_agent_id": "proxy_agent_id", "private_link_id": "private_link_id", "networking_method": "Directly", "hybrid_deployment_agent_id": "hybrid_deployment_agent_id", "destination_configuration": { "virtual_warehouse": "virtual_warehouse" }, "destination_schema_names": "FIVETRAN_NAMING", "schedule": { "cron": "0 */6 * * *", "interval": 360, "schedule_type": "INTERVAL", "days_of_week": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "time_of_day": "14:00", "time_zone": "Europe/Prague" }, "external_secrets_manager_id": "esm_id", "data_checks": true, "config": { "api_token": "your_sierra_api_token", "base_url": "api.sierra.ai", "crawl_id": "your_sierra_crawl_id", "organization_id": "your_sierra_organization_id", "schema": "schema_name" } }
Config parameters
| Name | Description |
|---|---|
api_token | Your Sierra Admin API bearer token. |
base_url | The base URL for the Sierra API. |
crawl_id | The ID of a Sierra knowledge source crawl. |
organization_id | Your Sierra organization identifier. |
schema (required) | 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
base_url,api_token,organization_idandcrawl_idparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "sierra", "group_id": "group_id", "config": { "base_url": "api.sierra.ai", "api_token": "your_sierra_api_token", "organization_id": "your_sierra_organization_id", "crawl_id": "your_sierra_crawl_id" } } By using the Connect Card or the Fivetran dashboard.