Webhooks - wie du Transaktionsdaten an dein Drittsystem senden kannst

Du benötigst mindestens 'Developer' Rechte im RaiseNow Manager um Webhooks editieren zu können. Mehr Infos zu den verschiedenen Benutzerrollen findest Du hier

Was sind Webhooks?

Es gibt zwei Möglichkeiten, Informationen über eine Spende, also den Zahlungsverkehr vom Spender zur Organisation, zu erhalten. Zum einen über die API (API User notwendig) oder über sogenannte Webhooks. Bei der ersten Variante ziehst Du die Daten (Pull) bei der zweiten Variante werden die Daten gesendet (Push) sobald ein definiertes Event ausgelöst wurde (z.B. Spende war erfolgreich).

Du kannst dabei ein Event definieren, also den Anlass oder Zeitpunkt, an dem Du die Informationen über eine Zahlung von einem Spender erhalten möchtest. Zudem definierst Du die URL wohin die Daten sicher übermittelt werden sollen. So können die Daten von Drittanbietern, z.B. CRM- Systemen, weiter verarbeitet werden. 

Mit Webhooks wirst Du derzeit informiert über Subscriptions (wiederkehrende  Zahlungseingänge) oder Transaction state changes - sobald eine Zahlung zu einem finalen Status (siehe Zahlungsstatus) wechselt.

Die RaiseNow Dankesemails nach einer erfolgreichen Spende werden ebenfalls durch Webhooks ausgelöst. 

Wo kann ich Webhooks definieren?

Du kannst Dir eigene Webhooks im RaiseNow Manager erstellen. Gehe dazu einfach in den Tab 'Aktionen & Events' und klicke dort auf 'Webhook Konfigurationen'. Bei 'Aktionen und Events' kannst Du übrigens auch prüfen ob die Webhooks erfolgreich waren für eine bestimmte Transaktion, mehr Informationen dazu hier. 

Wie erstelle ich einen Webhook? 

Du erstellt einen neuen Webhook indem Du rechts oben auf 'Neuen Webhook anlegen' klickst. Danach kannst Du folgendes konfigurieren: 

- Merchant Konfiguration: Für welche Konfiguration soll ein Webhook erstellt werden (die meisten unserer Kunden werden hier nur eine haben: Free oder Growth)

- Ereignis: Bei welchem Event möchtest Du die Daten senden. Überlege hier, ob Du Daten haben möchtest für erfolgreiche Zahlungen, um zum Beispiel E-Mails zu senden (final success) oder eventuell fehlgeschlagene Zahlungen um einen Follow Up mit dem potentiellen Spender zu machen (final error).

- URL: An welche URL sollen die Daten gesendet werden?

- Benutzername & Passwort: Hier geht es um die Datensicherheit. Du musst nicht unbedingt einen Benutzernamen und Passwort setzen. Wenn dein System, welches die Daten empfängt eine Passwort Abfrage macht, stelle sicher, dass die Informationen im Webhook hinterlegt sind. 

- Testmode: Hier definierst Du, ob Du die Daten von produktiven Zahlungen oder die Daten einer Zahlung, die im Testmodus getätigt wurde, haben möchtest. 

- SSL Validierung, Integritätsprüfung, Security Level und Sichere Antwort: Diesen Teil kannst Du hauptsächlich ignorieren. Wenn Du aber einen Benutzernamen und Passwort definierst, solltest Du das Security Level auf 'Basic' setzen. 

- Altes Format: Wir empfehlen das Alte Format zu nutzen, da wir an dem neueren Format noch arbeiten. 

Wie teste ich einen neu angelegten Webhook?

Falls Du dir nicht sicher bist, ob dein Webhook korrekt angelegt ist, kannst Du zur Überprüfung unseren Tester nutzen, der zufällige Daten an den von dir definierten Endpunkt sendet. 

Gehe dazu in den zu testenden Webhook. Klicke rechts neben Konfiguration auf den Reiter 'Tester'. Dort kannst du den Webhook abschicken und weiter unten den Status, den Test Request und die Response ansehen. Sollte die Response einen Fehler schmeißen, scheint etwas mit deinem Webhook Set up nicht zu stimmen. 

Wie lösche ich Webhooks?

Du kannst Webhooks jederzeit wieder löschen, indem Du in den spezifischen Webhook klickst und dann oben rechts unter 'Actions' auf Löschen (auf Englisch 'Delete') klickst. Zu deine Info hier kannst Du Webhooks auch klonen. 

Hast du weitere Fragen zum Thema Webhook? Kontaktiere uns unter support@raisenow.com