In diesem Artikel erhalten Sie eine detaillierte Anleitung zur Einrichtung des Webhooks. Zudem werden verschiedene Anwendungsmöglichkeiten vorgestellt und die erforderlichen Einstellungen ausführlich erklärt.
Mit der Webhook-Anbindung können Informationen, die vom Telefonassistenten oder Chatbot erfasst wurden, in Echtzeit an einen gewünschten Endpunkt übermittelt werden. Dadurch lassen sich Prozesse effizienter gestalten und Informationen direkt in bestehende Systeme integrieren. Die Webhook-Anbindung kann mit allen Systemen genutzt werden, die HTTP-POST-Anfragen empfangen und JSON-Daten verarbeiten können.
Wichtig: Um Integrationen wie die Webhook-Anbindung nutzen zu können, ist unser Pro-Paket erforderlich.
1. Was ist ein Webhook?
Ein Webhook ist eine Schnittstelle, die es ermöglicht, automatisch Daten an eine externe URL zu senden, sobald ein bestimmtes Ereignis eintritt – in diesem Fall eine Nutzerinteraktion mit dem Telefonassistenten oder Chatbot. Dies erlaubt eine nahtlose Weiterverarbeitung der Informationen in angebundene Systeme.
Wir senden die Informationen per POST-Request im JSON-Format an die angegebene Webhook-URL. Die Struktur und der Inhalt der gesendeten Daten können individuell angepasst werden.
2. Nutzungsmöglichkeiten der Webhook-Anbindung
Mit der Webhook-Anbindung können relevante Informationen direkt in Ihre Systeme übertragen werden. Dazu gehören beispielsweise:
- Alle in der Konversation abgefragten Informationen (z. B. Name, Geburtsdatum, Anliegen, etc.)
- sender_id (Konversations-ID)
- timestamp (Zeitstempel)
- vnr (VITAS-Nummer)
- detail_view_url (Link zur Gesprächsübersicht)
- caller_nr (Anrufer-Nummer)
Die genaue Datenstruktur kann individuell über einen JSON Request-Body konfiguriert werden. Ohne ein individuelles Template werden die Informationen, inklusive Metadaten der Konversation, in der Reihenfolge übermittelt, in der sie im Szenario abgefragt wurden.
3. Einrichtung des Webhooks
Über das Benachrichtigungs-Element kann der Webhook schnell und unkompliziert eingerichtet werden. Fügen Sie das Element einfach im entsprechenden Szenario an der gewünschten Stelle im Gespräch ein und legen Folgendes fest:
- Webhook-URL → Die Zieladresse, an die die Daten gesendet werden sollen.
- Datenstruktur → Entscheiden Sie, ob:
- Alle erfassten Daten inklusive aller Metadaten (z. B.
sender_id, Szenarioname, Link) versendet werden sollen, oder - Ein Sie einen JSON Request-Body anlegen möchten, der nur bestimmte Daten in einer festgelegten Reihenfolge enthält.
- Alle erfassten Daten inklusive aller Metadaten (z. B.
Ein individueller JSON Request-Body kann beispielsweise so aussehen.
Dabei sind die beispielhaften Felder Name, Geburtstag, Schuhgröße die Informationen, die während der Konversation abgefragt wurden.
Sollten Sie weitere Fragen zum Thema Webhook haben, kontaktieren Sie gerne unser Support-Team über den Chat oder per Mail an support.telefonassistent.de