JetBrains Space
 

Sync API

Last modified: 08 August 2023

Sync API is a set of methods that let applications reliably track all changes of particular entities in Space. To track the changes, Sync API uses etags (entity versions). This approach prevents synchronization issues (e.g., due to bugs or network errors) and ensures that the data retrieved by an application is always up-to-date and consistent with the latest changes in Space.

Suppose you're developing an application that integrates Space with a third-party issue tracker. In such a scenario, your application can use Sync API to maintain a consistent state of issues – in sync with Space.

Another example of where Sync API might be helpful is applications that must track specific Space notifications, e.g., chat messages in some channel. The main job of such an application is to ensure it doesn't miss any single message in the channel. Here, an effective strategy is to use Sync API in pair with webhooks. Webhooks notify when a new message is posted, while Sync API can be periodically invoked to double-check for any missed messages (e.g., the messages could be sent during network disruptions).

Sync API is currently available for the following Space entities:

For these entities, Sync API lets you:

  • Get records of a particular entity

  • Reliably receive and process record updates