Organisation – Webhooks#

Die Seite Webhooks hängt mit dem Starten von Agenten durch Ereignisse aus anderen Diensten zusammen. Dank Webhooks können Agenten auf das reagieren, was in Mergado oder FreeScout passiert – zum Beispiel auf einen abgeschlossenen Feed-Export oder eine neue Antwort eines Kunden.

Aufbau der Seite#

Webhooks von Mergado#

Die Webhooks von Mergado stehen der Organisation automatisch zur Verfügung, hier wird nichts eingestellt. Auf welche Ereignisse aus Mergado ein Agent reagieren soll, wählen Sie direkt beim Agenten.

FreeScout#

Der Abschnitt FreeScout dient zur Anbindung des Helpdesks FreeScout. Er enthält:

• die Base URL (Basis-URL), unter der die Anwendung Ereignisse aus FreeScout empfängt,
• die Schaltfläche New webhook (Neuer Webhook),
• die Liste der angelegten Webhooks mit ihrer Anzahl.

Webhooks legen die Rollen Owner und Admin an, bearbeiten und löschen sie; die übrigen Mitglieder sehen nur die Liste und können die URL kopieren.

Neuer FreeScout-Webhook#

1. Klicken Sie auf New webhook und geben Sie einen Name ein (z. B. „Support“). Unter dem Feld sehen Sie, wie die URL des Webhooks aussehen wird.
2. In das Feld Secret Key fügen Sie den geheimen Schlüssel ein, den FreeScout unter Manage » API & Webhooks anzeigt. Er dient zur Prüfung der Signatur jeder Zustellung.
3. Mit Add (Hinzufügen) speichern Sie den Webhook. Die URL erhält eine zufällige Endung, damit sie eindeutig ist.
4. Kopieren Sie die URL des Webhooks (mit dem Symbol daneben) und tragen Sie sie in FreeScout unter Manage » API & Webhooks ein.

Auf der Karte des Webhooks stehen:

• die URL mit einer Schaltfläche zum Kopieren,
• Used by (Verwendet von) – die Agenten, die dieser Webhook startet,
• ein Stift zum Bearbeiten – Sie ändern Name oder Secret Key; mit der Option Change webhook URL as well (Auch Webhook-URL ändern) erzeugen Sie eine neue Adresse (die alte funktioniert dann nicht mehr und muss in FreeScout ersetzt werden; die Agenten bleiben angebunden),
• ein Papierkorb zum Löschen – er lässt sich nicht verwenden, solange ein Agent den Webhook nutzt.

Eigene Ereignisse#

FreeScout sendet den Ereignistyp im Header X-FreeScout-Event. Neben den üblichen Ereignissen (neue Konversation, Zuweisung, Statusänderung, Antwort des Kunden, Antwort des Bearbeiters, Notiz, neuer oder geänderter Kunde …) können Sie auf der Karte des Webhooks über Add event (Ereignis hinzufügen) auch eigene eingeben – Name und Type (Typ, der Wert des Headers). Eigene Ereignisse werden dann beim Einrichten eines Auslösers für einen Agenten angeboten.

Wie Webhooks verwendet werden#

Die eigentlichen Reaktionen auf Ereignisse richten Sie bei den Agenten im Abschnitt Triggers (Auslöser) mit der Option Webhook ein:

1. Sie wählen den Dienst (Mergado oder einen konkreten FreeScout-Webhook).
2. Sie wählen das konkrete Ereignis.
3. Bei Mergado ergänzen Sie den Onlineshop und gegebenenfalls das Projekt, auf das sich der Auslöser beziehen soll.

Tritt das Ereignis ein, startet der Agent und das Ergebnis erscheint als neue Konversation mit dem Präfix [Hook] sowie im Verlauf auf der Seite Dashboard.

Was Sie hier tun können#

• Einen FreeScout-Webhook anlegen und seine URL erhalten.
• Eigene Ereignistypen aus FreeScout ergänzen.
• Prüfen, welche Agenten einen Webhook verwenden.

FAQ#

Der Auslöser startet nicht – wo suche ich den Fehler? Prüfen Sie die Einstellungen des Auslösers beim Agenten (richtiges Ereignis, richtiger Onlineshop und richtiges Projekt). Bei FreeScout prüfen Sie, dass in FreeScout die richtige URL eingetragen ist und der Secret Key übereinstimmt. Empfangene Webhooks finden Sie im Verlauf auf der Seite Dashboard.

Kann ich Webhooks ausschalten? Die Webhooks von Mergado werden auf der Seite von Mergado verwaltet. In der Anwendung entfernen Sie nur die Webhook-Auslöser bei den Agenten. Einen FreeScout-Webhook löschen Sie auf dieser Seite, sobald ihn kein Agent mehr verwendet.

Welche Ereignisse stehen zur Verfügung? Bei Mergado zum Beispiel Ereignisse rund um Import, Export und Regelanwendung, Änderungen an Projekten, Elementen, Abfragen, Regeln und am Schlüsselbund. Bei FreeScout Ereignisse zu Konversationen, Antworten und Kunden sowie Ihre eigenen Ereignisse.

Können Webhooks Automatisierungen starten? Nein, Automatisierungen werden manuell oder nach Zeitplan gestartet. Auf Ereignisse reagieren nur Agenten.