Get Sync
Retrieve sync from sync ID
Authorizations
Response
Ok
Syncs define how data from models are mapped to destinations. Each time a sync runs, Hightouch calculates the rows that have changed since the last run, and syncs them to Sync's destination.
The sync's configuration. This specifies how data is mapped, among other configuration.
The schema depends on the destination type.
For a sync bound to a sync template this is the effective configuration:
the template's configuration with this sync's syncTemplateOverrides
applied.
Consumers should NOT make assumptions on the contents of the configuration. It may change as Hightouch updates its internal code.
The scheduling configuration. It can be triggered based on several ways:
Interval: the sync will be triggered based on certain interval(minutes/hours/days/weeks)
Cron: the sync will be triggered based on cron expression https://en.wikipedia.org/wiki/Cron.
Visual: the sync will be triggered based a visual cron configuration on UI
DBT-cloud: the sync will be triggered based on a dbt cloud job
Match Booster (type "match_booster"): the sync will be triggered after each Match Booster enrichment run of its model completes. Requires the model to have Match Booster enabled, and takes no inner schedule payload.
The id of the sync template this sync is bound to, or null when the sync
owns its configuration. A bound sync takes its destination and
configuration from the template and follows later changes to the
template; configuration is the effective merged configuration and
syncTemplateOverrides holds this sync's own values.