The Data Sync feature serves to synchronize merchant's data from Storyous to third-party systems.The third-party integrator implements an endpoint (webhook receiver).Storyous then regularly sends the changed data (if any) to the endpoint in the form of a webhook payload.Data are separated to domains, each domain has its own schema and is sent in a separate request.
The data sync feature has to be enabled on Storyous side for each place (store). New data are then regularly sent to a custom webhook URL.To set it up, we need to know:
the webhook URL
a secret string that’s sent in the Authorization header with each request
method used to sync data (POST or PUT)
the date from which the data should be synced
The receiver of the data has to implement the endpoint, Storyous Data Sync then sends following payload to that endpoint.The synced entities are separated to various “data domains”, each request sends entities of a single domain (defined in the dataDomain field).The data field contains array of entities that were created / updated since the last successful sync. The entity schema vary for each data domain and is documented bellow.One record can be synced multiple times on change and some domains' data are even shared across all the places (stores) of the merchant (items, stocks, etc.), so the receiver has to handle the data accordingly based on the id.