How does it work

Syncs are powered by connecting our Unified APIs to your software. We have a set of pre-built syncs that you can use as a starting point, but we can also build custom syncs for you depending on your needs.
Together with you, we define the data that needs to be synced, the frequency of the syncs and the triggers that will start the syncs.
The syncs are fully managed by us, so you don’t have to worry about the underlying infrastructure.

​

Requirements

• You have an API for your software
• You want to connect your software to one of our Unified APIs

​

How

• We define the scope together
• We build the sync for you
• We define the trigger based on your requirements (e.g. event-based or timer-based)
• We define how you want to expose the sync to your end-users (see overview)

​

What can you do ?

Based on your requirements, you can use our APIs for which you will have different endpoints that will give you the full control over the sync.
Next to the same routes to manage consumers and connections as for the Unified APIs, you will have dedicated endpoints for the syncs. For the activation:

• Share the configuration page a sync for a consumer (see share sync)
• Get the status of a sync for a consumer (see get status of a sync)
• Activate the sync for a consumer (see activate sync)
• Update settings of the sync for a consumer (see update sync settings)

For the execution status:

• Get list of executions (see get executions)
• Get information about one executions (see get executions)
• Get data of executions (see get data of executions)

Trigger a sync:

• Trigger a sync (see trigger a sync)