Payload-Format - docs

Alle Webhook-Payloads folgen einer einheitlichen JSON-Struktur, mit zwei Ausnahmen: Das Legacy-Event order.created sendet das Order-Objekt als Top-Level-Body (verwenden Sie stattdessen order.created.v2), und die order.refund.*-Events platzieren order, customer, venue und refund neben event statt innerhalb von data.

Standard-Payload-Struktur

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

Feld	Typ	Beschreibung
`event`	string	Der Event-Typ-Identifier (z. B. `order.created.v2`)
`data`	object	Der Event-Payload mit den relevanten Daten

HTTP-Header

Jede Webhook-Anfrage enthält die folgenden Header:

Header	Beschreibung
`Content-Type`	Immer `application/json`
`svix-id`	Eindeutiger Identifier für diese Webhook-Nachricht
`svix-timestamp`	Unix-Zeitstempel, wann der Webhook gesendet wurde
`svix-signature`	Signatur zur Verifizierung der Echtheit

Beispiel: 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"
    }
  }
}

Datentypen

Geldbeträge: Alle Geldbeträge sind in der kleinsten Währungseinheit (z. B. Pence bei GBP, Cent bei USD)
Zeitstempel: Alle Zeitstempel sind im ISO-8601-Format (UTC)
IDs: String-Identifier für Bestellungen, alphanumerische Codes für Abholcodes

⌘I