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.

Restaurant availability webhook

The restaurant_availability webhook allows you to receive real-time information about a restaurant's ability to accept online orders. The restaurant_availability webhook sends a message when:

  • The Toast Autofire™ device has stopped approving online orders.

  • A third-party online ordering channel (for example, Uber Eats, DoorDash, or Grubhub) was turned on or off in the Toast administration back-end.

The restaurant_availability webhook has two event categories:

  • restaurant_availability

  • restaurant_availability_toggle

When you receive a webhook event for the restaurant_availability event category, the eventCategory value is set to restaurant_availability and the eventType is set to one of the following:

When you receive a webhook event for the restaurant_availability_toggle event category, the eventCategory value is set to restaurant_availability_toggle and the eventType is set to one of the following:

Note

Multiple webhook messages can be sent from Toast depending on the scenario.

For more information about webhooks, see Using webhooks and webhooks data schema.