Skip to main content
All webhook payloads follow a consistent JSON structure, with two exceptions: the legacy order.created event sends the order object as the top-level body (use order.created.v2 instead), and the order.refund.* events place order, customer, venue and refund alongside event rather than inside data.

Standard Payload Structure

HTTP Headers

Each webhook request includes the following headers:

Example: Order Created Payload

paymentType is the raw stored string, for example Cash, Adyen or Yoco, not a closed list. paid is true only for PayPal, Adyen, Yoco and PayByLink; it is false for every other value, including Cash, Dojo, Terminal and unknown values. It reflects the order’s payment type when the event is sent, not a live payment balance or capture confirmation. Cash orders are not updated to paid later.

Data Types

  • Monetary values: All monetary values are in the smallest currency unit (e.g., pence for GBP, cents for USD)
  • Timestamps: Date-time fields such as createdAt are ISO 8601 strings in UTC. A few fields carry other formats, such as opening-hours times (09:00:00), special-hours dates (2024-12-25) and the payout estimatedArrivalDate (month/year)
  • IDs: Orders have short string IDs (for example ttVhF8bKP) and alphanumeric collection codes. Stores have numeric IDs