Skip to content

Menu Publish Flow

This flow describes the process of publishing a menu to an integrated service and syncing the current menus with our Public API.

Menu Publish Flow

  1. Public API sends the “send menu” webhook event, requesting the partner application to send the currently available menus for a given store in an integrated service.

  2. The partner application sends the webhook event result containing the current menus for the store. Public API will take the current menus and attempt to intelligently match our menu entities to what already exists in the partner menu.

  3. Public API sends a menu publish webhook event containing the matched and new menu entities. Matched entities will have the ids that were sent in the previous step or in previous menu syncs. New menu entities will have random UUIDs and those entities that should be deleted will be omitted from the webhook payload.

  4. The partner application must perform the menu publish operation for the given store in an integrated service and then send the event result containing the ids for newly created menu entities.