Once a data aggregation process has been completed, a notification request will be made to the webhook provided in the request payload. This is an outgoing request made by Doshii.
Note: In some cases, direct access may be granted to the actual file storage, in which case, once the webhook notification has been received, the aggregated data files can be directly obtained from their storage, bypassing the need for making further download requests (GET) for each file.
The webhook request will be issued using the POST HTTP method. In addition to the headers mentioned below, the process will also use any headers specified in the initial bulk data request. Either a 200 or 201 is expected to be returned to consider the webhook call successful.
Headers
Response
Examples
Request
HTTPS/1.1
POST {webhook.uri}
Content-Type: application/json
Content-Length: 156
{
"requestId": "e1182944-3b97-4ac3-9839-d1a7b56c2c79",
"requestCreatedAt": 1539665129,
"status": "complete",
"requestCompletedAt": 1539665329,
"files": [
{
"uri": "/we23XDs1/e1182944-3b97-4ac3-9839-d1a7b56c2c79/fileName.json.gzip",
"size": 10002,
"expires": 1542933823
}
],
"tally": {
"locations": 1,
"orders": 100,
"transactions": 105,
"amount": 1200
}
}