Payload Format - docs

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

{
  "event": "order.created.v2",
  "data": {
    // Event-specific data
  }
}

Field	Type	Description
`event`	string	The event type identifier (e.g., `order.created.v2`)
`data`	object	The event payload containing relevant data

HTTP Headers

Each webhook request includes the following headers:

Header	Description
`Content-Type`	Always `application/json`
`svix-id`	Unique identifier for this webhook message
`svix-timestamp`	Unix timestamp when the webhook was sent
`svix-signature`	Signature for verifying authenticity

Example: Order Created Payload

{
  "event": "order.created.v2",
  "data": {
    "id": "ord_abc123",
    "code": "A1B2",
    "total": 2500,
    "tip": 250,
    "orderType": "Pickup",
    "asap": true,
    "createdAt": "2024-01-15T10:30:00Z",
    "customer": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@example.com",
      "phone": "+44123456789"
    },
    "items": [
      {
        "name": "Margherita Pizza",
        "price": 1200,
        "quantity": 1,
        "modifiers": []
      }
    ],
    "venue": {
      "id": 1234,
      "name": "My Restaurant",
      "slug": "my-restaurant"
    }
  }
}

Data Types

Monetary values: All monetary values are in the smallest currency unit (e.g., pence for GBP, cents for USD)
Timestamps: All timestamps are in ISO 8601 format (UTC)
IDs: String identifiers for orders, alphanumeric codes for collection codes