Formato del payload - docs

Tutti i payload dei webhook seguono una struttura JSON coerente, con due eccezioni: l’evento legacy order.created invia l’oggetto order come body di primo livello (usa invece order.created.v2), e gli eventi order.refund.* collocano order, customer, venue e refund accanto a event invece che dentro data.

Struttura standard del payload

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

Campo	Tipo	Descrizione
`event`	string	L’identificatore del tipo di evento (ad es. `order.created.v2`)
`data`	object	Il payload dell’evento contenente i dati rilevanti

Header HTTP

Ogni richiesta webhook include i seguenti header:

Header	Descrizione
`Content-Type`	Sempre `application/json`
`svix-id`	Identificatore univoco di questo messaggio webhook
`svix-timestamp`	Timestamp Unix di quando il webhook è stato inviato
`svix-signature`	Firma per verificare l’autenticità

Esempio: payload di ordine creato

{
  "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"
    }
  }
}

Tipi di dati

Valori monetari: Tutti i valori monetari sono nella più piccola unità di valuta (ad es. penny per GBP, centesimi per USD)
Timestamp: Tutti i timestamp sono in formato ISO 8601 (UTC)
ID: Identificatori stringa per gli ordini, codici alfanumerici per i codici di ritiro

⌘I