Skip to content
Zest Docs

Groceries

ADDED_CUSTOM_ITEM

User has added a custom item to either a custom list or the global shopping list.

name
string

The name of the item.

quantity
string

The quantity of the item. Includes both the quantity and the unit.

category
string

The section of the grocery list the item can be found in.

Possible Values

bread/bakerycanned_goodsdairydelifrozen_foodsherbs_and_spicesjarred_goodsmeat/fishpantry_staplesproducemiscellaneous
isUserCreatedItem
boolean

Whether the item is a user-created item. If this is true, it means that the user added an item that wasn't already in the Zest ingredient index.

to
string

The list the item is added to.

Possible Values

<list_name>global

CHECKED_INGREDIENT_OFF

User has checked off an ingredient from the grocery list.

ingredient
string

The name of the ingredient that was checked off.

percentCheckedOff
number

The percentage of items checked off the list.

checkedOff
number

The number of items checked off the list.

total
number

The total number of items on the list.

CREATED_CUSTOM_LIST

User has created a custom grocery list.

name
string

The name of the list.

numItems
int

The number of items in the list.

items
array

The custom grocery items in the list.

id
string

The ID of the item. This will either be the ID of the ingredient in Sanity or a random UUID for a user-created item.

list_id
int

The ID of the custom list the item is in.

name
string

The name of the item.

quantity
string

The quantity of the item. Includes both the quantity and the unit.

type
string

The section of the grocery list the item can be found in.

Possible Values

bread/bakerycanned_goodsdairydelifrozen_foodsherbs_and_spicesjarred_goodsmeat/fishpantry_staplesproducemiscellaneous

MINUTES_ON_GROCERY_LIST

User has spent a certain amount of time on the grocery list. This event is sent every 5 minutes.

minutes
number

The number of minutes the user has spent on the grocery list.

percentCheckedOff
number

The percentage of items checked off the list.

checkedOff
number

The number of items checked off the list.

total
number

The total number of items on the list.