stores.sync is the batch counterpart to store.updated. Fire emits it when multiple stores need to be propagated in bulk — for example, during initial onboarding or a mass configuration change.
Fire splits large batches automatically and emits multiple stores.sync events with up to 50 stores each. Your system should handle each event independently.
Payload
Fields
data
| Field | Type | Description |
|---|---|---|
account | string | Account identifier — required by downstream systems |
country | string | Country identifier — required by downstream systems |
batchIndex | integer | Position of this batch (1-based) |
batchTotal | integer | Total number of batches in this sync |
stores | object[] | Store configurations — same structure as store.updated |
channels | object[] | Channel configurations — same structure as store.updated |
Processing
Process eachstores.sync event independently. Use batchIndex and batchTotal to track progress if your system needs to know when a full sync is complete.
Each batch event is delivered and retried independently. If one batch fails, only that batch is retried — not the entire sync.
When does Fire emit this event?
- During initial client onboarding
- After a mass configuration change affecting many stores
- On explicit sync requests triggered from the Fire dashboard
store.updated instead.
