The types of webhook notifications that can be sent
Should not be used in normal operation
Sent when the outlet has processed one or more orders (as confirmed / rejected). Body will Include the archived view of the processed orders.
Links to ResponseBody of ProcessedOrdersWebhookBody
Sent when ROS has detected a menu update OR when it is recovering from a connectivity failure that may have prevented it seeing an update event.
It is NOT a guarantee that the menu has changed, only an indication that a request should be made for the latest menus to prevent a Provider/Outlet desync.
This event will also be sent when an outlet has added/enabled configuration for a provider
Links to ResponseBody of MenuUpdatesWebhookBody
Sent when ROS has been informed by the outlet that a particular remote order has been fully prepared by the kitchen and is ready to be picked up / delivered
This is NOT guaranteed to be sent, it is up to the Outlet and their hardware/software configuration whether this gets sent or not.
Links to ResponseBody of OrderPreparedWebhookBody
Sent whenever ROS has been informed by the outlet they are disabling / removing the configuration for the provider.
The provider should cease accepting/sending remote orders for this outlet when receiving this notification.
Future attempts to send to this outlet will fail.
If the configuration is re-enabled, a MenuUpdate will be sent.
Links to ResponseBody of OutletDisabledWebhookBody
Sent whenever ROS has been informed by the outlet that a particular product's stock level has changed in a "significant" manner. It's not
designed to be able to allow fine grained tracking of individual stock levels but should provide enough information about a product that is running
low on stock / out of stock before a user orders it.
Links to ResponseBody of ProductStockLevelWebhookBody
Sent directly from the POS system on site (if feature is enabled) whenever a product's stock level changes. This is designed to allow fine grained tracking of individual stock levels in near real time.
WARNING: There may be significantly more webhook traffic when this feature is enabled if the site tracks stock on a large number of products.
IMPORTANT: Retry attempts for this webhook notification type are limited and the server processing the webhook notification is expected to respond with OK 200 within a few seconds of receiving the notification.
Links to ResponseBody of LiveProductStockLevelWebhookBody