Gainsight Customer Success API Configuration

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": "gainsight_customer_success",
  "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",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "access_key": "test_api_key",
    "authentication_method": "API_KEY | OAUTH",
    "sub_domain": "test_sub_domain",
    "schema": "schema_name"
  },
  "auth": {
    "client_access": {
      "client_id": "string",
      "client_secret": "string"
    },
    "refresh_token": "string"
  }
}

Config parameters

Name	Description
`access_key`	The API key for API authentication.
`authentication_method`	The authentication method to use. Can be either OAUTH or API_KEY.
`sub_domain`	The subdomain of your Gainsight Customer Success account.
`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 sub_domain and access_key parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "gainsight_customer_success",
  "group_id": "group_id",
  "config": {
    "sub_domain": "test_sub_domain",
    "access_key": "test_api_key"
  }
}

By using the Connect Card or the Fivetran dashboard.