Sync Management Links
This guide will walk you through configuring customer syncs via Sync Management Links.
These features are only available for Census Embedded customers. If you don’t see these options, please reach out to Customer Support.
Sync Management Links allow your customers to seamlessly configure which data to import or export.
Configuring customer syncs is easy.
- Generate a Sync Management Link for your customer.
- Your customer configures what data they want synced.
- The sync appears in your Census workspace.
By default, a Sync Management Link will expire after 24 hours. If you’d like them to last longer for your account, you can update this setting in your organization settings. You can also customize where users will be redirected after adding a new sync, as well as the logo that is used.
You can generate Sync Management Links via the Sync Management Link API. We recommend generating them just-in-time when users request to configure syncs from your application.
The URI of a Sync Management Link can contain additional parameters to pre-fill fields in the embedded Sync Wizard.
source_connection_id
(Integer): The ID of a Source Connectionmodel_id
(Integer): The ID of a Modeltable_catalog
(String): The catalog name for warehouse table selection. Requires asource_connection_id
. It is recommended you use the source objects endpoint to check for the list of valid tables and their metadata. If you need to refresh these tables, you can trigger a table refresh.table_schema
(String): The schema name for warehouse table selection. Requires asource_connection_id
andtable_catalog
.table_name
(String): The table name for warehouse table selection. Requires asource_connection_id
,table_catalog
andtable_schema
.segment_id
(Integer): The ID of a Segmentcohort_id
(Integer): The ID of a Cohortsource_hidden
(Boolean, default false): Hides theSelect a Source
section of the Sync Wizarddestination_connection_id
(Integer): The ID of a Destination Connectiondestination_object_name
(String): Thefull_name
of a Destination Objectdestination_hidden
(Boolean, default false): Hides theSelect a Destination
section of the Sync Wizard
An example of using some of these query params in a Sync Management Link:
An example using table parameters:
You can fetch information about your table catalog, schema, and name using the source objects endpoint. You can also trigger a refresh of the tables if the data is stale.
Note: These parameters are meant to provide a way to simplify the UX experience of the Sync Wizard for your users, and should not be thought of as an additional access control policy above what Census already provides via Workspaces and User Roles.
Once you’ve generated the sync management link, you can send it directly to your customer to fill out, or embed the link directly in your application using Embedded Sync Management Links.