Currently the webhook system for Orders handles two types of events. The Order and the Rider types events:

Order type events:

  • order-accepted
  • order-in-kitchen
  • order-ready-to-pick-up
  • order-picked-up
  • order-served
  • order-canceled

Rider type events:

  • rider-created
  • rider-picking
  • rider-delivering
  • rider-completed
  • rider-error

Event order-accepted


Sent to know that an order has been created.

APP SCOPE
ChannelPosRidersLoyalty
✖️✔️✖️✖️
WEBHOOK FORMAT
{
  "eventType": "order-accepted",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated

Event order-in-kitchen


Sent to know that an order has been received by the POS and will be prepared.

APP SCOPE
ChannelPosRidersLoyalty
✔️✖️✔️✔️
WEBHOOK FORMAT
{
  "eventType": "order-in-kitchen",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated

Event order-ready-to-pick-up


Sent to know that an order which the fulfillment.type is delivery-by-location is ready to be picked up.

APP SCOPE
ChannelPosRiderLoyalty
✔️✖️✔️✖️
WEBHOOK FORMAT
{
  "eventType": "order-ready-to-pick-up",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated

Event order-picked-up


Sent to know that an order which the fulfillment.type is takeaway has been picked up by the customer.

APP SCOPE
ChannelPosRiderLoyalty
✔️✖️✖️✖️
WEBHOOK FORMAT
{
  "eventType": "order-picked-up",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated

Event order-served


Sent to know that an order which the fulfillment.type is order-at-table has been served to the customer.

APP SCOPE
ChannelPosRiderLoyalty
✔️✖️✖️✖️
WEBHOOK FORMAT
{
  "eventType": "order-served",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated

Event order-canceled


Sent to know that an order has been canceled.

APP SCOPE
ChannelPosRiderLoyalty
✖️✔️✔️✔️
WEBHOOK FORMAT
{
  "eventType": "order-canceled",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated

Event rider-created


Sent to know that an order has been take in charge for the delivery by a rider.

APP SCOPE
ChannelPosRiderLoyalty
✔️✔️✖️✖️
WEBHOOK FORMAT
{
  "eventType": "rider-created",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated

Event rider-picking


Sent to know that a rider is on his way to the restaurant in order to pick the order.

APP SCOPE
ChannelPosRiderLoyalty
✔️✔️✖️✖️
WEBHOOK FORMAT
{
  "eventType": "rider-picking",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated

Event rider-delivering


Sent to know that a rider is on his way to the customer in order to deliver the order.

APP SCOPE
ChannelPosRiderLoyalty
✔️✔️✖️✖️
WEBHOOK FORMAT
{
  "eventType": "rider-delivering",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated

Event rider-completed


Sent to know that the delivery process of an order has been completed correctly.

APP SCOPE
ChannelPosRiderLoyalty
✔️✔️✖️✖️
WEBHOOK FORMAT
{
  "eventType": "rider-completed",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated

Event rider-error


Sent to know that an error occurred during the process of delivery of an order.

APP SCOPE
ChannelPosRiderLoyalty
✔️✔️✖️✖️
WEBHOOK FORMAT
{
  "eventType": "rider-error",
  "storeId": "string",
  "data": {
    "orderId": "string"
  }
}
FIELDS SPECIFICATION
FieldDescription
eventTypeThe type of event
storeIdThe storeId where the event occurred
data.orderIdThe orderId in which the status was updated