Payload-formaat - docs

Alle webhook-payloads volgen een consistente JSON-structuur, met twee uitzonderingen: het legacy-event order.created verstuurt het orderobject als top-level-body (gebruik in plaats daarvan order.created.v2), en de order.refund.*-events plaatsen order, customer, venue en refund naast event in plaats van binnen data.

Standaard payload-structuur

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

Veld	Type	Beschrijving
`event`	string	De event-type-identifier (bijv. `order.created.v2`)
`data`	object	De event-payload met relevante gegevens

HTTP-headers

Elk webhook-verzoek bevat de volgende headers:

Header	Beschrijving
`Content-Type`	Altijd `application/json`
`svix-id`	Unieke identifier voor dit webhook-bericht
`svix-timestamp`	Unix-timestamp van het moment waarop de webhook is verzonden
`svix-signature`	Signatuur om de authenticiteit te verifiëren

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

Datatypes

Geldbedragen: alle geldbedragen zijn in de kleinste valuta-eenheid (bijv. pence voor GBP, cents voor USD)
Timestamps: alle timestamps zijn in ISO 8601-formaat (UTC)
ID’s: string-identifiers voor bestellingen, alfanumerieke codes voor collectiecodes

⌘I