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 menus
webhook sends a message when a restaurant that
uses your integration has published a change to its menus. The message
payload includes the GUID of the affected restaurant and a timestamp for
when the restaurant last published its menus. Having this information allows
your integration client to request
a new menu, keeping your integration in sync with the Toast platform.
The menus
webhook is the preferred method for determining if
the menu data you have for a restaurant has gone stale.
If you are using the menus
webhook, Toast support
recommends also polling the /metadata
endpoint of the menus API
every 30 minutes. This provides a backup in case your integration misses a
message from the menus
webhook. The /metadata
endpoint provides an alternative method for determining if a restaurant has
published changes to its menu. Using the /metadata
endpoint,
you can retrieve the most recent date and time that a restaurant's menu was
published. For more information on the /metadata
endpoint, see
Determining If a Restaurant's Menu Data Has Gone Stale.
When a message is published to your webhook endpoint for the
menus
event category, the eventCategory
value is
set to menus
. Currently, menus_updated
is the only
eventType
for the menus
event category. For
details on the payload for this event type, see menus_updated.