Currently the webhook system for Store handles two types of events:

  • store-schedule-update
  • store-status-update

Event store-schedule-update


Sent to know that the opening hours of a Store has been modified. Endpoint Get Store by Id must be used to retrieve the updated opening hours.

APP SCOPE
ChannelPosRidersLoyalty
✔️✖️✖️✖️
WEBHOOK FORMAT
{
  "eventType": "store-schedule-update",
  "storeId": "string",
  "data": {}
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
dataEmpty object

Event store-status-update


Sent to know that the availability of a Store has been modified.

APP SCOPE
ChannelPosRiderLoyalty
✔️✖️✖️✖️
WEBHOOK FORMAT
{
  "eventType": "store-status-update",
  "storeId": "string",
  "data": {
    "status": "string"
    "closedUntilDate": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.statusThe new Store availability status. Possible values for this field:
- open
- close
data.closedUntilDateThe date on which the shop will be reopened. Possible values:
- a date in ISO format, in case the data.status field value is close
- an empty string, in case the data.status field value is open