Format du payload - docs

Tous les payloads de webhook suivent une structure JSON cohérente.

Structure standard du payload

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

Champ	Type	Description
`event`	string	L’identifiant du type d’événement (par ex. `order.created`)
`data`	object	Le payload de l’événement contenant les données pertinentes

En-têtes HTTP

Chaque requête webhook inclut les en-têtes suivants :

En-tête	Description
`Content-Type`	Toujours `application/json`
`svix-id`	Identifiant unique de ce message webhook
`svix-timestamp`	Horodatage Unix indiquant quand le webhook a été envoyé
`svix-signature`	Signature permettant de vérifier l’authenticité

Exemple : payload Order Created

{
  "event": "order.created",
  "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"
    }
  }
}

Types de données

Valeurs monétaires : Toutes les valeurs monétaires sont exprimées dans la plus petite unité monétaire (par ex. pence pour GBP, cents pour USD)
Horodatages : Tous les horodatages sont au format ISO 8601 (UTC)
IDs : Identifiants sous forme de chaînes pour les commandes, codes alphanumériques pour les codes de collection

Sujets connexes

Transformations Dépannage des webhooks Import en masse de réductions Pré-remplissage du panier via URL Structure du menu

⌘I