Operational Callback

Purpose

This will be called when certain operational processes have been actioned. At present, this includes events where menus are published.

The content of the webhook event provides information on the success of each operation and specifies which channel the event relates to e.g. Menu A was published to Channel B.

To test this out, you can add the webhook URL in the Location settings of your staging environment within the 'Operations Webhook URL' field. If using this endpoint, it should be provided by the POS as part of the registration flowRegister POS.

Parameters

Attribute	Description	Type
`eventType`	This will be the type of operation and for the Menu API will be `"menupush"`	str
`referenceId`	This is an identifier of the single report	str
`accountId`	The customer account associated with the request	str
`locationId`	The customer location associated with the request	str
`channelLinkId`	The channel for which the request is associated	str
`channel`	This is the global identifier of the channel the request is for Get Integrated Channels	int
`reportId`	The unique operation report Id of the menu publish event	str
`reportUrl`	A unique URL directing to frontend operations report	str
`status`	The final state of the operation	str
`menus`	List of internal menu IDs which were published from Deliverect frontend	array str
`externalMenuIds`	Where external menu IDs, supported, this is a list of those published	array str

Statuses

Status	Description
`success`	The menu publish operation was completed successfully
`failed`	The menu publish operation was not completed successfully (a retry would be required)

📘
Final Status
We return the final operation status to the specified endpoint. This does not included intermediary statuses.

[
    {
        "eventType": "menuPush",
        "accountId": "6**f578fa205bc3eca854***",
        "referenceId": "main_report_id",
        "reportId": "individual_report_id",
        "reportUrl": "https://frontend.staging.deliverect.com/operationreports/{operationId}?account={accountId}",
        "status": "success",
        "menuPush": {
            "locationId": "6**91e9273d6950b4b0a8***",
            "channelLinkId": "626a**********ce3ce2",
            "channel": 4,
            "menus": [
                "63211f**********6032fe65"
            ],
            "externalMenuIds": [
                "pos_menu_1234"
            ]
        }
    }
]

[
    {
        "eventType": "menuPush",
        "accountId": "6**f578fa205bc3eca854***",
        "referenceId": "main_report_id",
        "reportId": "individual_report_id",
        "reportUrl": "https://frontend.staging.deliverect.com/operationreports/{operationId}?account={accountId}",
        "status": "failed",
        "menuPush": {
            "locationId": "6**f578fa205bc3eca854***",
            "channelLinkId": "6**f578fa205bc3dfa8334***",
            "channel": 4,
            "menus": [
                "63211f**********6032fe65"
            ],
            "externalMenuIds": [
                "pos_menu_1234"
            ]
        }
    }
]