Webhooks

WEBHOOKTYPEFUNCTION
Register Channel đź”—POSTAny channel integrator will provide a standardised registration URL to facilitate customer onboarding/offboarding.
Checkout Update đź”—POSTTriggered after a customer completes checkout. Sends the final basket and checkout status to your endpoint.
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 is sent to instruct channels to make items unavailable. When items become available again, an unsnooze event is sent.
Busy Mode đź”—POSTWhen a store is paused, a webhook event is sent to ensure no further orders can be received. When re-opened, an event is sent to set the store back online.
Courier Status Update đź”—POSTCourier-related updates are sent to provide new information about the courier journey whenever a change applies.
Order Status Update đź”—POSTWhenever a POS updates the status of an order, a webhook event is sent with the updated order details.
Preparation Time Update đź”—POSTA webhook is sent to indicate that a preparation time update for an order has been applied.