API docs
Sous Chef Management API
Request access

Item availability changed

Webhookitem.availability.changed

Items were marked unavailable or restocked at a kitchen that sells them through your stores.

Delivered to your webhook URL (newUrl), alongside every other event you subscribed it to. Subscribe it to item.availability.changed with setAllWebhookSettings. Return any 2xx to acknowledge; anything else is retried up to four more times. Deduplicate on the envelope's id.

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 item.availability.changed.

    Possible values: [item.availability.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.

  • dataItemAvailabilityChange

    The change.

About Item availability

Item availability: mark one item available or unavailable at one kitchen.

fetchLocationItems and setItemAvailability work as a pair: the write needs the discovery read, because Sous Chef's item ids cannot be known in advance.

There is no Idempotency-Key replay on this API: a retried setItemAvailability call re-applies the same value rather than de-duplicating.