Order Tip Updated

This event will be sent when the tip on an order is raised in the POS after the order has been paid — for example, a driver collecting an additional tip at the door. It is currently sent for orders injected into Toast.

API Reference

driver_tip is the order's new total driver tip in the lowest denomination (e.g. cents), not the amount it changed by. Replace any driver tip you previously stored for the order with this value.

note

order.tip_updated is off by default. Turn it on under Subscribed Events in the partner portal, and it is sent for every location connected to your integration.

Ordering and idempotency

This event can arrive before, or without, an Order Confirmed event for the same order. Match it to the order by id and handle it idempotently: receiving the same driver_tip more than once must not change the result.

{
  "type": "order.tip_updated",
  "location_id": "STREAM_LOCATION_1",
  "reference_id": "PROVIDER_LOCATION_1",
  "order": {
    "id": "STREAM_ORDER_1234",
    "dsp_order_id": "DSP_ORDER_1234",
    "driver_tip": 500
  }
}