API docs
Sous Chef Management API
Request access

Store status changed

Webhookstore.status.changed

A store's intended or observed state changed.

Delivered to your webhook URL (newUrl) when it is subscribed to this event. Return any 2xx to acknowledge; anything else is retried up to four more times. The payload carries the part of the status that changed. Read fetchStoreStatus for the whole status.

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 store.status.changed.

    Possible values: [store.status.changed]
  • 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.

  • dataStoreStatus

    The part of the store's status that changed, in the shape fetchStoreStatuses returns. A pause or a resume carries storeId and desired. A new discrepancy carries desired, observed, lastPolledAt and discrepancy.hasDiscrepancy, without a classification. Read the whole status with fetchStoreStatus.

About Store status

Whether each storefront is actually taking orders, and whether Sous Chef and the delivery platform agree about it.

Separate from Stores, which is the identity map: the brands, kitchens and storefronts you operate, which changes when your estate changes. This section is the operational layer on top of it: two reads (fetchStoreStatuses, fetchStoreStatus), two writes (pauseStores, unpauseStores) and the store.status.changed webhook, all addressed by the Store.id values fetchStores returns. It uses the same API key, organization scoping and ids, under a different route prefix (/management/store-status).

Three things are kept distinct throughout: desired is what Sous Chef is configured to do, observed is what the platform reports, and discrepancy is the classified disagreement between the two.

Scoped to the organization your API key resolves to, exactly as the directory reads are.