Packaging preferences configuration webhook

The packaging preferences configuration webhook sends you a message when a restaurant updates its packaging preferences in Toast Web. The message payload includes:

• The GUID of the restaurant changing its packaging preferences.

• The time stamp of the change.

• Details of what was changed.

For information on how a restaurant can configure packaging preferences, see this Toast Central article.

When a restaurant sets their packaging preferences, and you receive the packaging_updated webhook message with the updates, you can submit orders using the orders API with packaging preferences.

Packaging preferences configuration webhook messages follow the standard message data schema. When a message is published to your webhook endpoint for the packaging event category, the eventCategory value is set to partner and the eventType is set to packaging_updated.

packaging_updated

A restaurant using your integration has updated its packaging preferences configuration in Toast Web.

The packaging preferences configuration webhook eventType is packaging_updated. The webhook payload is similar to the packaging preferences response data from the packagingConfig endpoint.

Attributes in the packaging_updated event's payload include:

Value	Description
packagingConfig	The parent object that holds the following information about the specific packaging preference configurations. data type: string
enabled	Indicates whether the restaurant is currently using packaging preferences in this object. If TRUE, you display the packaging options to guests in your ordering interface. If FALSE, do not display the options. data type: string
items	The list of available packaging items. The items array contains the following fields and values: id: The unique identifier for a packaging item. The id is required to apply packaging preferences when you submit an order using the orders API. itemTypes: The packaging categories an item can belong to, such as napkins or condiments. One packaging item may qualify as several different itemTypes. For example, an item named "to-go items” that has itemTypes of napkins and utensils. guestDisplayName: An alternative name the restaurant team can configure for a packaging item. For example, you may select itemTypes for CONDIMENTS but have your guests see the following message: “Ketchup and mustard.” guestInclusionType: Defines how the restaurant guest should interact with the packaging preference. The available values are: OPT_IN: A guest must complete an action to include packaging preferences, such as selecting a checkbox. OPT_OUT: A guest must complete an action to opt out of packaging, such as de-selecting a checkbox. guestDescription: Further describes the packaging item, in addition to the guestDisplayName. For example, if the itemType is CONDIMENTS, and the guestDisplayName is "Ketchup and mustard", the guestDescription could show "Includes ketchup and mustard only." data type: string
guestMessage	An optional message configured by the restaurant that you show to guests on your ordering interface. data type: string

Payload example for the menus_updated event

{
 "timestamp": "2024-12-10T17:47:36.044Z",
 "eventCategory": "packaging",
 "eventType": "packaging_updated",
 "guid": "ae839da8-a506-498e-afb8-ff7d7dbd7231",
 "details": {
   "packagingConfig": {
     "enabled": true,
     "items": [
       {
         "id": "ccdbcbf8-5c5b-4158-ae61-3a6da8bc847d",
         "itemTypes": [
           "CONDIMENTS",
         ],

         "guestDisplayName": "Ketchup and mustard",
         "guestInclusionType": "OPT_IN",
         "guestDescription": "Includes ketchup and mustard only."
       }
     ],

     "guestMessage": "Choose your packaging preferences to complete your order. "
   }
 }
}