In der Webentwicklung werden Webhooks in der Regel verwendet, um ein Verhalten in einem anderem System zu bewirken. Webhooks können beispielsweise folgende Aufgaben ausführen:
Webhooks können nur von Administratoren oder Agenten in einer angepassten Rolle mit entsprechenden Berechtigungen erstellt werden. Testkonten sind auf maximal 10 Webhooks und 60 Aufrufe pro Minute beschränkt.
Übersicht über Webhooks
Es gibt zwei Möglichkeiten, einen Webhook mit einer Aktivität in Zendesk Support zu verbinden:
- Abonnieren Sie den Webhook für ein oder mehrere Zendesk-Ereignisse. Verwenden Sie diese Verbindungsmethode, um Anforderungen auf Grundlage von Organisations-, Benutzer-, Agentenverfügbarkeits-, Help-Center- oder Community-Aktivitäten zu senden. Eine Liste der unterstützten Ereignistypen finden Sie unter Webhook event types in der API-Referenz.
- Verbinden Sie den Webhook mit einem Auslöser oder einer Automatisierung. Verwenden Sie diese Verbindungsmethode, um Anforderungen auf Grundlage von Ticketaktivitäten zu senden.
Ein Webhook, der ein Zendesk-Ereignis abonniert hat, kann nicht mit einem Auslöser oder einer Automatisierung verbunden werden. Ebenso kann ein Webhook, der mit einem Auslöser oder einer Automatisierung verbunden ist, keine Zendesk-Ereignisse abonnieren. Die Verbindungsmethode eines bestehenden Webhooks kann nicht geändert werden.
Abonnieren von Zendesk-Ereignissen
Ein Webhook, der ein oder mehrere Zendesk-Ereignisse abonniert hat, sendet Anforderungen immer mit der HTTP-Methode POST. Die Anforderung enthält eine JSON-Nutzlast mit den Ereignisdaten. Die HTTP-Methode oder die Nutzlast für die Anforderung kann nicht geändert werden. Weitere Informationen zu Nutzlast-Schemas für Ereignisse finden Sie unter Webhook event types in der API-Referenz.
Verbinden mit Auslösern oder Automatisierungen
-
JSON
-
XML
-
Formularcodierte Inhalte
Sie definieren den Inhalt der Anforderung, wenn Sie den Webhook mit einem Auslöser oder einer Automatisierung verbinden. Bei Webhooks, die die HTTP-Methode POST, PUT oder PATCH mit einem JSON- oder XML-Anforderungsformat verwenden, ist der Inhalt die Nutzlast der Anforderung. Webhooks, die andere HTTP-Methoden oder Formate verwenden, enthalten keine Nutzlast für die Anforderung. Stattdessen können Sie angepasste URL-Parameter als Array aus zwei Schlüssel-Wert-Strings hinzufügen. Beim Definieren der Nutzlast oder URL-Parameter der Anforderung können Sie einen der verfügbaren Inhaltsplatzhalter verwenden, um Ticketdaten in die Anforderung einzufügen.
Die Nutzlast oder URL-Parameter der Anforderung müssen kleiner sein als 256 KB.
Ändern der Reihenfolge von Webhooks und Neuversuche
Wenn ein Ereignis, ein Auslöser oder eine Automatisierung einen Webhook aufruft, wird der Webhook-Job in die Warteschlange gestellt, aber nicht sofort ausgeführt. 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
Sie erstellen Webhooks im Admin Center.
So erstellen Sie einen Webhook
- Klicken Sie in der Seitenleiste des Admin Centers auf
Apps und Integrationen und dann auf Aktionen und Webhooks > Webhooks.
- Klicken Sie auf Webhook erstellen.
- Um den Webhook für ein oder mehrere Zendesk-Ereignisse zu abonnieren, wählen Sie Zendesk-Ereignisse und dann im Dropdownmenü einen oder mehrere Ereignistypen.
- Um den Webhook mit einem Auslöser oder einer Automatisierung zu verbinden, wählen Sie Auslöser oder Automatisierung.
- Klicken Sie auf Weiter.
- Geben Sie einen Namen und eine Beschreibung für den Webhook ein.
- Geben Sie die Endpunkt-URL für die Integration mit dem Dienst oder System des Drittanbieters ein. Weitere Informationen finden Sie unter Webhook-Endpunkte.
Beim Einrichten eines Webhooks zur Integration mit einem Drittanbieter müssen Sie unter Umständen dessen Dokumentation zurate ziehen.
- Wählen Sie die Anfragemethode und das Anfrageformat des Webhooks aus.
- Wählen Sie die Authentifizierungsmethode für den Webhook aus und geben Sie alle weiteren erforderlichen Daten ein. Weitere Informationen finden Sie unter Authentifizieren eines Webhooks.
- (Optional) Klicken Sie auf Kopfzeile hinzufügen und füllen Sie die Felder Name der Kopfzeile und Wert aus. Bei Bedarf können Sie auf Weitere Kopfzeile hinzufügen klicken und bis zu vier weitere Kopfzeilen hinzufügen. Weitere Informationen finden Sie unter Angepasste Webhook-Kopfzeilen.Hinweis: Nehmen Sie keine vertraulichen Informationen in Ihre angepassten Kopfzeilen auf.
- (Optional) Klicken Sie auf Webhook testen, um sicherzustellen, dass er wie erwartet funktioniert.
- Klicken Sie auf Webhook estellen, um den Webhook zu erstellen.
- Bei Auslöser- und Automatisierungs-Webhooks müssen Sie den Webhook mit einem Auslöser oder einer Automatisierung verbinden. Weitere Informationen finden Sie unter Verbinden eines Webhooks mit einem Auslöser oder einer Automatisierung. Kehren Sie nach dem Verbinden des Auslösers oder der Automatisierung zur Seite Webhook erstellen zurück und klicken Sie auf Einrichtung abschließen.
Nachdem Sie den Webhook erstellt haben, können Sie die entsprechenden Details, Abonnements und Aktivitäten auf der Seite „Webhooks“ im Admin Center anzeigen. Weitere Informationen finden Sie unter Verwalten von Webhooks.
Webhook-Endpunkte
Webhooks senden Anforderungen an die Endpunkt-URL, die Sie bei der Erstellung angeben. 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.
Angepasste Webhook-Kopfzeilen
Angepasste Kopfzeilen bieten eine Möglichkeit, zusätzliche Informationen in die von Ihrem Webhook gesendete Anfrage aufzunehmen, und können die Verbindung zu einigen Drittanbieterdiensten erleichtern, die spezielle Anforderungen an Webhook-Kopfzeilen stellen. Für angepasste Kopfzeilen gelten folgende Anforderungen und Einschränkungen:
- Angepasste Kopfzeilen können nur in Verbindung mit einer sicheren Endpunkt-URL (HTTPS) verwendet werden.
- Fügen Sie keine Authentifizierungsdaten oder andere vertrauliche Informationen in angepasste Kopfzeilen ein. Verwenden Sie stattdessen die unterstützten Authentifizierungsmethoden.
- Der Name der Kopfzeile muss eindeutig sein und darf nicht mehr als 128 Zeichen enthalten. Neben allen US ASCII-Zeichen werden folgende Sonderzeichen unterstützt:
!
,#
,$
,%
,&
,'
,*
,+
,-
,.
,^
,_
,`
,|
und~
. - Der Wert der Kopfzeile kann bis zu 1.000 Zeichen lang sein und alle US ASCII-Zeichen von 0x20 bis 0x7E enthalten.
- Folgende Kopfzeilen werden nicht unterstützt:
- accept-charset
- accept-encoding
- connection
- content-encoding
- content-length
- content-md5
- content-type
- date
- expect
- forwarded
- host
- keep-alive
- max-forwards
- origin
- proxy-authenticate
- referer
- server
- te
- trailer
- transfer-encoding
- upgrade
- user-agent
- via
- www-authenticate
- zendesk-api-version
- zendesk-ep
- Kopfzeilen können außerdem nicht mit den folgenden Präfixen beginnen:
- access-control
- x-amzn
- x-apigw
- x-datadog
- x-envoy
- x-forwarded
- x-zendesk
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 des Endpunkts in der Dokumentation des Drittanbieters nachschlagen oder die für den Endpunkt geeignete Authentifizierungsmethode gemeinsam mit einem Entwickler Ihres Teams bestimmen.
- Nicht erforderlich: Es ist keine Authentifizierung konfiguriert oder erforderlich.
- API-Schlüssel: Verwenden Sie zur Authentifizierung des Webhooks einen API-Schlüssel.
- 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).
Für zusätzliche Sicherheit können Sie auch die Signatur des Webhooks überprüfen. Weitere Informationen finden Sie unter Verifying webhook authenticity (Englisch).
Verbinden eines Webhooks mit einem Auslöser oder einer Automatisierung
Zum Aufrufen eines Auslöser- und Automatisierungs-Webhooks müssen Sie den Webhook zuerst mit einem Auslöser oder einer Automatisierung verbinden. 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.
-
Erstellen Sie einen neuen Auslöser, oder setzen Sie den Mauszeiger auf das Symbol „Optionen“ (
) eines vorhandenen Auslösers und klicken Sie auf Bearbeiten.
- Klicken Sie unter Aktionen auf Aktion hinzufügen. Wählen Sie Webhook benachrichtigen und klicken Sie dann auf Ihren Webhook.
- Geben Sie die Anforderungs-Nutzlast oder URL-Parameter des Webhooks ein, je nach dem Anforderungsformat des Webhooks. Nutzlast oder Parameter müssen kleiner sein als 256 KB.
- Klicken Sie auf Speichern.
- Klicken Sie in der Seitenleiste des Admin Centers auf
Objekte und Regeln und dann auf Business-Regeln > Automatisierungen.
-
Erstellen Sie eine neue Automatisierung oder bearbeiten Sie eine vorhandene Automatisierung, indem Sie den Mauszeiger auf das Symbol „Optionen“ (
) setzen und auf Bearbeiten klicken.
- 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.
- Geben Sie die Anforderungs-Nutzlast oder URL-Parameter des Webhooks ein, je nach dem Anforderungsformat des Webhooks. Nutzlast oder Parameter müssen kleiner sein als 256 KB.
- 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 Aktionen und Webhooks > Webhooks.
- Wählen Sie den Webhook in der Liste aus, klicken Sie auf sein Optionsmenü (
) und wählen Sie Webhook testen.
- Wählen Sie im Bereich Webhook testen das Ereignis aus, das Sie testen möchten. Hierbei handelt es sich um eine Beispielanforderung, die Sie verwenden können, um Ihre Endpunkt-URL zu testen.
- 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.
81 Kommentare
Bernard Ugalde
Can anyone confirm if a light agent can authenticate for webhooks? We downgraded a system account from Agent to light agent, and now the activity for the webhook shows the following:

0
Peter Hochstrasser
Hi Caroline Scott
It would be best if you find a way to do this in Zendesk using built-in functionality (Yes, that's me who uses lots of webhooks and API scripts to implement things Zendesk has "forgotten" to add for years).
The main challenge here is that there's no functionality to send a mail TO the light agents instead of just CCing them (it doesn't matter if you're on Followers or not).
Do you have numbers, e.g.,
Depending on these numbers,
The API is pretty nice to use, but if you're on your own with no coding experience, you might want to look around for a partner who would be able to implement a solution for you. Usually, the Zendesk Reps are pretty helpful in that respect.
Let me add a word of caution: You have a problem, and you need a solution. Therefore, try to sketch the solution as precisely as possible - otherwise, it's hard to get a good solution implemented within a reasonable timeframe and budget.
0
Caroline Scott
Can anyone on this thread help me with an issue? I have several teams who want to be able to create a chaser to LIGHT AGENTS (or any agent type). We have lots (1000s) of light agents and they do not log in to Zendesk to update tickets, they respond via email. Currently we cc them into a ticket to ask via internal notes for advice/information and we would like to be able automatically contact them to remind them to reply after so many days. We are moving to the Followers experience very soon so we will be using the followers field to contact them instead of the CC field.
I am not a developer, I do not have access to a developer, I also am not confident in using the API. I have raised this need with Zendesk several times now with no solution that I can implement easily.
0
Peter Hochstrasser
Hi
The syntax for the Token is /token, not /API
0
Sharuk Ahmad
Hi All - I am trying to setup a webhook to automatically CC one end user each time a ticket is submitted. My initial problem is that I keep getting the following msg each time I am trying to test the webhook. Any help would be appreciated.
Response Body: {"error":"Couldn't authenticate you"}
My current Webhook setup:
Endpoint URL*: https://myorg.zendesk.com/api/v2/tickets/{{ticket.id}}.json
Request Method: PUT
Request Format: JSON
Authentication: Basic authentication
Username: myemail.org/API Token
Password: API Token
Note: I created a new API Token for Webhook
0
Ankit Jain
When devs/we read this or want to try out webhooks, devs don't have an HTTP endpoint to review incoming payloads from their instance of Zendesk. It takes some time to deploy an HTTP endpoint to inspect all types of incoming payloads. As zendesk is popular, the following information shall help fellow developers. For the authors, this suggestion should be moved to "Testing a webhook" section.
---
Typically when you want to start with webhook developments, you would like to know some or all possible payloads that zendesk can send. You shall need an HTTP endpoint to capture and review these incoming payloads. I suggest some HTTP bin kind of tools which are very popular and handy to get started in no time.
1. Beeceptor - https://beeceptor.com/ - Gives you an HTTP domain that you can enter in Zendesk and start receiving payloads. Using its mock feature you can respond with custom payloads/failures as well. Quite handy to start webhook development
2. RequestBIN - https://pipedream.com/requestbin - Gives you an HTTP endpoint to capture any incoming request. It always send 200 OK status.
0
Dane
This will entirely depend on the format of JSON will be accepted by it. As for slack the payload is like the payload below.
0
Andrew France
Hi all
I am new to webhooks, I can successfully send the json to a 3rd party system but my json file is empty. From the documentation it appears I need to add placeholders into the json format when creating the webhook. Am I correct in my thinking, if so what would an example look like?
Andrew
0
Jacob the Moderator
This announcement seems relevant to a lot of comments here:
Announcing API key authentication and custom headers for webhooks
0
Brett Bowser
I'd recommend reaching out to our Customer Support team regarding this issue so they can take a look at your account. More information on contacting their team here: Contact Zendesk Customer Support
Hope this helps!
0
Anmelden, um einen Kommentar zu hinterlassen.