Public API
Orders API
Subscribing to Order Notifications
4min
subscribing to order notifications subscribing to order notifications works in the same way as for other event subscriptions documented in the subscription api docid\ vmkcbjsfouh t4dt406 k section please refer to this section for detailed information, including what input fields and enums are available when subscribing to order notifications please use evententity enum of order eventkey enums of submitted , accepted , rejected , cancelled , uncancelled parententity enum should be caterer variables below is a example of the variables that would be used with subscription create docid\ ywds1a gxebjwkne8v90s to subscribe to order notifications variables { "subscriptionparams" { "evententity" "order", "eventkey" "accepted", "parententity" "caterer", "parentid" "ezcater caterer id", "subscriberid" "your subscriber id" } } notifications notification submitted { "id" "notification id", "parent type" "caterer", "parent id" "ezcater caterer id", "entity type" "order", "entity id" "your ezcater order id", "key" "submitted", "created at" "2025 04 15 23 48 23 utc", "occurred at" "2025 04 15 23 48 21 utc", "updated at" "2025 04 15 23 48 23 utc", "payload"\ null } notification accepted { "id" "notification id", "parent type" "caterer", "parent id" "ezcater caterer id", "entity type" "order", "entity id" "your ezcater order id", "key" "accepted", "created at" "2025 04 15 23 48 23 utc", "occurred at" "2025 04 15 23 48 21 utc", "updated at" "2025 04 15 23 48 23 utc", "payload"\ null } notification failed { "id" "notification id", "parent type" "caterer", "parent id" "ezcater caterer id", "entity type" "order", "entity id" "your ezcater order id", "key" "rejected", "created at" "2025 04 15 23 48 23 utc", "occurred at" "2025 04 15 23 48 21 utc", "updated at" "2025 04 15 23 48 23 utc", "payload"\ null } example cancelled { "id" "notification id", "parent type" "caterer", "parent id" "ezcater caterer id", "entity type" "order", "entity id" "your ezcater order id", "key" "rejected", "created at" "2025 04 15 23 48 23 utc", "occurred at" "2025 04 15 23 48 21 utc", "updated at" "2025 04 15 23 48 23 utc", "payload"\ null } order event notification flows after initial order submitted and accepted or rejected notifications, the only notifications for an order are accepted , rejected , and cancelled below are some example order notification flows order submitted subscription notifications will be received for submitted order submitted > accepted subscription notifications will be received for submitted , accepted order submitted > rejected subscription notifications will be received for submitted , rejected , cancelled order submitted > rejected > uncancelled subscription notifications will be received for submitted , rejected note no uncancelled notification will be received, however once it is re `accepted` or rejected other webhooks will be received gp difference between this and the following flow? order submitted > rejected > uncancelled > accepted subscription notifications will be received for submitted , rejected , accepted note no uncancelled notification will be received order submitted > accepted > cancelled > uncancelled subscription notifications will be received for submitted , accepted , cancelled note no uncancelled notification will be received, however once it is reaccepted or rejected other notifications will be received order submitted > accepted > cancelled > uncancelled > accepted subscription notifications will be received for submitted , accepted , cancelled , accepted note no uncancelled notification will be received order submitted > accepted > modified > accepted subscription notifications will be received for submitted , accepted , accepted note no modified notification will be received order submitted > accepted > modified > accepted > cancelled subscription notifications will be received for submitted , accepted , accepted , cancelled note no modified notification will be received order submitted > accepted > modified > rejected subscription notifications will be received for submitted , accepted , rejected note no modified notification will be received note rejected order modifications will not result in a canceled notification, ezcater is working behind the scenes to save the order order submitted > accepted > modified > rejected > cancelled subscription notifications will be received for submitted , accepted , rejected , cancelled note no modified notification will be received order submitted > accepted > modified > rejected > cancelled > uncancelled subscription notifications will be received for submitted , accepted , rejected , cancelled note no modified notification will be received note no uncancelled notification will be received, however once it is again accepted or rejected other notifications will be received order submitted > accepted > modified > cancelled > uncancelled > accepted subscription notifications will be received for submitted , accepted , rejected , cancelled , accepted note no modified notification will be received note no uncancelled notification will be received order submitted > accepted > store changed subscription notifications will be received for submitted , accepted , ??? note agents are trained to cancel and replace orders, but if this does not happen order submitted > accepted > modified > cancelled for replacement subscription notifications will be received for submitted , accepted note no modified , cancelled or rejected notification will be received for original order submitted order submitted > cancelled for replacement subscription notifications will be received for submitted note no cancelled or rejected notification will be received for the original order submitted