Every-Time Sync Flow

The following steps need to be followed each time you push new data to Zluri:

Start Data Sync

This step starts a new sync session. Once initiated, Zluri will generate a unique syncId that you will use for all data uploads during this session.

Important Notes

  • One Active Sync at a Time: Only one sync can be active per instance at any given time.
  • Unique Tracking: Each sync session is assigned a unique syncId, used to upload data.
  • Immutable After Completion: Once you finish a sync, it becomes read-only and cannot be edited.

Upload Data

Once your sync is initialized, use the syncId to upload data in a paginated manner. You can send data for one or more entities (like userstransactions, etc.) in multiple pages.

Understanding Data Types

Zluri SDK supports two kinds of data models during a sync session:

Snapshot Data (Current State)

AspectDescription
WhatIt is a point-in-time representation of current data
ExamplesUsers, Groups, Group Users
BehaviorIt replaces any previously uploaded snapshot data

Incremental Data (Historical Events)

AspectDescription
WhatIt's a time-stamped record of events
ExamplesUser Activity, Transactions, Contracts
BehaviorAppended as new entries in historical logs

Uploading Multiple Entities in a Single Sync(Recommended)

You can upload different types of data—like users, groups, user groups, and user activity—together in one sync session. This helps you send all related data in one go, making the sync process faster and more organised.

Important Notes:

  • Each entity must include a pageNumber to support paginated uploads.
  • Uploading the same entityName and pageNumber again will overwrite the previous data for that page.
  • A maximum of 1,000 records is allowed per page.

Finish Sync

Finalise the sync session and trigger Zluri’s backend processing. Finish Sync signals that all data has been uploaded and triggers Zluri's processing pipeline.

Important Notes

  • Once finished, the sync cannot be modified.
  • Processing starts automatically after finishing.
  • You'll receive email notifications about the processing status.

Example Flow:

  1. Initialize sync
  2. Upload users (pages 1–5)
  3. Upload applications (pages 1–3)
  4. Upload user_activity (pages 1–10)
  5. Finish sync