{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-api-explorer/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Notification events","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"notification-events","__idx":0},"children":["Notification events"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"new-order","__idx":1},"children":["New order"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a new order is created by the App, we will trigger a notification via the integration that you have implemented. There are two events that can mean that the order has been created: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_CREATED"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_ACCEPTED"]},"."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_ACCEPTED"]}," will be only sent if the merchant confirmed the order in the App (eg. on a provided tablet)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"order-status-updates","__idx":2},"children":["Order status updates"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following event types can be sent when an order status is updated."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sent-to-the-pos","__idx":3},"children":["Sent to the POS"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Order status event"},"children":["Order status event"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"POS must support"},"children":["POS must",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"support"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_CREATED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been created on the App"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_ACCEPTED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been accepted by the merchant eg. on a tablet provided by the App"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_CANCELLED_BY_MERCHANT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been cancelled by the merchant."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_CANCELLED_BY_CUSTOMER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been cancelled by the customer."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_FULFILLED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been fulfilled."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sent-to-the-app","__idx":4},"children":["Sent to the App"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Order status event"},"children":["Order status event"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Mandatory for POS"},"children":["Mandatory",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"for POS"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_ACCEPTED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been accepted by the POS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_REJECTED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been rejected by the POS or POS failed to accept that order within 2 minutes."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_BEING_PREPARED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order is being prepared."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_READY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order is marked as ready by POS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_OUT_FOR_DELIVERY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been dispatched for delivery."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_FULFILLED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been picked up by the customer and is fulfilled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_CANCELLED_BY_MERCHANT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been cancelled by the POS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORDER_CANCELLED_BY_CUSTOMER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order has been cancelled by the customer."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sample-event","__idx":5},"children":["Sample event"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"ORDER_ACCEPTED\",\n  \"data\": {\n    \"id\": \"2688fcf2-44dd-4c72-88ac-79d0910f2933\",\n    \"uri\": \"https://api.tyro.com/connect/orders/2688fcf2-44dd-4c72-88ac-79d0910f2933\",\n    \"resource\": \"order\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Registering webhooks"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For information on how to register for webhooks and how to interpret the webhook message. Documentation can be found here: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/getting-started/notification-events/webhooks"},"children":["Webhooks"]}]}]}]},"headings":[{"value":"Notification events","id":"notification-events","depth":1},{"value":"New order","id":"new-order","depth":2},{"value":"Order status updates","id":"order-status-updates","depth":2},{"value":"Sent to the POS","id":"sent-to-the-pos","depth":3},{"value":"Sent to the App","id":"sent-to-the-app","depth":3},{"value":"Sample event","id":"sample-event","depth":2}],"frontmatter":{"seo":{"title":"Notification events"}},"lastModified":"2026-09-03T03:45:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-explorer/ordering/1.0/notification-events","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}