Dokumentation

Webhooks: Verbinde SuperSaaS mit anderen Webseiten

Webhooks sind benutzerdefinierte Rückmeldungen, die andere Anwendungen oder Webseiten über aktuelle Ereignisse in Deinem SuperSaaS Konto nahezu in Echtzeit informieren.

Ein paar Beispiele, wie Du einen Webhook nutzen kannst:

Logos von Webhooks
  • Wenn sich ein neuer Benutzer in Deinem SuperSaaS Konto anmeldet, leite ihn weiter an eine MailChimp Mailing Liste
  • Wenn sich ein neuer Benutzer anmeldet, sende ihm ein PDF mit Deinen Beschäftigungsbedingungen und Konditionen an seine E-Mail-Adresse
  • Wenn ein neuer Termin gemacht wurde, erstelle eine Rechnung mit QuickBooks oder Freshbooks
  • Wenn ein neuer Termin gemacht wurde für einen bestimmten Kurs, dann markiere den Google Kalender des Lehrers dieses Kurses
  • Wenn ein Termin beginnt, dann sende eine Nachricht, um eine Benachrichtigung an Dein Mobiltelefon anzuschieben oder auszusetzen
  • Wenn ein Benutzer von einer Warteliste zu einem bestätigten Platz wandert, sende ihm eine SMS Mitteilung
  • Wenn eine E-Mail gesendet wurde, leite sie weiter mit sende E-Mail mit einem anderen Mail Server

Automatische Webhooks mit Zapier.com oder Make.com erstellen

Du kannst entweder Zapier.com oder Make.com nutzen, um einen interaktiven Link zwischen hunderten von bekannten Webseiten und SuperSaaS herzustellen ohne dabei programmieren zu müssen. Beide, Zapier und Make, bieten eine Testversion und ein kostenloses Nutzungspaket für Wenignutzer.

Es sollte ziemlich einfach sein mit den fertig gestellten Beispielen Webhooks zu erstellen. Du findest unten detaillierte Informationen, wenn Du eine feinmaschigere Kontrolle mithilfe einer Filterung auf bestimmte Ereignisse, haben möchtest.

Neue Kunden zu MailChimpNeue Benutzer zur MailChimp Mailing Liste
Neue Termine an Google KalenderNeue Termine an Google Kalender
Neue Termine an QuickBooksNeue Buchung erstellt QuickBooks Rechnung
Neuer Termin an E-MailNeuer Termin an E-Mail-Filter

Unterstützte Auslöser als Trigger

Es gibt einige verschiedene Ereignisse, die Du überwachen kannst. Einige Ereignisse können entweder als ein „neues“ Ereignis, oder ein „verändertes“ Ereignis überwacht werden. Das „veränderte“ Ereignis umfasst jede Veränderung, sodass es auch bei „neu“ und „gelöscht“ ausgelöst wird. Wenn Du also beide Auslöser als Trigger einsetzt, wie „Neuer Benutzer“ und „Veränderter Benutzer“, dann lösen beide Webhooks eine Aktion aus, wenn sich ein neuer Benutzer anmeldet. Beachte: Wenn Dein Kalender keine Anmeldung verlangt, dann kannst Du nie einen Auslöser als Trigger für „Neuer Benutzer“ sehen, nur den Trigger für „Neuer Termin“.

Trigger (Auslöser)Ausgelöst durch …
New user (Neuer Benutzer)Startet, wenn sich ein Benutzer für Dein Konto anmeldet
Changed user (Geänderter Benutzer)Startet, wenn ein Benutzer seine Anmeldeinformationen aktualisiert oder der Administrator es für ihn macht.
New appointment (Neuer Termin)Startet, wenn ein Benutzer oder Administrator einen Termin in einem bestimmten Kalender machen.
Changed appointment (Geänderter Termin)Startet bei allen möglichen Änderungen eines Termins, inklusive „New“ (Neu), „Delete“ (Löschen), „Placement from waiting list“ (Platzierung aus Warteliste), „Payment received“ (Bezahlung erhalten), etc. (Siehe die vollständige Liste unten)
New stand-alone form (Neues eigenständiges Formular)Startet, wenn ein eigenständiges Formular ausgefüllt wird. Beachte, dass es nicht ausgelöst wird, wenn ein Formular mit einem Termin verknüpft ist, statt dessen würde das den Termin Webhook auslösen.
Updated stand-alone form (Geändertes eigenständiges Formular)Startet bei jeder Änderung in einem eigenständigen Formular (integrierte Formulare würden ein „Changed appointment“ (geänderter Termin) oder „Changed user“ (geänderter Benutzer) auslösen)
Send mail (Sende E-Mail)Startet, wenn eine E-Mail von Deinem Konto gesendet wird, inklusive „Lost password“ (Verlorenes Passwort) E-Mails usw. Sinnvoll, um E-Mails über Deinen eigenen Server zu versenden. E-Mails werden nicht mehr von uns versendet, wenn dieser Webhook aktiv ist.
Reminder (Erinnerung)
Follow-up (Erinnerungswiederholung)
Startet bei Erinnerungen und Erinnerungswiederholung. Die Erinnerung und Erinnerungswiederholung wird nicht mehr von uns versendet, wenn dieser Webhook aktiv ist.

Ereignisse filtern

Wenn Du zwei Dienste durch die Nutzung von Zapier oder Make miteinander verbindest, kannst Du die Ereignisse filtern. Hier einige Beispiele, wie Du Filter nutzen kannst:

  • Sende nur eine SMS Bestätigung, wenn jemand von einer Warteliste aufrückt, nicht bei jeder Terminänderung
  • Benachrichtige nur einen Lehrer über eine neue Buchung, wenn der Kurs von diesem Lehrer unterrichtet wird, ignoriere andere Buchungen im selben Kalender
  • Sende nur eine Benachrichtigung an das Management, wenn der Wert der Buchung mehr als €100 ist

Wenn Du einen neuen Webhook erstellt, dann fragen Zapier und Make nach einer Beispielanwendung von SuperSaaS. Die Beispielanwendung listet die verfügbaren Felder und einen Beispielinhalt auf. Die Felder, den der Webhook sendet, sind davon abhängig, welche Felder in Deinem Konto aktiviert sind und ob ein Formular eingefügt ist. Dort gibt es Felder für „event“ (Ereignis) und „role“ (Rolle), in denen die meisten Trigger (Auslöser) enthalten sind, die genutzt werden können, um diese Ereignisse zu filtern. Beispielsweise könntest Du nur Trigger (Auslöser) herausfiltern, die den Wert „delete“ (löschen) in dem Feld „event“ (Ereignis) haben.

Trigger (Auslöser) Möglicher Wert im Feld „event“ (Ereignis)
New user (Neue Benutzer)new (neu)
Changed user (Geänderter Benutzer)new (neu), change (ändern), delete (löschen)
New appointment (Neuer Termin)create (erstellen)
Changed appointment (Geänderter Termin)create (erstellen), edit (bearbeiten), place (platzieren), pending (ausstehen), destroy (zerstören), restore (wiederherstellen), approve (bestätigen), revert (umkehren)
New form (Neues Formular)new (neu)
Changed form (Geändertes Formular)new (neu), change (ändern), delete (löschen), restore (wiederherstellen)
Reminder (Erinnerung)/ Follow-up (Erinnerungswiederholung)reminder (erinnern), follow_up (nachfolgen)

„Role“ (Rolle) FeldWer löst das Ereignis aus …
0Anonymous (Anonym)Not logged in (Nicht eingelogged)
1Logged in with a shared password (Eingelogged mit einem gemeinsamen Passwort)
2Validated using an IP range check (Bestätigt über gemeinsame IP Adresse)
3Regular user (Normaler Benutzer)
4Superuser (Superbenutzer)
5Administrator or Reseller (Administrator oder Wiederverkäufer)
7System or Payment gateway (System oder Schnittstelle Zahlungsdienstleister)

Wenn ein Termin erstellt oder verändert wird, der Zahlung beinhaltet, dann erlaubt Dir das Feld „status“ (Status) und „status message“ (Status Mitteilung) eine genauere Festlegung von Ereignissen mithilfe der Liste aller möglichen Status Kodes. Beispielsweise könntest Du einen Filter einsetzen, der nur bei Mitteilungen aktiv wird für Termine, die erstattet wurden.

Händisch erstellte Webhooks (fortgeschrittene Anforderungen)

Einen Webhook ohne die Anwendung von Zapier oder Make zu erstellen, setzt einige Programmierkenntnisse voraus. Du kannst Webhooks anpassen, um sie direkt zu Deinem Server zu schicken oder um die enthaltenen Daten zu verändern. Die entsprechenden Details findest Du in der Anleitung für Entwickler unter Entwickler Webhook Dokumentation.