API docs
Sous Chef Management API
Request access

Report completed

Webhookreport.completed

A requested report finished, successfully or not.

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. Branch on data.status: ready means the files exist and can be fetched, failed means that request will not produce files.

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 report.completed.

    Possible values: [report.completed]
  • 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.

  • dataReport

    The report and its terminal status. This is the same object fetchReport returns, with files omitted.

About Reports

Partner reporting. Coverage and every report are tenant-scoped and never global: the organization is the one the API key authenticates, and no request field can name another.

createReport is a write: a read-only API key is refused with 403.

Idempotency-Key is accepted on createReport and ignored, so a retried createReport requests a second report with a new reportId. The duplicate uses platform request budget but does not affect the first report: each report is an independent file. Treat a timeout as "may have succeeded" and check fetchReports before retrying.