Receive new or updated records

The receiver of the data has to implement the endpoint, Storyous Data Sync then sends following payload to that endpoint.

The endpoint URL may optionally contain one or more variables ({merchantId}, {placeId}, {dataDomain}) to distinguish different requests. For example setting up https://example.com/webhook/{merchantId}/{placeId}/?domain={dataDomain} as the URL would lead to requests such as https://example.com/webhook/5dea5ec89e01eb0015219138/5dea5ec89e01eb0015219139/?domain=bills.

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.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request POST 'https://your-api-server.com' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "merchantId": "5dea5ec89e01eb0015219138", "placeId": "5dea5ec89e01eb0015219139", "dataDomain": "bills", "data": [ { "id": 7031 } ] }'

Request

Responses