This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.
The webhook service checks for updates when:
-
An online restaurant has gone offline. Gone offline means the restaurant’s orders are pending. No order has been approved and auto-fired for fulfillment in the last 5 minutes. This indicates that there may be a network issue or other technical problems at the restaurant.
-
An offline restaurant has come back online. Coming back online means the restaurant has approved and auto-fired at least one order in the last 5 minutes.
The restaurant_availability webhook sends updates when
a restaurant's auto-fire device has stopped auto-approving orders for 5
minutes. The restaurant availability service runs every minute to check if
at least one order has been abandoned, meaning it has not approved and
auto-fired an order within a 5 minute period. For example, if a restaurant
stopped auto-approving orders at 9:02, the service runs at 9:03 but does
not fire a webhook event because only one minute has passed since the
order was created and not approved. When the service runs at 9:07 and the
order has still not been approved, the webhook event fires. For more
information about auto-firing orders, see Setting
up Order Auto-Firing.
|
Note |
If no webhook events are ever received, the restaurant should be considered online. This assumes you are respecting the restaurant’s available operating hours for both ASAP and scheduled orders placed for future fulfillment. |
Restaurants using Toast Online Ordering with Manual
Approval or Approval Rules configured do not trigger webhook events
with the AVAILABILITY_OFFLINE reasonKey. Only restaurants
that choose to “Send orders directly to the kitchen” are included in the
online and offline webhook alerts for this scenario. Restaurants can
configure their approval options in the Toast administration back-end.
These settings do not apply to online ordering integration partners.
Orders sent via the orders API are immediately auto-fired to the kitchen.
For more information, see Orders API Limitations.
For more information about webhooks, see Using webhooks and webhooks data schema.