Webhooks

Unter Webhooks finden Sie Ihre installierten Webhooks und können neue hinzufügen.

Ein Webhook ermöglicht es webbasierte Benachrichtigungen an andere Anwendungen zu übermitteln. Somit können beispielsweise Transaktionen und deren Status mit Drittsystemen wie ein E-Commerce Shop, ein ERP oder ein Buchhaltungssystem synchronisiert werden.

Einrichtung

Für Ihre E-Commerce Anbindung ist keine Webhook Einrichtung notwendig. Wenn diese Anbindung nach Anleitung eingerichtet ist, so wurde im Hintergrund auch bereits ein verdeckter Webhook angelegt.

Konfiguration

Zurzeit gibt es drei verschiedene Webhooktypen. Diese sind Transaction, Subscription und Payout Webhooks und werden wie folgt ausgelöst:

• Transaction: Immer bei der Erstellung oder Statusänderung einer Transaktion

• Subscription: Bei wichtigen Ereignissen von durch Payrexx verwaltete Subscriptions

• Payout: Bei der Erstellung eines neuen Payouts von Payrexx

Zusätzlich stehen einige Konfigurationsmöglichkeiten, zur Verfügung. Diese sind hier kurz erklärt:

• Name: Benennung des Webhooks. Dies ist optional und hilft beispielsweise bei der Zuordnung der Webhook Logs

• Webhook URL: An diese URL werden die Webhookdaten versendet. Diese URL muss genau stimmen!

• Bei Fehler erneut versuchen: Es besteht die Möglichkeit, dass der Webhook oder dessen Inhalt unter der Ziel-URL ein Fehler auslöst. Mit dieser Option Einstellung wird der Webhook im Fehlerfall mehrmals erneut übermittelt. Wir empfehlen, diese Option nicht zu aktivieren, ausser wenn das Zielsystem dies erfordert.

• Webhook Inhaltstyp: Es gibt verschiedene Formate, welche in der Kommunikation zwischen Anwendungen eingesetzt werden. Payrexx biete die Wahl zwischen JSON und POST Form Data an.

Webhook-Fehler

Ein Webhook-Fehler tritt ein, wenn das Zielsystem die Anfrage ablehnt oder die Verarbeitung des Webhooks ein Fehler im Zielsystem auslöst. Grundsätzlich gilt: Ein Webhook-Fehler entspringt bei dem Zielsystem. Manchmal liegt das Problem aber auch an einer falschen Webhook URL oder dem falschen Datentyp.

Vorgehen

Abhängig davon in welchem Zusammenhang Sie Webhooks nutzen, gibt es verschiedene Vorgehen Ihre Webhook-Fehler zu lösen. Folgend beschreiben wir das Vorgehen in drei Nutzungsfällen.

Plugin von Payrexx (WooCommerce, Shopware, Magento, etc.)

1. Lesen Sie die Dokumentation zur Einrichtung des jeweiligen Systems erneut sorgfältig durch. Prüfen Sie speziell das Kapitel "Konfiguration - Payrexx"

2. Stellen Sie sicher, dass die Shop-URL richtig angegeben wurde. Auch kleine Schreibfehler können zu einem Problem führen. Die häufigste Ursache ist, dass sich in der Konfiguration ein "www" befindet, während der Shop ohne "www" konfiguriert wurde oder umgekehrt.

3. Falls Sie keine Fehler finden können, erstellen Sie ein neues Ticket mit den folgenden Informationen: - Ihr Payrexx Instanzname (Kontoname) - Shop URL - Zugang zu der Administration Ihres Drittanbietersystem - Information ob allgemeines oder sporadisches Problem

Plugin von Drittanbieter (Drupal, NopCommerce, CS Cart, JTL, Odoo)

1. Lesen Sie die Dokumentation zur Einrichtung des jeweiligen Systems erneut sorgfältig durch. Diese Dokumentationen werden von dem Anbieter bereitgestellt und unterhalten.

2. Stellen Sie sicher, dass die Shop-URL richtig angegeben wurde. Auch kleine Schreibfehler können zu einem Problem führen. Die häufigste Ursache ist, dass sich in der Konfiguration ein "www" befindet, während der Shop ohne "www" konfiguriert wurde oder umgekehrt.

3. Falls Sie keinen Fehler finden können, kontaktieren Sie die Entwickler des jeweiligen Plugins.

Eigener Webhook

Wenn Sie eigene Webhooks angelegt haben, gehen wir von einem gewissen technischen Verständnis aus.

Bitte prüfen Sie die Webhook Logs, um mehr Informationen zu dem Fehler zu finden. In den Webhooks Logs finden Sie einen HTTP Response Status und einen Response Body. Beide können wichtige Informationen enthalten.

Fehlersuche nach HTTP Response Status:

• HTTP 301 (Das Webhook Ziel führt eine Weiterleitung durch) Höchstwahrscheinlich ist die Webhook URL nicht korrekt.

• HTTP 403 (Das Webhook Ziel erlaubt die Anfrage nicht) Um Webhook Anfragen zu erlauben, können Sie beispielsweise die IP des Webhooks (52.29.45.62, 3.79.212.4, 3.73.29.220) whitelisten. Falls Sie Hilfe benötigen, kontaktieren Sie Ihren Server Dienstleister.

• HTTP 500 (Fehler bei der Verarbeitung der Daten) Ihr Server nimmt den Webhook an und verarbeitet die Daten, scheitert jedoch dabei. Prüfen Sie die Logs in Ihrem System für zusätzliche Informationen. Dieser Fehler kann auch durch ein falsches Format ausgelöst werden (JSON/Post Form Data).

Wenn Ihr Webhook Fehler nicht gelöst werden konnte helfen wir Ihnen gerne innerhalb eines Support-Tickets weiter.

Logs

In den Webhook Logs finden Sie alle Webhooks, welche von Ihrem Payrexx Account versendet wurden. Die Logs beinhalten erfolgreiche wie auch fehlgeschlagene Webhooks.

Entwickler & Webhooks

Zusätzliche Informationen zu Webhooks, finden Sie in dem entsprechenden Artikel der Entwicklerdokumentation:

WebhookDeveloper