INHALTSVERZEICHNIS

• Einführung
• Voraussetzung
• Einrichtung von Webhooks in Calenso
  • Schritt-für-Schritt-Anleitung zur Konfiguration
• Payload-Analyse
• Verfügbare Webhook-Ereignistypen
• Geplante Webhook-Ereignistypen für die Zukunft
• Anwendungsbeispiele
• Zusammenfassung

Einführung

Webhooks ermöglichen es, einem System mitzuteilen, dass ein bestimmtes Ereignis eingetreten ist. Anstatt dass eine Anwendung kontinuierlich nach neuen Ereignissen fragt (Polling), informiert ein Webhook andere Anwendungen sofort, wenn ein Ereignis eintritt. Dies reduziert das Nachrichtenaufkommen zwischen den Anwendungen erheblich.

Voraussetzung

Die Verwendung von Webhooks in Calenso ist in allen Abonnements verfügbar. Wobei jedes Abonnement eine unterschiedliche Anzahl an Endpunkten erlaubt.

Basic	Professional	Business	Enterprise
1 Endpunkt	3 Endpunkte	5 Endpunkte	10 Endpunkte

Zusätzlich benötigen Sie ein System, das Webhooks als POST-Aufruf entgegennehmen kann.

Einrichtung von Webhooks in Calenso

Schritt-für-Schritt-Anleitung zur Konfiguration

Gehen Sie unter Einstellungen auf Webhooks.

Klicken Sie auf den Button Webhooks aktivieren.

Über das "Plus"-Symbol können neue Webhook-Endpunkte hinzugefügt werden.

Geben Sie die URL des Webhook-Endpunktes an. Es ist möglich, mehrere Endpunkte zu definieren.

Optional: Wenn das System abgesichert ist, kann ein Authorization Header konfiguriert werden. Klicken Sie dafür auf Define Authorization Header Key, um den Key zu definieren. Ein möglicher Wert wäre "Authorization" oder "Ocp-Apim-Subscription-Key".

Definieren Sie den Authorization Header Value nach Bedarf.

Optional: Definieren Sie, ob die JSON-Datei an eine bestimmte Email-Adresse gesendet werden soll. In diesem Fall wird kein Request mehr an den definierten Endpoint gemacht.

Definieren Sie die gewünschten Webhook-Ereignistypen und die Hierarchie der JSON-Datei, die die Webhook-Daten übermittelt.

Bei jeder Buchung eines Termins oder Events durch einen Kunden wird automatisch ein Webhook-Request an die konfigurierte URL gesendet. Neben jedem Endpunkt finden Sie die dazugehörige Statistik, die Informationen darüber 

gibt, ob die Requests vom Server akzeptiert wurden (Statuscode 2xx).

Detailliertere Informationen (inkl. Payload der Requests) finden Sie weiter unten. Wählen Sie dazu zunächst den gewünschten Endpunkt aus.

Hinter dem jeweiligen Zeitstempel sehen Sie anhand des Status und des HTTP-Codes, ob der Aufruf erfolgreich war.

Unter "Aktionen" können Sie mit "Raw" die Rohdaten anzeigen lassen, diese herunterladen oder den Webhook erneut anstoßen. Mehrfach angestoßene Webhooks erhalten ein entsprechendes Label.

Nach 60 Tagen werden die Webhook-Anfragen archiviert. Dies bedeutet, dass die Daten der Webhook-Anfragen nicht mehr verfügbar sind, sondern gelöscht werden. Replay-, Raw- und Download-Aktionen sind ausgegraut, und ein Vermerk "Archiviert" wird unter dem Datum eingefügt.

Payload-Analyse

Wenn Sie den Payload des Requests anschauen möchten, klicken Sie auf "Raw". Dort können Sie den JSON Payload genauer untersuchen.

Verfügbare Webhook-Ereignistypen

Calenso unterstützt momentan die folgenden Webhook-Ereignistypen:

• appointment.booking.created: Ein Kunde hat einen Termin über das Buchungswidget bei dem Partner vereinbart.
• event.booking.created: Ein Kunde hat sich über das Buchungswidget bei einem Gruppentermin angemeldet.
• appointment.booking.cancelled: Ein Kunde hat einen Termin beim Partner storniert (ab Version 3.1.6).
• event.booking.cancelled: Ein Kunde hat seine Event-Teilnahme abgesagt (ab v3.1.6).
• appointment.updated: Der Termin wurde verschoben.
• appointment.manual.booking.created: Ein manueller Kundentermin wurde im Kalender vom Partner eingetragen (ab v.3.8.0).
• event.manual.booking.created: Ein Kunde wurde manuell vom Partner zu einem Gruppentermin hinzugefügt (ab v.3.8.0).
• customer.created: Ein Kunde wurde angelegt (ab v.4.9.0).
• customer.updated: Ein Kunde wurde aktualisiert (ab v.4.9.0).
• customer.deleted: Ein Kunde wurde gelöscht (ab v.4.9.0).
• lead.created: Ein neuer Lead wurde angelegt (nur in Enterprise-Funktionen enthalten).

Geplante Webhook-Ereignistypen für die Zukunft

• appointment.booking.payment_succeeded: Die gebuchten Dienstleistungen wurden erfolgreich bezahlt.
• appointment.booking.payment_failed: Bei der Bezahlung der gebuchten Dienstleistungen gab es ein Problem.
• event.booking.payment_succeeded: Die Event-Teilnahme wurde erfolgreich bezahlt.
• event.booking.payment_failed: Bei der Bezahlung der Event-Teilnahme gab es ein Problem.

Anwendungsbeispiele

Wann macht es Sinn, Webhooks zu verwenden?

Webhooks sind besonders nützlich, wenn ein ERP-System über Termin- oder Eventbuchungen informiert werden muss, um weitere Aktionen anzustoßen oder um die Buchungsdaten zu speichern.

Zusammenfassung

Webhooks in Calenso bieten eine effiziente Möglichkeit, andere Systeme über Ereignisse zu informieren. Sie sind in den Whitelabel- und Enterprise-Abonnements verfügbar und ermöglichen eine flexible und sichere Integration in bestehende Workflows.

Mehr Details zu Webhooks finden Sie auch in unserer Dokumentation.