Skip to main content

Set the orders webhook endpoint

PUT 
/webhooks/endpoints/orders

Creates or updates your orders endpoint, which receives order and kitchen-status events. Answers 201 when the endpoint is new and 200 when it existed.

Request​

  • Send the whole definition every time: events replaces the previous list, and an empty list answers 400 VALIDATION_FAILED (use DELETE to stop notifications).
  • Each event must belong to this endpoint and duplicates are collapsed.
  • payload is thin (default, the event only names the order) or full (the order as GET /orders/{id} shows it at send time, but with empty image URLs; see the Webhooks section for the other differences).
  • The url must be an absolute https address on port 443, without user info or fragment, and not localhost or a private or loopback IP address.

Behaviour​

  • Events are sent with X-Mekari-Signature, X-Mekari-Timestamp, X-Mekari-Key-Version, X-Mekari-Delivery-ID and X-Mekari-Event-ID headers.
  • The endpoint is active at once, without a challenge; use test to check it.
  • The response holds a secret object only when a signing secret was issued: the endpoint is new, its url changed, or it is set again after a DELETE. Store the secret then, it is never shown again.
  • After a url change the new secret signs every request at once; keep the previous one for 24 hours only to verify requests already on their way.
  • A change of events or payload alone returns no secret.
  • A paused endpoint becomes active again and its failure count is reset.

Request​

Responses​

The endpoint, updated