Subscribed Events
You choose which event types Stream sends to your webhook yourself, from the Partner Portal > Integrations > Events API page. What you set there applies to every location connected to your integration. You no longer need to ask Stream to turn an event type on location by location.
Event types
| Event type | On by default | Sent when |
|---|---|---|
order.confirmed | Yes | An order was accepted and sent to the POS |
order.updated | Yes | An order's status changed, for example ready for pickup |
order.canceled | Yes | An order was canceled by the merchant or the ordering platform |
order.tip_updated | No | The driver tip was changed in the POS after checkout |
delivery.status_updated | No | The delivery status of an order changed |
Switch an event type on or off with its toggle. The change applies to all of your integrated locations, so you don't need to change anything per merchant or per location.
Defaults
Until you change any toggle, the section shows Using defaults. In that state you receive the
three default events only: order.confirmed, order.updated and order.canceled.
If you are waiting for order.tip_updated or delivery.status_updated and they never arrive,
check whether you turned them on. They are off by default, and there is no error or notification
telling you they are being skipped. Turn them on in the portal and Stream starts sending them for
every connected location.
New event types
When Stream adds a new event type, it starts out off. Stream will not start sending a payload your handler has never seen. Read the event's page and the changelog, make sure your webhook handles it, and then turn it on.
Your webhook should still return a 2xx for any event type it does not recognise rather than
failing it. See Responding to Events.
How this combines with feature flags
Subscribed events decide which event types you receive. The fulfillment type and order source filters decide which orders generate events. Both apply: you receive an event only when its type is switched on here and the order passes your configured filters.