Authorizations
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Body
How records are synced to the destination.
append
, insert
, mirror
, update
, upsert
"mirror"
[
{
"from": { "type": "column", "data": "hashed_email" },
"to": "user_identifier.hashed_email_PREHASHED",
"is_primary_identifier": true
},
{
"from": { "type": "column", "data": "list_id" },
"to": "list_id",
"lookup_object": "user_list",
"lookup_field": "name"
},
{
"from": {
"type": "constant_value",
"data": { "value": "cohort_1", "basic_type": "text" }
},
"to": "cohort"
}
]
Source attributes Table source
- Table source
- Dataset source
- Model source
- Topic source
- Segment source
- Cohort source
A label to give to this sync.
"New Signups to Leads"
[
{
"type": "FailureAlertConfiguration",
"send_for": "first_time",
"should_send_recovery": true,
"options": null
},
{
"type": "InvalidRecordPercentAlertConfiguration",
"send_for": "every_time",
"should_send_recovery": false,
"options": { "threshold": 10 }
}
]
Set of key-value pairs that describe advanced configuration options for specific destination object types. See the specific destination's documentation for more information on available options.
{
"data_source_country": "US, GB",
"bulk_id_lookup": true
}
Specify run mode for the sync.
Whether or not this sync should be paused.
false
Specify "sync_all_properties"
to automatically update mappings.
sync_all_properties
, specific_properties
If field_behavior
is set to "sync_all_properties"
, specify how automatic mappings should be named.
start_case
, lower_case
, upper_case
, camel_case
, snake_case
, match_source_names
"snake_case"
Specify how the destination fields should be ordered. The default behavior is alphabetically by column name. Only allowed to be set on syncs with destination objects that allow field ordering. Refer to GET /destinations/{destination_id}/objects
to see if the supports_field_ordering
is present on your destination object.
alphabetical_column_name
, mapping_order
"alphabetical_column_name"
Specifies the behavior family for the sync. Use activateEvents
for event-based activation syncs (only supported for live syncs from Kafka/streaming sources). Use mapRecords
for record mapping syncs (not supported for live syncs from Materialize).
activateEvents
, mapRecords
"activateEvents"
The name of the timestamp column to use for the high water mark diffing strategy. When set, append syncs will use this column to identify new records instead of the default Census diff engine (using primary keys).
"updated_at"
DEPRECATED: Use high_water_mark_attribute
instead. This field will be removed in a future version.
The high water mark diffing strategy will allow append syncs to use a timestamp column when identifying new records instead of the default Census diff engine (using primary keys).
When true, checks if the given payload is valid to configure a sync. Does not create the sync.
true
When true, will email all workspace users with email notifications enabled and all workspace additional emails when the sync fails and recovers.
DEPRECATION WARNING -- This field will soon be deprecated in favor of the alert_attributes
object. If both this field and the alert_attributes
object are present, the alert_attributes
object will take precedence.
false
When true, will email all workspace users with email notifications enabled and all workspace additional emails when the sync has more than failed_record_notifications_threshold_percent rejected or invalid records in the source or destination.
DEPRECATION WARNING -- This field will soon be deprecated in favor of the alert_attributes
object. If both this field and the alert_attributes
object are present, the alert_attributes
object will take precedence.
false
The percentage of rejected and invalid records for which failed record emails will be triggered.
DEPRECATION WARNING -- This field will soon be deprecated in favor of the alert_attributes
object. If both this field and the alert_attributes
object are present, the alert_attributes
object will take precedence.
0 <= x <= 100
10
Specifies how the first sync should handle historical records when using append operation. Only applicable for append syncs.
skip_current_records
, backfill_all_records
"backfill_all_records"
Specifies the strategy for mirror syncs. Only applicable when operation
is set to mirror
. The strategy determines how Census keeps the destination in sync with the source data.
sync_updates_and_deletes
: Incrementally syncs changes by inserting new records, updating modified records, and deleting records that no longer exist in the source. This is the most common and efficient strategy for keeping destinations in sync.sync_updates_and_nulls
: Similar to sync_updates_and_deletes but handles null values explicitly. Updates existing records and sets fields to null when the source contains null values, without performing deletes.upload_and_swap
: Replaces the entire destination table with the current source snapshot. This strategy is useful for destinations that don't support incremental updates or when you want to ensure a complete refresh of all data.
sync_updates_and_nulls
, upload_and_swap
, sync_updates_and_deletes
"sync_updates_and_deletes"