Mit dem Integration Builder können Sie ein Zendesk-Ticket aus einer Konversation mit einem AI Agent erstellen. In diesem Beitrag werden die dafür notwendigen Schritte beschrieben.
Die entsprechende Zendesk-Dokumentation für Entwickler finden Sie hier.
In diesem Beitrag werden folgende Themen behandelt:
- Voraussetzungen
- Integration erstellen
- Umgebung und Endpunkt
- Auth
- Anfrageparameter
- Text
- Formatierung des Chatprotokolls: Standard- vs. HTML-Text
- Standardfelder vs. angepasste Feldwerte
- Aufbau im Dialoggenerator
Voraussetzungen
Voraussetzungen für die Einrichtung:
- Ihre Zendesk-Subdomäne
- Ihr Autorisierungstoken (weitere Informationen finden Sie im unten stehenden Abschnitt)
Integration erstellen
- Erstellen Sie unter „API-Integrationen“ eine neue Integration.
- Weisen Sie ihr einen Namen (z. B. „Zendesk-Ticket erstellen“) und eine Beschreibung zu.
Umgebung und Endpunkt
Um auf die Zendesk Ticket-API zuzugreifen, müssen Sie eine POST-Anfrage an den folgenden Endpunkt stellen: http://[Ihre-Zendesk-Subdomäne].zendesk.com/api/v2/tickets
Mit Ihrer Zendesk-Subdomäne können Sie die Endpunkt-URL für Ihre Zendesk-Instanz erstellen. Diese URL wird dann im Abschnitt „Umgebungen“ des Integration Builders für die POST-Anfrage verwendet.
- Navigieren Sie im Integration Builder zum Abschnitt „Umgebungen“.
- Wählen Sie unter „Methodentyp“ die Option „POST“.
- Fügen Sie den konstruierten URL-Endpunkt für die Ticket-API hinzu.
Auth
Um auf die Zendesk-API zuzugreifen, müssen Sie im Admin Center ein Token erstellen.
- Gehen Sie im Admin Center zu „Apps und Integrationen“ und klen Sie auf „APIs > Zendesk API“.
Der unten stehende Bildschirm wird angezeigt. Dort können Sie ein neues Token hinzufügen.
- Klicken Sie auf API-Token hinzufügen.
- Geben einen Namen für das Token ein (z. B. Ticket erstellen).
- Kopieren Sie das Token und speichern Sie es an einem sicheren Ort, da Sie es für die Einrichtung der Integration im Integration Builder benötigen.
Dieses Token können Sie nun im Integration Builder zu Ihrer Integration hinzufügen.
- Klicken Sie im Abschnitt Umgebung auf Autorisierung.
- Klicken Sie unter Autorisierungstyp auf Standardauthentifizierung.
- Geben Sie die E-Mail-Adresse eines Administrators ein und hängen Sie die Zeichenfolge /token an.
- Fügen Sie das eben erstellte Token als Kennwort ein.
- Fügen Sie das Autorisierungstoken manuell in die Kopfzeilen der Anfrage ein.
Anfrageparameter
Hier übernehmen Sie die Daten aus der AI Agent-Konversation in die Integration, um das Ticket zu erstellen.
Für die Live-Integration müssen Sie die Parameter in Ihrem Dialog einstellen und anschließend mit Ihren Anfrageparametern im Integration Builder abgleichen. Zum Testen können Sie die Anfrageparameter mit Testwerten erstellen, da wir keine Live-Daten aus einer Konversation verwenden.
Stellen Sie sicher, dass die Namen der Anfrageparameter mit denen übereinstimmen, die Sie in Ihrem Dialog (mithilfe von Aktionen) festgelegt haben. Weitere Informationen finden Sie unter Aufbau im Dialoggenerator.
Text
Beim Erstellen des Tickets über die Ticket-API werden alle Daten aus der Konversation in den Text übernommen. Die Struktur dieses Texts muss dem Schema der Ticket-API entsprechen.
Informationen zu diesem Schema und den Feldern, die mit dem Ticket erstellt werden können, finden Sie in der Zendesk-Dokumentation für Entwickler.
Im folgenden Beispiel sehen Sie einen Anfragetext mit den oben erstellten Anfrageparametern.
Klicken Sie auf Produktion testen, um die Integration zu testen.
Daraufhin wird das neu erstellte Ticket im Zendesk-Dashboard angezeigt.
Formatierung des Chatprotokolls: Standard- vs. HTML-Text
Die Ticket-API unterstützt body oder html_body für Kommentare. Wenn Sie body verwenden, werden mehrere aufeinanderfolgende Leerzeichen zu einem einzigen Leerzeichen und mehrere Zeilenumbrüche („/n“) zu einem einzigen Zeilenumbruch zusammengefasst. Wenn Sie hingegen html_body verwenden, können Sie Kommentare mit der HTML-Standardsyntax formatieren.
Weitere Informationen finden Sie in der Zendesk-Dokumentation für Entwickler.
Um eine der beiden Varianten im „comment“ des erstellten Tickets zu verwenden, strukturieren Sie den Anfragetext entsprechend.
Hinweis: Verwenden Sie eine der beiden Optionen, nicht – wie in diesem Beispiel – beide.
Um die Lesbarkeit zu verbessern, wird empfohlen, die Werte vor dem Senden des Chatprotokolls der Konversation mit dem entsprechenden Tool neu zu formatieren. Fügen Sie Zeilenumbrüche hinzu, um die einzelnen Nachrichten zu trennen, damit diese nicht als zusammenhängender Textblock übertragen werden.
Wenn Sie HTML-Text senden, können Sie den HTML-Code mit dem Tool „Wert neu formatieren“ hinzufügen.
Anweisungen zur Verwendung des Tools „Wert neu formatieren“ finden Sie unter Neuformatieren von Werten in Anfrageparametern für AI Agents – Advanced.
Im unten stehenden Screenshot wurde das Chatprotokoll neu formatiert, um URL-Links zu generieren und mit <br> Zeilenumbrüche hinzuzufügen.
Standardfelder vs. angepasste Feldwerte
Neben den Standardfeldern, die erstellt und im Anfragetext gesendet werden können, können Sie auch angepasste Feldwerte erstellen. Anweisungen zum Einrichten angepasster Felder im Textkörper finden Sie in der Zendesk-Dokumentation für Entwickler.
Aufbau im Dialoggenerator
- Fügen Sie den API-Knoten hinzu und wählen Sie die Integration „Zendesk-Ticket erstellen“ aus, die Sie oben erstellt haben.
- Erstellen Sie eine Aktion im API-Knoten, die die Parameter aus der Konversation festlegt.
Diese sieht ungefähr so aus:
- Fügen Sie den beiden Szenarien – Erfolg und Fallback – jeweils passende Nachrichten hinzu.
