Skip to main content

Events API Changelog

2026-10-22​

Added​

  • Added an optional dsp_fees field to the order.confirmed payload. It carries customer-paid fees that are collected with the order but remitted to the ordering platform rather than kept by the merchant, such as a small order fee, in the lowest denomination. It is omitted when the order has no such fees. Read More

Changed​

  • total on the order.confirmed payload now includes dsp_fees, so it matches the amount the customer was charged at checkout. Previously these fees were left out of total. If you use total as merchant revenue, subtract dsp_fees. Read More

2026-10-08​

Added​

  • Added an optional courier_tracking_url field to the order.confirmed payload. On Uber Eats orders delivered by the merchant's own courier (merchant_managed_delivery), it carries a courier-facing link that opens the Uber Driver app so the courier shares live location with Uber. Do not show it to customers. It is omitted on all other orders, so existing integrations are unaffected. Read More

2026-10-01​

Added​

  • Added self-service event subscriptions to the partner portal. On the Events API integration page, Subscribed Events lets you turn each event type on or off yourself, and your choice applies to every location connected to your integration. You no longer need to ask Stream to turn event types on per location. If you haven't made a choice, you receive the default events only: order.confirmed, order.updated and order.canceled. order.tip_updated, delivery.status_updated and any new event types are off until you turn them on. Read More

2026-09-25​

Added​

  • Added the order.tip_updated event, sent when an order's tip is raised in the POS after it was paid (currently Toast). The payload carries the order's new total driver_tip. It can arrive before or without order.confirmed, so handle it idempotently by order id. This event is opt-in — it is not enabled automatically; contact Stream to start receiving order.tip_updated events. Read More

2026-09-08​

Added​

  • Added optional is_future_order and future_order_fulfillment_time fields to the order.confirmed payload, identifying scheduled/future orders and the epoch-millisecond time they are requested to be completed. Both are omitted on immediate orders, so existing integrations are unaffected. Read More

Changed​

  • estimated_fulfillment_time is now always populated on scheduled/future orders. Previously it could be sent as null for a future order, since the requested time was only carried on an internal future-order field; it now falls back to future_order_fulfillment_time so the required field is never null. Read More

2026-08-12​

Added​

  • Added a customers array to the order payload of the order.confirmed event. For single-customer orders it contains exactly one element. Read More
  • Added an optional provider_loyalty_id to customer objects, carrying the customer's loyalty program identifier when the ordering platform supplies one. Orders without a loyalty identifier omit the field, so existing integrations are unaffected. Read More
  • Documented cash_amount_due on the order.confirmed payload. When an order is unpaid (for example drive_thru), this is the cash amount to collect at fulfillment in the lowest denomination; it may be less than total when the ordering platform funds benefits that are not sent as discount lines. The field has been sent since 2026-05-04 and was already documented on the DSP and POS APIs — this adds the missing Events API documentation. Read More

Changed​

  • Deprecated the singular customer field on the order.confirmed payload in favor of customers. It is still populated with the first customer for backwards compatibility, so no action is required to keep existing integrations working.
  • Corrected the documented merchant cancellation status value. The API spec previously listed the order.canceled merchant status as canceled; the value Stream actually sends is merchant_canceled, which is what the Order Canceled page has always shown. No behavior changed — only the spec was wrong. If your integration matches on canceled for merchant cancellations, switch to merchant_canceled.

2026-07-06​

Added​

  • Items and modifiers in the order.confirmed event now include a stream_id — the Stream catalog ID matching the stream_id exposed on the DSP menu — so order contents can be reconciled against stored menu data instead of by name. Read More

2026-06-29​

Added​

  • Modifiers in the order.confirmed event can now contain their own nested modifiers array, allowing multi-level modifier selections to be represented. The field is only present when a modifier has nested selections, so existing integrations are unaffected. Read More

2026-06-08​

Added​

  • Added pos_order_id to the order payload of the order.confirmed event — the POS order identifier for the order submitted into the POS system. Read More

2026-01-28​

Added​

  • New event: order.update.driver.location - Send real-time driver location coordinates during delivery. Read More

2026-01-14​

Added​

  • New event: driver.status_updated - Triggered when a driver's delivery status is updated. Read More

2024-08-23​

Added​

  • Webhook support for assigning a driver to a delivery order and updating a delivery order's status. Read More