API docs
Sous Chef Management API
Request access

Order delivery updated

Webhookorder.delivery.updated

Courier lifecycle for a platform-delivered order.

Delivered to your webhook URL (newUrl) when it is subscribed to this event. Deduplicate on the envelope's id: successive courier transitions for one order are separate events and carry separate ids, so a key built from the order id and the event type would collapse them and lose one.

Request

application/json
required
  • idstring

    Unique event id, and your deduplication key.

    A delivery that is not acknowledged is sent again, and deliveries are unordered, so you will receive the same event more than once. Every retry of one delivery carries the same id. Two legitimate transitions of the same subject are two different events and carry two different ids. newUrl and the legacy webhook feed assign their ids separately.

    Key your idempotency on this field alone. Nothing else in the payload is a deduplication key: timestamp is the moment the attempt was sent and differs between copies of one event.

  • eventstring

    Always order.delivery.updated.

    Possible values: [order.delivery.updated]
  • timestampstring<date-time>

    When this delivery was sent, not when the event happened. Order by the transported state, never by arrival.

  • organization_idstring

    Your organization id. The legacy webhook feed also carries it on the delivery's X-Organization-ID header.

    Snake case on this one field is a long-lived wire value; every other field on this API is camelCase.

    Treat it as a sanity check, never as proof of origin: it is a value inside a body anyone who learns your URL can POST. Proof of origin is the X-SousChef-Signature header, which every delivery to your newUrl carries on every attempt (the same value is also sent as X-OneTablet-Signature, for backward compatibility); see "Verifying webhook signatures". Order events delivered to the legacy webhook feed (legacyUrl) carry no signature.

  • dataOrder

    The order, carrying its new deliveryStatus.

About Orders

Read the orders placed with your restaurants.

Start an integration here. Poll fetchOrders for the orders Sous Chef has accepted on your behalf across every delivery platform you are connected to. Orders are normalized into one shape, whether they arrived from DoorDash, Uber Eats, Grubhub or a direct channel.

Two conventions hold everywhere on this API. Money is always an integer in the currency's minor unit: 1250 is $12.50. Times are always ISO-8601 in UTC. The API does not convert them to a store's local time.

All endpoints are POST with a single JSON body, and the path carries no version segment. Changes to this API are additive (new fields and new endpoints, never removals or narrowing), so there is no versioned cutover.