Skip to main content

Create Sync Config

POST 

/sync_configs

Create Sync Config

Request

Body

required
    destination_name stringrequired
    provider_name provider_namerequired

    Possible values: [hubspot, salesforce, pipedrive, zendesk_sell, ms_dynamics_365_sales, zoho_crm, capsule, outreach, gong, apollo, salesloft, intercom, linear, clearbit, 6sense, marketo, salesforce_marketing_cloud_account_engagement, slack]

    config objectrequired
    default_config objectrequired

    Configuration options for "how" to sync.

    period_ms integerrequired

    Possible values: >= 60000

    The period (in milliseconds) to run the sync.

    strategy stringrequired

    Possible values: [full then incremental, full only]

    "full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.

    auto_start_on_connection boolean

    If true, the sync will start automatically when the connection is created. Default: true

    full_sync_every_n_incrementals number

    If set, Supaglue will run a full sync after N consecutive incremental syncs.

    common_objects object[]

    A list of Supaglue objects to be synced.

  • Array [
  • object stringrequired

    The Supaglue object name

    sync_strategy_override object

    Configuration options for "how" to sync.

    period_ms integerrequired

    Possible values: >= 60000

    The period (in milliseconds) to run the sync.

    strategy stringrequired

    Possible values: [full then incremental, full only]

    "full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.

    auto_start_on_connection boolean

    If true, the sync will start automatically when the connection is created. Default: true

    full_sync_every_n_incrementals number

    If set, Supaglue will run a full sync after N consecutive incremental syncs.

    associations_to_fetch string[]

    A list of associated objects to fetch when syncing this object. If empty or unspecified, no additional associations will be fetched other than the ones required to populate the common model. Only relevant for Hubspot.

  • ]
  • standard_objects object[]

    A list of case-sensitive Provider objects to be synced.

  • Array [
  • object stringrequired

    The Provider object name (case sensitive)

    sync_strategy_override object

    Configuration options for "how" to sync.

    period_ms integerrequired

    Possible values: >= 60000

    The period (in milliseconds) to run the sync.

    strategy stringrequired

    Possible values: [full then incremental, full only]

    "full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.

    auto_start_on_connection boolean

    If true, the sync will start automatically when the connection is created. Default: true

    full_sync_every_n_incrementals number

    If set, Supaglue will run a full sync after N consecutive incremental syncs.

    associations_to_fetch string[]

    A list of associated objects to fetch when syncing this object. If empty or unspecified, no associations will be fetched. Only relevant for Hubspot.

  • ]
  • custom_objects object[]

    A list of case-sensitive custom objects to be synced. Only supported for Salesforce and Hubspot.

  • Array [
  • object stringrequired

    The custom object name (case sensitive). For Salesforce, this should end with __c.

    sync_strategy_override object

    Configuration options for "how" to sync.

    period_ms integerrequired

    Possible values: >= 60000

    The period (in milliseconds) to run the sync.

    strategy stringrequired

    Possible values: [full then incremental, full only]

    "full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.

    auto_start_on_connection boolean

    If true, the sync will start automatically when the connection is created. Default: true

    full_sync_every_n_incrementals number

    If set, Supaglue will run a full sync after N consecutive incremental syncs.

    associations_to_fetch string[]

    A list of associated objects to fetch when syncing this object. If empty or unspecified, no associations will be fetched. Only relevant for Hubspot.

  • ]
  • entities object[]deprecated
  • Array [
  • entity_id stringrequired
  • ]

Responses

SyncConfig created

Schema
    id stringrequired
    application_id stringrequired
    destination_name stringrequired
    provider_name provider_namerequired

    Possible values: [hubspot, salesforce, pipedrive, zendesk_sell, ms_dynamics_365_sales, zoho_crm, capsule, outreach, gong, apollo, salesloft, intercom, linear, clearbit, 6sense, marketo, salesforce_marketing_cloud_account_engagement, slack]

    config objectrequired
    default_config objectrequired

    Configuration options for "how" to sync.

    period_ms integerrequired

    Possible values: >= 60000

    The period (in milliseconds) to run the sync.

    strategy stringrequired

    Possible values: [full then incremental, full only]

    "full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.

    auto_start_on_connection boolean

    If true, the sync will start automatically when the connection is created. Default: true

    full_sync_every_n_incrementals number

    If set, Supaglue will run a full sync after N consecutive incremental syncs.

    common_objects object[]

    A list of Supaglue objects to be synced.

  • Array [
  • object stringrequired

    The Supaglue object name

    sync_strategy_override object

    Configuration options for "how" to sync.

    period_ms integerrequired

    Possible values: >= 60000

    The period (in milliseconds) to run the sync.

    strategy stringrequired

    Possible values: [full then incremental, full only]

    "full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.

    auto_start_on_connection boolean

    If true, the sync will start automatically when the connection is created. Default: true

    full_sync_every_n_incrementals number

    If set, Supaglue will run a full sync after N consecutive incremental syncs.

    associations_to_fetch string[]

    A list of associated objects to fetch when syncing this object. If empty or unspecified, no additional associations will be fetched other than the ones required to populate the common model. Only relevant for Hubspot.

  • ]
  • standard_objects object[]

    A list of case-sensitive Provider objects to be synced.

  • Array [
  • object stringrequired

    The Provider object name (case sensitive)

    sync_strategy_override object

    Configuration options for "how" to sync.

    period_ms integerrequired

    Possible values: >= 60000

    The period (in milliseconds) to run the sync.

    strategy stringrequired

    Possible values: [full then incremental, full only]

    "full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.

    auto_start_on_connection boolean

    If true, the sync will start automatically when the connection is created. Default: true

    full_sync_every_n_incrementals number

    If set, Supaglue will run a full sync after N consecutive incremental syncs.

    associations_to_fetch string[]

    A list of associated objects to fetch when syncing this object. If empty or unspecified, no associations will be fetched. Only relevant for Hubspot.

  • ]
  • custom_objects object[]

    A list of case-sensitive custom objects to be synced. Only supported for Salesforce and Hubspot.

  • Array [
  • object stringrequired

    The custom object name (case sensitive). For Salesforce, this should end with __c.

    sync_strategy_override object

    Configuration options for "how" to sync.

    period_ms integerrequired

    Possible values: >= 60000

    The period (in milliseconds) to run the sync.

    strategy stringrequired

    Possible values: [full then incremental, full only]

    "full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.

    auto_start_on_connection boolean

    If true, the sync will start automatically when the connection is created. Default: true

    full_sync_every_n_incrementals number

    If set, Supaglue will run a full sync after N consecutive incremental syncs.

    associations_to_fetch string[]

    A list of associated objects to fetch when syncing this object. If empty or unspecified, no associations will be fetched. Only relevant for Hubspot.

  • ]
  • entities object[]deprecated
  • Array [
  • entity_id stringrequired
  • ]
Loading...