Zum Hauptinhalt springen
Webhooks senden einen HTTP-POST an Ihren Server, wenn in Ihrem Shop etwas passiert, sodass Sie nicht regelmäßig abfragen müssen. Erstellen Sie Endpunkte unter Entwickler › Webhooks oder mit POST /webhooks.

Ereignisse

GET /events/types liefert dieselbe Liste.

Payload

Beträge in Webhooks werden in der Hauptwährungseinheit angegeben (34.99), anders als in der API, die die kleinste Währungseinheit verwendet (3499).

Signatur prüfen

Jeder Request enthält diese Header: Die Signatur ist HMAC-SHA256(secret, "<t>.<raw body>") in Hex. Das Secret (whsec_...) wird angezeigt, wenn Sie den Endpunkt erstellen. Berechnen Sie sie über den unveränderten Body, bevor Sie das JSON parsen, und lehnen Sie alte Zeitstempel ab.

Antworten und Wiederholungen

  • Antworten Sie innerhalb von 10 Sekunden mit einem beliebigen 2xx-Status. Erledigen Sie langsame Arbeit erst nach Ihrer Antwort.
  • Fehlgeschlagene Zustellungen werden nach 1 Minute, 5 Minuten, 30 Minuten, 2 Stunden, 6 Stunden und 12 Stunden wiederholt (7 Versuche über etwa 21 Stunden).
  • Ein Endpunkt wird nach 40 aufeinanderfolgenden Fehlschlägen ohne Erfolg innerhalb von 3 Tagen deaktiviert. Aktivieren Sie ihn im Dashboard oder mit PATCH /webhooks/{id} und enabled: true wieder.
  • Dasselbe Ereignis kann mehrmals eintreffen. Verwenden Sie PapelShip-Event-Id, um es nur einmal zu verarbeiten.

Endpunkte mit der API verwalten

Die Antwort enthält das Signatur-secret. Es wird nur einmal angezeigt; speichern Sie es in der Umgebung Ihres Servers. Das Rotieren des Secrets erfolgt weiterhin im Dashboard.