Syncing Data

Pre-Requisites

To follow the recommended onboarding sync pattern, organisations should have already created their permission and preferences configurations which accurately reflect their personal data processes.

Onboarding (Recommended Pattern)

We would recommend to customer organisations that imports are completed first, to generate the existing customer records and state using the import UI functionality.

Once complete, you can set up a subscription webhook (if choosing a real time integration) and run a test on a dummy citizen which can be easily deleted later. This will ensure the integration is configured correctly, and data is arriving as expected.

🚧

Beware API rate limits

Avoid large volumes of API calls being made to your target system and possibly breaching API rate / volume limits by only enablling webhok subscriptions after the main data loads have completed.

Use the data export tool to generate a file with the baseline data for all records, and import this back to your downstream systems.

Finally start the live data processes that push updates to DataGuard, these will then come through in real time via the subscription webhook, or can be downloaded periodically via the data export tool.

Additional Step for SCV Customers

Some customers may run a Single Customer View (SCV) which matches potential duplicate records. If this is the case then a link file which maps the IDs should be loaded over the API between step one and step two. Details on how the citizen linking works is available here.