Zum Hauptinhalt springen

Webhooks: so funktioniert dieser Bildschirm

Legen Sie Webhooks an, die QrX-Ereignisse (Zahlungen, Sendungen, Retouren, Lager) an Ihr eigenes System senden, prüfen Sie die Signatur, verfolgen Sie jede Zustellung und reparieren Sie fehlerhafte Endpunkte.

H
Verfasst von Hayko

Webhooks: so funktioniert dieser Bildschirm

Webhooks senden QrX-Ereignisse in dem Moment an Ihr eigenes System, in dem sie passieren: eine Zahlung, eine Sendung, eine Retoure, eine Pickliste und mehr. QrX sendet eine signierte Nachricht an eine Webadresse (URL), die Sie wählen. Diese Anleitung erklärt die Liste der Webhooks und jeden Teil des Webhook-Editors.

Was Sie auf diesem Bildschirm sehen

  • Hinzufügen (oben rechts): legen Sie einen neuen Webhook an.

  • Übersichtskarten: Webhooks (alle geladenen Webhooks), Aktiv, Inaktiv und Handlungsbedarf (Webhooks, die fehlschlagen oder automatisch abgeschaltet wurden). Die Zahlen beziehen sich auf die Webhooks, die in der Liste geladen sind.

  • Webhooks suchen...: finden Sie einen Webhook nach Name oder URL.

  • Alle, Aktiv, Inaktiv: zeigt nur diese Webhooks.

  • Aktualisieren (der runde Pfeil): lädt die Liste neu.

  • Die Webhook-Liste: lädt beim Scrollen automatisch weitere Zeilen. Auf einem kleinen Bildschirm scrollen Sie die Tabelle seitwärts, um alle Spalten und Aktionen zu sehen.

Die Spalten

  • Name: der Name, den Sie dem Webhook gegeben haben, seine URL und die API-Version. Klicken Sie auf den Namen, um ihn zu öffnen. Klicken Sie auf den Spaltentitel, um nach Name zu sortieren.

  • Kanal: Alle Kanäle oder der eine Verkaufskanal, auf den dieser Webhook beschränkt ist.

  • Ereignisse: auf wie viele Ereignisse der Webhook hört, mit den ersten zwei Namen.

  • Status: Aktiv, Deaktiviert (Sie haben ihn abgeschaltet), Verschlechtert (Zustellungen schlagen gerade fehl), Automatisch deaktiviert (QrX hat ihn nach 24 Stunden mit Fehlern abgeschaltet) oder Fehlerhaft (mehrere Zustellungen hintereinander sind fehlgeschlagen).

  • Zugestellt · 24 Std. und Fehlgeschlagen · 24 Std.: erfolgreiche und fehlgeschlagene Zustellungen der letzten 24 Stunden.

  • Aktualisiert: wann der Webhook zuletzt geändert wurde und die Zeit der letzten Zustellung. Klicken Sie auf den Spaltentitel, um nach Datum zu sortieren.

Aktionen pro Zeile

  • Zustellung wieder aktivieren (Ein/Aus-Symbol, nur bei inaktiven Webhooks): schaltet den Webhook wieder ein. Zustellungen laufen sofort weiter.

  • Bearbeiten (Stift): öffnet den Webhook.

  • Kopieren: öffnet einen neuen Webhook mit demselben Namen (plus "copy"), denselben Ereignissen, demselben Kanal, derselben API-Version, denselben Payload-Feldern und denselben Empfängern von Warnungen. Die URL bleibt leer, damit Sie die neue Adresse eintragen. Erst beim Speichern wird etwas angelegt.

  • Löschen (Papierkorb): fragt nach einer Bestätigung und entfernt dann den Webhook. Die Zustellungen stoppen, und das lässt sich nicht rückgängig machen.

Einen Webhook anlegen oder bearbeiten

Klicken Sie auf Hinzufügen (oder auf einen Webhook in der Liste). Das Menü links zeigt auch, wie viele Ereignisse eingeschaltet sind, zum Beispiel 3/33. Der Editor hat oben eine Leiste und links ein Menü (Endpunkt, Events, Sicherheit, Warnungen, Zustellungen, Gefahrenzone), um zu jedem Teil zu springen. Sicherheit, Zustellungen und Gefahrenzone erscheinen, sobald der Webhook gespeichert ist.

  • Nicht gespeicherte Änderungen oder Alle Änderungen gespeichert: zeigt, ob Sie noch speichern müssen.

  • Speichern: speichert den Webhook. Sie können auch Strg+S drücken (Cmd+S auf einem Mac).

  • Abbrechen: zurück zur Liste, ohne zu speichern.

  • Test Senden (nur gespeicherte Webhooks): sendet ein Testereignis an Ihre URL. Hört der Webhook auf mehr als ein Ereignis, wählen Sie zuerst das Testereignis im Feld daneben. Das Ergebnis erscheint nach einigen Sekunden unter Zustellungen. Testereignisse werden auch gesendet, wenn der Webhook abgeschaltet ist, damit Sie Ihren Endpunkt prüfen können, bevor Sie ihn wieder einschalten.

  • Kopieren (nur gespeicherte Webhooks): startet einen neuen Webhook auf Basis dieses Webhooks, genau wie Kopieren in der Liste.

Unter der Leiste sehen Sie die URL (klicken Sie darauf, um sie zu kopieren), den Status, den Kanal, die API-Version, die Anzahl der Ereignisse und das Erstellungsdatum. Bei einem gespeicherten Webhook sehen Sie auch den Zustand der Zustellungen: Erfolgsquote, Mediane Latenz (wie schnell Ihr Endpunkt antwortet), Zustellungen · 24h und Fehlgeschlagen · 24 Std. (mit der Zahl, die auf einen neuen Versuch wartet).

Wenn der Webhook fehlschlägt oder abgeschaltet ist, erklärt ein farbiges Banner den Grund. Bei einem abgeschalteten Webhook klicken Sie im Banner auf Wieder aktivieren, um die Zustellungen wieder einzuschalten.

Endpunkt

  • Name (Pflichtfeld): ein Name, den Sie wiedererkennen, zum Beispiel "Meine Integration".

  • Endpunkt-URL (Pflichtfeld): die Adresse, die die Nachrichten empfängt. Sie muss mit https:// beginnen. Wenn QrX erfolgreich an diese URL zugestellt hat, sehen Sie Durch Zustellung verifiziert.

  • Kanal: behalten Sie Alle Kanäle, oder beschränken Sie den Webhook auf einen Verkaufskanal.

  • API-Version: das Nachrichtenformat, das Ihr Endpunkt erwartet. Die neueste ist mit Neueste markiert.

  • Aktiv: schalten Sie es aus, um Zustellungen zu pausieren, ohne den Webhook zu löschen. Ereignisse während der Pause werden übersprungen und nicht später gesendet.

Events

Wählen Sie, welche Ereignisse eine Nachricht senden. Die Ereignisse sind nach Thema gruppiert, und die Gruppennamen werden in Ihrer Sprache angezeigt: Transaktion, Sendung, Auftrag, Zahlung, Lieferung, Retoure, Fulfillment, Wareneingang und Bestand, dazu die Picklisten-Ereignisse.

  • Klicken Sie auf ein Ereignis, um es ein- oder auszuschalten. Nutzen Sie Alle auswählen oder Alle abwählen bei einer Gruppe und den Pfeil, um eine Gruppe auf- oder zuzuklappen.

  • Events filtern…: tippen Sie einen Teil eines Ereignisnamens ein, um es zu finden.

  • Der Zähler zeigt, wie viele der verfügbaren Ereignisse eingeschaltet sind, zum Beispiel "3 / 33 Events abonniert".

  • Payload anpassen (das Schieberegler-Symbol neben einem eingeschalteten Ereignis): wählen Sie, welche Felder die Nachricht enthält. Sie sehen jedes Feld mit seinem Typ, welche Felder Erforderlich sind (immer gesendet), eine Beispiel-Payload, die Sie kopieren können, Alle auswählen und Standardwerte zurücksetzen. Ihre Auswahl gilt für jedes Ereignis derselben Gruppe. Klicken Sie auf Fertig, um zu schließen; die Auswahl wird gespeichert, wenn Sie den Webhook speichern.

  • Die Gruppe Bestand hat zwei Ereignisse: stock/adjusted (der Bestand eines Artikels hat sich in einem Lager geändert) und stock/low (ein Artikel ist auf seinen Warnbestand für niedrigen Lagerbestand oder darunter gefallen; wird einmal pro Rückgang gesendet). Lagert ein Fulfillment-Partner Ihren Bestand, erhalten Sie diese Ereignisse für Ihre eigenen Artikel, ohne Lagerplätze.

  • Lagerdokumente haben eigene Gruppen: Wareneingänge (receipt/created, receipt/line_received, receipt/completed), Bestellungen (purchase_order/created, purchase_order/sent, purchase_order/received, purchase_order/closed), Inventuren (count/completed, count/approved), Ladungsträger (container/created, container/moved, container/emptied), Teamaufgaben (task/created, task/completed) und Umlagerungen (transfer/sent, transfer/received, transfer/completed, transfer/cancelled: Bestand, der zwischen Ihren eigenen Lagern bewegt wird; transfer/received wird bei jedem Empfang gesendet und listet die empfangenen Positionen, und jedes Umlagerungs-Event enthält Versanddienstleister und Sendungsverfolgung). Fulfillment hat außerdem picklist/assigned, picklist/cancelled, picklist/batch_created und fulfilment/snoozed (eine Bestellung wurde zurückgestellt oder die Zurückstellung aufgehoben). Diese Events und die Events von Wareneingang gehören zu keinem Verkaufskanal: Jeder Webhook Ihres Kontos, der sie auswählt, erhält sie, auch ein Webhook, der auf einen Kanal beschränkt ist. Jedes neue Event hat eine Beispiel-Payload; keine davon enthält Preise oder Kosten.

  • fulfilment/picked wird einmal pro Bestellung gesendet, wenn das Picken dieser Bestellung auf dem Smartphone abgeschlossen ist.

  • Die Beispiel-Payload der Bestands-, Picklisten- und Fulfillment-Ereignisse zeigt ein vollständiges Beispiel der Nachricht, damit Sie jedes Feld sehen, bevor Sie Ihre Integration bauen.

Sicherheit

  • Signaturgeheimnis: QrX signiert jede Nachricht mit diesem Geheimnis. Mit dem Augensymbol zeigen oder verbergen Sie es, mit dem Kopiersymbol kopieren Sie es.

  • Rotieren…: erzeugt ein neues Geheimnis. Alle folgenden Nachrichten werden sofort mit dem neuen signiert, aktualisieren Sie das Geheimnis also zuerst in Ihrem System.

  • Codebeispiele (Node, C#, Python, PHP, cURL): zeigen, wie Ihr System die Signatur prüft.

  • Signierte Request-Header: jede Nachricht enthält X-QrX-Signature (die Signatur des Nachrichtentexts), X-QrX-Event (den Namen des Ereignisses) und X-QrX-Delivery-Id (eine eindeutige ID der Zustellung).

Warnungen (Fehlermeldungen)

Klicken Sie auf Empfänger hinzufügen und wählen Sie Kollegen aus Ihrem Team. Sie erhalten eine E-Mail, wenn dieser Webhook immer wieder fehlschlägt: eine Warnung nach 6 Stunden Fehlern hintereinander und eine Nachricht, wenn QrX den Webhook nach 24 Stunden abschaltet. Klicken Sie auf das X bei einem Namen, um ihn zu entfernen. Speichern Sie den Webhook, um die Änderung zu behalten.

Zustellungen (Zustellprotokolle)

Jede Nachricht, die QrX an diesen Webhook gesendet hat, die neueste zuerst. Neue Zustellungen erscheinen von selbst, solange das Abzeichen Live angezeigt wird.

  • Suche: finden Sie Zustellungen nach Transaktions-ID, Bestell-ID oder Ereignis.

  • Alle, Zugestellt, Fehlgeschlagen, Erneut versuchen: zeigt nur diese Zustellungen.

  • 24h, 7d, 30d: der Zeitraum für das Diagramm und die Zustandskarten oben.

  • Aktualisieren: lädt die Zustellungen neu.

  • Die Spalten zeigen den Status, das Ereignis, die Transaktions-ID, den HTTP-Status, mit dem Ihr Endpunkt geantwortet hat, die Dauer, den Versuch (Nummer) und wann sie Zugestellt wurde. Wurde eine Nachricht mehr als einmal versucht, klicken Sie auf den Pfeil am Anfang der Zeile, um jeden Versuch zu sehen.

  • Zustelldetails anzeigen (Augensymbol): zeigt die vollständige Anfrage und Antwort, mit einem eventuellen Fehler.

  • Erneut zustellen: sendet dieselbe Nachricht noch einmal.

  • Zustellung abbrechen (nur solange eine Zustellung in der Warteschlange steht oder erneut versucht wird): stoppt die verbleibenden Versuche.

Gefahrenzone

  • Zustellverlauf löschen: löscht die gespeicherten Anfragen und Antworten dieses Webhooks endgültig. Der Webhook arbeitet weiter.

  • Webhook Löschen: stoppt alle Zustellungen und entfernt den Webhook endgültig.

Beide verlangen zuerst eine Bestätigung und lassen sich nicht rückgängig machen.

Ihren ersten Webhook einrichten

  1. Klicken Sie auf Hinzufügen.

  2. Geben Sie einen Name und Ihre Endpunkt-URL (https) ein.

  3. Wählen Sie einen Kanal, wenn der Webhook nur für einen Kanal gilt.

  4. Schalten Sie die Events ein, die Sie brauchen.

  5. Fügen Sie bei Bedarf Kollegen unter Warnungen hinzu.

  6. Klicken Sie auf Speichern. Der Bereich Sicherheit zeigt jetzt Ihr Signaturgeheimnis: hinterlegen Sie es in Ihrem System, um die Signatur zu prüfen.

  7. Klicken Sie auf Test Senden und prüfen Sie das Ergebnis unter Zustellungen.

Tipps und häufige Fragen

  • "Name ist erforderlich", "URL ist erforderlich", "Wählen Sie mindestens ein Ereignis": ergänzen Sie den fehlenden Teil und speichern Sie erneut.

  • "Geben Sie eine gültige HTTPS-URL ein (beginnend mit https://).": die Endpunkt-URL muss mit https:// beginnen. Reine http-Adressen werden nicht akzeptiert.

  • Jemand anderes hat den Webhook gleichzeitig geändert: QrX zeigt eine Meldung und lässt Sie die neueste Version neu laden.

  • Mein Webhook zeigt Automatisch deaktiviert: Ihr Endpunkt ist 24 Stunden lang ununterbrochen fehlgeschlagen. Reparieren Sie Ihren Endpunkt, prüfen Sie ihn mit Test Senden und klicken Sie dann auf Wieder aktivieren. Ereignisse aus der Zeit, in der er abgeschaltet war, werden danach nicht automatisch gesendet; nutzen Sie Erneut zustellen bei einer Zustellung, wenn Sie sie noch brauchen.

  • Woran erkenne ich, dass eine Nachricht wirklich von QrX kommt? Berechnen Sie den HMAC-SHA256 des rohen Nachrichtentexts mit Ihrem Signaturgeheimnis und vergleichen Sie ihn mit dem Header X-QrX-Signature. Der Bereich Sicherheit enthält fertige Beispiele.

  • Brauchen Sie Hilfe? Klicken Sie unten im Hilfecenter auf Chat.

Hat dies deine Frage beantwortet?