Erstellen von Webhooks im Admin Center

Direktzugriff: Admin Center > Apps und Integrationen > Webhooks > Webhooks

Ein Webhook sendet beim Auftreten eines Ereignisses – beispielsweise beim Aktivieren eines Auslösers oder einer Automatisierung in Zendesk Support – eine HTTP-Anforderung an eine bestimmte URL. In der Webentwicklung werden Webhooks in der Regel verwendet, um ein Verhalten in einem anderem System zu bewirken.

Webhooks können nur von Administratoren oder Agenten in einer angepassten Rolle mit entsprechenden Berechtigungen erstellt werden.

Hinweis: Testkonten sind auf maximal 10 Webhooks begrenzt.

In diesem Beitrag werden folgende Themen behandelt:

Übersicht über Webhooks
Erstellen eines Webhooks
Testen eines Webhooks

Übersicht über Webhooks

Webhooks werden verwendet, um Drittanbieterdienste oder Ihr Backend-System zu integrieren. Webhooks können beispielsweise folgende Aufgaben ausführen:

Ihr Team in Slack benachrichtigen, wenn ein dringendes Ticket erstellt wird
Ihrem Dokumentationsteam nach dem Lösen eines Tickets Ticketdetails in Asana zur Verfügung stellen
Ihren eigenen Backend-Dienst über ein wichtiges Ticketereignis benachrichtigen

Sie können Webhooks verwenden, um Informationen an Drittanbieterdienste und REST-APIs zu übertragen, die JSON-, XML- oder formularcodierte Inhalte in HTTP-Anforderungen akzeptieren. Außerdem können Sie mit Webhooks URL-Parameter an eine beliebige URL übergeben.

Webhooks werden von Automatisierungen und Auslösern in Zendesk Support verwendet, wenn ein Ticket bestimmte Bedingungen erfüllt. Webhooks sind wichtig, weil sie Auslösern und Automatisierungen die Möglichkeit bieten, mit Aktionen auf die HTTP-Anforderungen von Drittanbieterdiensten zu reagieren.

Sie können alle verfügbaren Inhaltsplatzhalter verwenden, um Ticketdaten in die HTTP-Anforderungen einzufügen.

Wenn eine Business-Regel einen Webhook auslöst, wird der Webhook nicht sofort ausgeführt, sondern in die Warteschlange gestellt. Da Webhook-Aufträge unabhängig voneinander ausgeführt werden, lässt sich die Reihenfolge, in der sie abgearbeitet werden, nicht festlegen.

Webhook-Anforderungen werden automatisch bis zu dreimal wiederholt, wenn der Endpunkt bestimmte HTTP-Antwortcodes zurückgibt. Anders als Ziele werden Webhooks nicht nach drei fehlgeschlagenen Aufrufen in Folge deaktiviert. Weitere Informationen und Beispiele zu Wiederholungsszenarien finden Sie in unserer Entwicklerdokumentation unter Monitoring webhooks (Englisch).

Erstellen eines Webhooks

Webhooks werden in zwei Schritten erstellt. Im ersten Schritt definieren Sie die Details des Webhooks selbst. Anschließend verbinden Sie den Webhook mit einem Auslöser oder einer Automatisierung, sodass er verwendet werden kann.

Hinweis: Beim Einrichten eines Webhooks zur Integration mit einem Drittanbieter müssen Sie unter Umständen dessen Dokumentation zurate ziehen.

So erstellen Sie einen Webhook

Klicken Sie in der Seitenleiste des Admin Centers auf Apps und Integrationen und dann auf Webhooks > Webhooks.
Klicken Sie auf Aktionen und dann auf Webhook erstellen.
Konfigurieren Sie den Webhook für die Integration mit dem Dienst oder System des Drittanbieters.
Weitere Informationen finden Sie in den Abschnitten Webhook-Endpunkte und Authentifizieren eines Webhooks.
(Optional) Klicken Sie auf Webhook testen, um sicherzustellen, dass er wie erwartet funktioniert.
Klicken Sie auf Weiter, um den Webhook mit einem Support-Auslöser oder einer Support-Automatisierung zu verbinden. Dies geschieht in der Administratoroberfläche von Zendesk Support.
Kehren Sie zur Seite Webhook erstellen im Admin Center zurück und klicken Sie auf Einrichtung abschließen.

Nachdem Sie einen Webhook erstellt und mit einem Auslöser oder einer Automatisierung verbunden haben, können Sie seine Details, abonnierten Ereignisse und Aktivitäten auf der Seite „Webhooks“ im Admin Center anzeigen. Weitere Informationen finden Sie unter Verwalten von Webhooks im Admin Center.

Webhook-Endpunkte

Webhooks senden Anfragen an die beim Erstellen angegebene Endpunkt-URL und empfangen deren Antworten. Auf diese Weise lassen sie sich in Dienste, APIs und Systeme von Drittanbietern integrieren.

Die Endpunkt-URL weist das folgende Format auf: https://www.yourdomain.com/path.

Die Verwendung von sicherem HTTP (HTTPS) ist nicht zwingend erforderlich, wird aber empfohlen. Eine sichere Endpunkt-URL ermöglicht die Authentifizierung sowie die sichere Übertragung von Daten.

Authentifizieren eines Webhooks

Wenn Ihr Webhook mit einem sicheren Endpunkt integriert ist, haben Sie drei Möglichkeiten, den Webhook und die von ihm gesendeten Daten zu authentifizieren. Bei Bedarf können Sie die Authentifizierungsanforderungen Ihres Endpunkts in der Dokumentation des Drittanbieters nachschlagen oder die für Ihren Endpunkt geeignete Authentifizierungsmethode gemeinsam mit einem Entwickler Ihres Teams bestimmen.

Nicht erforderlich – Es ist keine Authentifizierung konfiguriert oder erforderlich.
Standardauthentifizierung – Verwenden Sie zur Authentifizierung des Webhooks einen Benutzernamen und ein Kennwort.
Inhaber-Token – Verwenden Sie zur Authentifizierung des Webhooks ein OAuth-Zugriffstoken.

Wenn Ihre Entwickler weitere Informationen zur Authentifizierung von Webhooks brauchen, verweisen Sie sie auf den Beitrag Webhook security and authentication (Englisch).

Verbinden eines Webhooks mit einem Auslöser oder einer Automatisierung

Damit ein Webhook funktioniert, muss er mit einem Auslöser oder einer Automatisierung verbunden werden. Die Auslöser und Automatisierungen geben an, unter welchen Voraussetzungen der Webhook aufgerufen werden soll.

So verbinden Sie einen Webhook mit einem Support-Auslöser

Klicken Sie in der Seitenleiste des Admin Centers auf Objekte und Regeln und dann auf Business-Regeln > Auslöser.
Hinweis: Wenn Sie einen Webhook erstellen oder bearbeiten, klicken Sie auf Business-Regeln verwalten.
Erstellen Sie einen neuen Auslöser, oder setzen Sie den Mauszeiger auf das Symbol „Optionen“ () eines vorhandenen Auslösers und klicken Sie auf Bearbeiten.
Für einen Auslöser klicken Sie unter Aktionen auf Aktion hinzufügen. Wählen Sie Webhook benachrichtigen und klicken Sie dann auf Ihren Webhook. Klicken Sie auf Speichern.

So verbinden Sie einen Webhook mit einer Support-Automatisierung

Klicken Sie in der Seitenleiste des Admin Centers auf Objekte und Regeln und dann auf Business-Regeln > Automatisierungen.
Hinweis: Wenn Sie einen Webhook erstellen oder bearbeiten, klicken Sie auf Business-Regeln verwalten.
Erstellen Sie eine neue Automatisierung oder bearbeiten Sie eine vorhandene Automatisierung, indem Sie den Mauszeiger auf das Symbol „Optionen“ () setzen und auf Bearbeiten klicken.
Für eine Automatisierung klicken Sie unter Diese Aktionen durchführen auf das Symbol „Aktion hinzufügen“ (). Wählen Sie Benachrichtigungen: Webhook benachrichtigen und klicken Sie dann auf Ihren Webhook. Klicken Sie auf Einreichen.

Testen eines Webhooks

Im Admin Center haben Sie die Möglichkeit, den Webhook mit verschiedenen Ereignisquellen und Anforderungen zu testen. Sie können einen vorhandenen Webhook für den Test auswählen, aber auch einen Webhook testen, den Sie gerade erstellen oder bearbeiten.

So testen Sie einen Webhook

Klicken Sie in der Seitenleiste des Admin Centers auf Apps und Integrationen und dann auf Webhooks > Webhooks.
Wählen Sie den Webhook in der Liste aus, klicken Sie auf sein Optionsmenü () und wählen Sie Webhook testen.
Klicken Sie im Bereich Webhook testen auf Ereignisquelle testen. Diese Ereignisquelle ist ein angehängter Auslöser oder ein Beispielticket, mit dessen Hilfe Sie Ihre Endpunkt-URL testen können.
Geben Sie die Details Ihrer Testanforderung – Anforderungstext, Parameter oder Header – ein.
Klicken Sie auf Test senden. Die Antwort wird im Bereich unter der Testanforderung angezeigt.