Skip to main content

Omni Menu Publisher V1: Getting Started

Example Workflow

This workflow describes how the Omni Menu Publisher supports syncing menus between the data maintained on Omni and a partner:

  1. When Omni detects that a menu has changed, it notifies the partner that there is a new menu available by sending a POST request to a webhook URL defined by the partner during onboarding.

  2. Depending on the partner's requirements, the body of the POST request contains the following information:

    1. A URL to the Omni Menu Webhook - The Menu Webhook URL includes a SICOM_Menu_ID value and is used to request the new menu in JSON format.

      • The Partner sends a GET request to the Menu Webhook URL to obtain the menu JSON. See the Get Menu API operation definition for details.

    2. A menu reference ID - The reference ID will be used as a URL parameter in a predefined Menu Webhook URL, which the partner uses to request the new menu in JSON format.

      • The Partner sends a GET request to the Menu Webhook URL to obtain the menu JSON. See the Get Menu API operation definition for details.

    3. A full menu in JSON format - The new menu is included in the body of the request.

      • The Partner ingests the menu directly into their system.

  3. Once the partner has obtained the menu in JSON format, the Partner ingests the menu into their system. See the Substitution Lists and Menu Construction topics for details.

  4. When the menu has been processed, the Partner sends a notification to Omni that indicates whether the menu update operation was successful. See the Update Status operation definition for details.

See also: