Segment API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "segment",
  "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",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "SOURCE_NAMING",
  "config": {
    "bucket": "bucket",
    "role_arn": "role_arn",
    "sync_type": "S3 | Webhook",
    "prefix": "prefix",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`bucket`	The name of the Segment bucket. Must be populated if `sync_type` is set to `S3`.
`role_arn`	The Role ARN required for authentication. Must be populated if `sync_type` is set to `S3`.
`sync_type`	The Segment connector sync type.
`prefix`	Folder path to the Segment files within the bucket. Must be populated if `sync_type` is set to `S3`.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are three ways to authorize this connector type:

S3: By specifying the sync_type as "S3" and the values for the prefix, bucket and role_arn parameters in the request.

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

{
  "service": "segment",
  "group_id": "group_id",
  "config": {
    "prefix": "prefix",
    "bucket": "bucket",
    "role_arn": "role_arn",
    "sync_type": "S3"
  }
}

Webhook: By specifying the sync_type as "webhook" in the request.
POST https://api.fivetran.com/v1/connections
```
{
  "service": "segment",
  "group_id": "group_id",
  "config": {
    "sync_type": "webhook"
  }
}
```
By using the Connect Card or the Fivetran dashboard.