The Synchronization API provides the ability to aggregate, align and synchronize engineering data from different formats to an iModel. With this API, you can set up a connection with various source files and, with a job run, synchronize those to an iModel. Requests will be processed in a cloud using associated iTwin connectors. The synchronization process takes time, so it is performed as a background job.

The API offers the following:

  • File synchronization from iTwin Storage service. Background job can run up to 1 hour.
  • iTwin connectors for various design applications and interchange formats.


The synchronization process is based on connections that establish links from design files to iModels. There could be multiple connections for an iModel, and those could be executed on-demand multiple times to continuously synchronize changes. The history of runs is preserved and can be monitored.

Source File

A source file entity defines the link between a specific file in the data source and iTwin connector during the synchronization run. A source file having geographical coordinate information should be marked as a spatial root.


A run defines a single connection synchronization process and can be initialized by sending a run start request. This entity has properties like status, duration, and others. There can be only one run per connection at a time.


An iTwin connector is the part of the system that transforms and synchronizes data from different application formats into iModels. Connectors store enough information about source data to detect the differences in it between job runs.