Webhooks

Picking Webhooks

WEBHOOKTYPEFUNCTION
Picking Status Update đź”—POSTWhen a store process order picking status updates, this webhook can be set to receive these events
Amendments đź”—POSTWhen a store processes amendments for one or more items within an order, this webhook will deliver the amendment details
Substitutes đź”—GETThis is a GET webhook provided by the channel, which returns valid substitute item PLUs for any requested substitution

CHANNEL API

Receive real-time event notifications for key order, menu, and store updates via Channel API webhooks;

WEBHOOKTYPEFUNCTION
Register Channel đź”—POSTAny channel integrator will provide a standardised registration URL to facilitate customer onboarding/offboarding.
Menu Sync đź”—POSTCustomers will publish their menu to a provided webhook URL. This delivers JSON containing all the necessary attributes to display their menu as intended.
Snooze/Unsnooze Products đź”—POSTWhen items are out of stock or temporarily unavailable, a 'snooze' event will be sent to instruct channels to make the items unavailable. Similarly, when back in stock/available, an 'unsnooze' event will be sent.
Busy Mode đź”—POSTWhen a store is paused a webhook event will be sent to ensure no further orders can be received. When re-opened an event will be sent for to set the store back online.
Courier Status Update đź”—POSTCourier-related updates can be sent to update on new information about the courier journey as soon whenever a change applies
Order Status Update đź”—POSTWhenever a POS updates the status of an order, a webhook event is sent
Preparation Time Update đź”—POSTA webhook will be sent to indicate a preparation time update for an order has been applied.