Iterable API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "iterable",
  "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",
    "sync_mode": "AllEvents | NoEvents | SelectedEvents",
    "historical_sync_limit_date": "2013-01-01",
    "historical_sync_limit": "ALL_TIME | DATE_LIMIT",
    "custom_events": [
      "string"
    ],
    "api_key": "xxxxxxxxxxxxxxxx",
    "custom_event_sync_mode": "AllEvents | NoEvents | SelectedEvents",
    "account_region": "US | EU",
    "events": [
      "string"
    ],
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`historic_sync_time_frame`	The time range for which historical data should be synced. Default value: `All Time`.
`sync_mode`	Events Sync Mode.
`historical_sync_limit_date`	The start date (YYYY-MM-DD) from which to sync historical data.
`historical_sync_limit`	The time range for which historical data should be synced. Default value: `All Time`.
`custom_events`	List of custom events to sync. Should be specified when `custom_event_sync_mode` is `SelectedEvents`
`api_key`	Your Iterable API key.
`custom_event_sync_mode`	Custom Events Sync Mode.
`account_region`	If your Iterable account URL starts with `https://app.eu.iterable.com` then provide `EU` else `US`
`events`	List of events to sync. Should be specified when `sync_mode` is `SelectedEvents`
`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 value for the api_key parameter in the request.

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

{
  "service": "iterable",
  "group_id": "group_id",
  "config": {
    "api_key": "xxxxxxxxxxxxxxxx"
  }
}

By using the Connect Card or the Fivetran dashboard.