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.

toggle_availability_online

The restaurant has turned on online ordering for that ordering channel. Attributes in the toggle_availability_online event’s payload include:

Value Description

restaurantGuid

A unique Toast POS identifier for the restaurant.

data type: string

format: uuid

status

ONLINE

data type: string

reasonKey

TOGGLE_ENABLED

The machine-readable reason why the restaurant is available to accept online orders.

data type: string

reason

User enabled integration

The human-readable reason why the restaurant is available to accept orders.

data type: string

Payload for a toggle_availability_online event when a restaurant is online and has enabled online ordering

{
  "timestamp": "2021-08-23T16:40:00.063Z",
  "eventCategory": "restaurant_availability_toggle",
  "eventType": "toggle_availability_online",
  "guid": "bf12cb0a-173a-4e66-bd3c-8121d4a5287f",
  "details": {
    "restaurantGuid": "27d35c6a-7068-49f7-bee0-25e654e1227a",
    "status": "ONLINE",
    "reasonKey": "TOGGLE_ENABLED",
    "reason": "User enabled integration"
  }
}