API docs
Sous Chef Management API
Request access

Get webhook settings

POST/management/settings/fetchWebhookSettings

Your current webhook configuration: both destinations, in one read.

legacyUrl is included so you can see what Sous Chef has on file for the legacy feed. The URL itself cannot be set through this API; legacyUrlEnabled can. The response never contains an api key.

An organization with neither destination configured gets back newUrlEnabled: false, legacyUrlEnabled: true and no other field, not a 404. Having nothing configured is a valid state, not an error.

Safe to retry: this operation is read-only and idempotent.

Request

application/json
required

Responses

200: Your current webhook configuration for both destinations.

Headers

  • x-mealco-tx-idstringoptional

    The correlation id for this call, returned on every response that an operation produces, successful or not. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned, so that one response carries neither this header nor the txId field of the error body.

  • legacyUrlstring

    The legacy orders-only feed's registered url. Read-only through this API. Absent when nothing is configured. Delivery to it is also gated by Sous Chef's order-notifications switch for your organization, and by legacyUrlEnabled.

  • legacyUrlEnabledboolean

    A pause switch for legacyUrl only, the counterpart of newUrlEnabled for the legacy destination. Unlike legacyUrl itself, it can be set through setAllWebhookSettings. Use it to finish migrating off the legacy feed yourself, without Sous Chef clearing legacyUrl as a support action. false silences legacyUrl alone; it has no effect on newUrl. It defaults to true, so a destination that was never switched off keeps delivering, including across a setAllWebhookSettings call that omits this field.

  • newUrlstring

    The new signed (v2= ES256) destination. Absent when nothing is registered.

  • newUrlEventsstring[]

    Which events are delivered to newUrl. Governs newUrl only: the legacy feed has no per-event list and is always orders-only.

    Possible values: [order.created, order.status.updated, order.rejected, order.cancelled, order.delivery.updated, store.status.changed, report.completed, menu.publication.completed, item.availability.changed]
  • newUrlEnabledboolean

    A pause switch for newUrl only. false silences the new feed; it has no effect on legacyUrl, which has its own switch, legacyUrlEnabled.

About Settings

Read and set where Sous Chef delivers your webhooks.

Your organization is resolved from the authenticated api key and is never a field on any request or response here, so no caller can point another organization's feed at their own server.

Two destinations, one configuration. legacyUrl is the existing orders-only feed. The URL itself is read-only here (Sous Chef controls where the legacy feed delivers, and clears it only as a support action), and legacyUrlEnabled is the switch that lets you turn legacy delivery off yourself. newUrl is the signed (v2=, ES256) destination you register yourself, together with newUrlEvents (which events it receives) and newUrlEnabled (its own pause switch). Any combination of legacyUrlEnabled and newUrlEnabled is valid: legacy only, both while you migrate, or new only once you are done. Registering or pausing one destination never changes the other.

Each field governs one destination. newUrlEvents and newUrlEnabled govern newUrl only. legacyUrlEnabled governs legacyUrl only: the legacy feed has no per-event subscription list and is always orders-only. newUrlEnabled: false does not turn all webhooks off. It silences newUrl alone, just as legacyUrlEnabled: false silences only legacyUrl.