Webhooks
In diesem Artikel erfährst Du, wie Du in Payrexx Webhooks hinzufügen und verwalten kannst, um damit mit Drittsystemen zu kommunizieren.
Last updated
In diesem Artikel erfährst Du, wie Du in Payrexx Webhooks hinzufügen und verwalten kannst, um damit mit Drittsystemen zu kommunizieren.
Last updated
© Payrexx. All rigths reserved.
Ein Webhook erlaubt einer Anwendung, mit einer anderen Anwendung zu kommunizieren und ihr Informationen in Echtzeit zur Verfügung zu stellen. Beispielsweise kann Anwendung A eine Benachrichtigung an Anwendung B senden, wenn ein bestimmtes Ereignis eintritt.
Bezogen auf Payrexx können mit Webhooks beispielsweise Transaktionen und deren Status mit Drittsystemen wie einem E-Commerce-System oder einer Content Management Software synchronisiert werden.
Für verschiedene E-Commerce-Systeme gibt es bezüglich der Anbindung an Payrexx Plugins. Wird die Integration über ein solches Plugin vorgenommen, ist es nicht nötig, einen Webhook zu erstellen.
Um einen Webhook zu erstellen, logge Dich in Dein Konto bei Payrexx ein und navigiere im Hauptmenü der Händler-Administration zu Webhooks.
Klicke danach auf auf die weisse Schaltfläche "Webhook erstellen", worauf sich das folgenden Fenster öffnet:
Name: Vergib für den Webhook einen beliebigen Namen. Dieser dient lediglich dazu, dass Du den Webhook einfacher identifizieren kannst, falls Du mehrere Webhooks anlegst.
Webhook-URL: Trage die URL ein, an die der Webhook gesendet werden soll. Stelle dabei sicher, dass die URL exakt stimmt. Bei einer Integration erhältst Du die einzutragende URL häufig vom anzubindenden Drittsystem.
Ereignisse: Definiere, bei welchem Ereignis respektive bei welchen Ereignissen der Webhook ausgelöst werden soll. Es stehen die Typen "Transaction", "Subscription" und "Payout" zur Verfügung. Mehr Informationen findest Du im Kapitel "Typen von Webhooks".
Bei Fehler erneut versuchen: Es kann vorkommen, dass der Webhook unter der Webhook-URL einen Fehler auslöst. Durch Aktivierung dieses Kontrollkästchens stellst Du sicher, dass er in so einem Fall erneut ausgelöst wird. Der Versuch, den Webhook zu versenden, wird dann bis zu 10 Mal wiederholt.
Payrexx empfiehlt, diese Option nur zu aktivieren, wenn es vom anzubindenden Drittsystem so verlangt wird.
Webhook-Inhaltstyp: Wähle, ob für die Kommunikation zwischen Payrexx und dem Drittsystem das Format "PHP-Post" und das Format "JSON" angewendet werden soll.
Webhook-Version: Wähle die korrekte Version des Webhooks aus. Du findest diese Information in der Anleitung zur Anbindung der jeweiligen E-Commerce-Systems, CMS- oder Unternehmenssoftware-Tools.
Test-Transaktion senden: Versende eine Test-Transaktion, um zu erfahren, ob der Webhook korrekt konfiguriert ist.
Abschliessen: Klicke auf "Hinzufügen", um die Konfiguration abzuschliessen und den Webhook zu erstellen.
In Payrexx gibt es die folgenden drei Arten von Webhooks:
Falls Du in Payrexx bereits Webhooks erstellt hast, findest Du sie, wenn Du im Hauptmenü Deiner Händler-Administration zu Webhooks navigierst:
Bei der Kommunikation von zwei Systemen über Webhooks kann es zu Fehlern kommen. Solche Webhook-Fehler treten typischerweise auf, wenn das Zielsystem eine Anfrage ablehnt oder die Verarbeitung des Webhooks im Zielsystem einen Fehler auslöst.
Die Ursache von Webhook-Fehlern liegt in der Regel beim Zielsystem. Es kann aber auch sein, sie auf einer fehlerhaften Webhook-URL oder einem falschen Webhook-Inhaltstyps basieren.
Im folgenden Abschnitt zeigen wir Dir Lösungen für die häufigsten Webhook-Fehler auf.
Für die Integration von Payrexx in verschiedene E-Commerce-Systeme stehen Plugins zur Verfügung. Kommt es bei einer dieser Integrationen zu Webhook-Fehlern, empfehlen wir das folgende Vorgehen:
Lies die Dokumentation der jeweiligen E-Commerce-Integration sorgfältig durch und beachte dabei insbesondere die Angaben im Kapitel "Konfiguration von Payrexx".
Stelle sicher, dass die eingetragene Webhook-URL korrekt ist. Ein häufiger Fehler ist, dass die Schreibweise der eingetragenen Webhook-URL nicht mit jener des Zielsystems übereinstimmt. Beispiel: https://meine-verkaufsseite.com/payrexx-webhook versus https://www.meine-verkaufsseite.com/payrexx-webhook
Falls Du den Fehler nicht finden kannst, erstelle ein Support-Ticket und lass uns die folgenden Informationen zukommen:
Instanzname in Payrexx
Webhook-URL
Zugangsdaten zum Administrationsbereich Deines Drittsystems
Falls Du die Integration nicht über ein Plugin, sondern über einen manuell angelegten Webhook vorgenommen hast, raten wir Dir, bei Webhook-Fehlern die Logs zu durchsuchen.
Navigiere hierfür zu Webhooks und klicke neben dem betreffenden Webhook auf "Logs":
Danach klickst Du in der Liste der Webhook-Anfragen auf den Eintrag, den Du untersuchen möchtest:
Auf der rechten Seite des Bildschirms werden Dir nun sämtliche Details zur entsprechenden Webhook-Anfrage angezeigt:
Wenn Du nach unten scrollst, findest Du den HTTP-Status der Webhook-Anfrage:
Der HTTP-Status ist eine Antwort vom Zielserver, die in Form einer Zahlencode an den Sender des Webhooks (in unserem Fall Payrexx) zurückgegeben wird. Mit Hilfe des zurückgegebenen Wertes kannst Du herausfinden, worin das Problem besteht und wie es behoben werden kann:
Falls Du den Fehler nicht finden kannst, erstelle ein Support-Ticket und lass uns die folgenden Informationen zukommen:
Instanzname in Payrexx
Webhook-URL
Zugangsdaten zum Administrationsbereich Deines Drittsystems
Zusätzliche technische Informationen zu Webhooks findest Du im entsprechenden Artikel in unserer Entwickler-Dokumentation:
Transaction
Wird ausgelöst, wenn eine Transaktion erstellt wird oder wenn sich der Status einer Transaktion ändert.
Subscription
Wird ausgelöst, wenn es bei einem durch Payrexx verwalteten Abonnement zu einem wichtigen Ereignis kommt.
Payout
Wird erstellt, wenn in Payrexx eine neue Auszahlung initialisiert wird.
