Webhooks werden im Zendesk Admin Center auf der Seite „Webhooks“ erstellt und verwaltet.
Webhooks können nur von Administratoren oder Agenten in einer angepassten Rolle mit entsprechenden Berechtigungen verwaltet werden.
Bearbeiten und Verwalten von Webhooks
In den meisten Fällen können Administratoren Webhooks bearbeiten, klonen, deaktivieren und löschen. Webhooks, die durch App-Anforderungen erstellt wurden, können jedoch nur bearbeitet, nicht aber geklont oder gelöscht werden. Webhooks, die durch App-Anforderungen erstellt wurden, können vom App-Entwickler aktualisiert werden. Dabei werden eventuelle von Kontoadministratoren vorgenommene Änderungen außer Kraft gesetzt. Nach Erstellung eines Webhooks kann die Verbindungsmethode nicht mehr geändert werden.
So bearbeiten 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 das zugehörige Optionsmenü (
) und dann auf Bearbeiten. - Nehmen Sie die erforderlichen Änderungen vor.
Alle Felder sind bearbeitbar. Bei Verwendung von Authentifizierung können der Schlüssel, das Token oder das Kennwort jedoch nicht mehr angezeigt werden, nachdem der Webhook erstellt oder aktualisiert wurde. Um eine angepasste Kopfzeile zu entfernen, klicken Sie auf das Löschsymbol (
). - (Optional) Testen Sie die Änderungen, die Sie an dem Webhook vorgenommen haben.
- Klicken Sie auf Speichern.
So klonen 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 das zugehörige Optionsmenü () und dann auf Klonen.
- Bearbeiten Sie den Namen des Webhooks und nehmen Sie die gewünschten Änderungen vor.
- Klicken Sie auf Aktualisieren.
So deaktivieren 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 das zugehörige Optionsmenü () und dann auf Deaktivieren.
- Klicken Sie im Bestätigungsdialogfeld auf Deaktivieren.
So löschen 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 das zugehörige Optionsmenü () und dann auf Löschen.
- Klicken Sie auf Löschen.
Anzeigen der Aktivität eines Webhooks
Zu jedem Webhook gibt es ein Aktivitätsprotokoll. Neben einer detaillierten Aufzeichnung der Aufrufe enthält es auch die Anzahl der Anforderungen in den vergangenen sieben Tagen.
Ein Webhook-Aufruf wird automatisch bis zu dreimal wiederholt, wenn der Endpunkt bestimmte HTTP-Antwortcodes zurückgibt. Weitere Informationen und Beispiele zu Wiederholungsszenarien finden Sie in unserer Entwicklerdokumentation unter Webhook retry logic (Englisch).
Zendesk bemüht sich, Aktionen jeweils nur einmal an einen Webhook zu übergeben. Wir können dies jedoch nicht garantieren. Es ist möglich, dass ein Webhook mehrfach durch dieselbe Aktion aufgerufen wird oder dass unter bestimmten Umständen, z. B. wenn der Webhook Circuit Breaker ausgelöst wird, Aktionen überhaupt nicht zugestellt werden. Um doppelte Aufrufe zu erkennen, können Sie Webhook-Signaturen verwenden. Wenn dies für Ihren Arbeitsablauf problematisch ist, stellen Sie sicher, dass die aus Ihren Webhooks resultierenden Aktionen idempotent sind.
- 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 das zugehörige Optionsmenü () und dann auf Details anzeigen.
- Klicken Sie auf die Registerkarte Aktivität.
- Klicken Sie auf Filter, um das Aktivitätsprotokoll nach Startdatum, Startzeit, Enddatum, Endzeit oder Status zu filtern, und dann auf Filter anwenden.
Debuggen eines Webhooks
Wenn ein Webhook nicht ordnungsgemäß funktioniert, werden in seinem Aktivitätsprotokoll fehlgeschlagene Aufrufe angezeigt. Sie können das Aktivitätsprotokoll nach fehlgeschlagenen Aufrufen oder nach einem bestimmten Fehlertyp filtern. Außerdem können Sie in der Registerkarte „Aktivität“ auf eine Aufruf-ID klicken, um die Anforderung und die Antwort zu dem betreffenden Webhook-Aufruf anzuzeigen.
In den meisten Fällen kommt die Antwort von dem Drittanbieterdienst, der die Webhook-Anfrage erhalten hat, und nicht von Zendesk selbst. Fehler müssen deshalb in der Regel in Zusammenarbeit mit diesem Dienst behoben werden.
Für die Fehlerdiagnose können Sie den numerischen Code im Antwortstatus verwenden. Als Antwortstatuscodes werden für alle HTTP-Anfragen dieselben Standard-HTTP-Codes verwendet. Eine Liste der Standard-HTTP-Antwortstatuscodes und ihrer Bedeutung finden Sie in den MDN Web Docs unter HTTP response status codes.
Der Timeout für Webhook-Anfragen beträgt 10 Sekunden. Der Antwortstatus „Failed: 504 Gateway Timeout“ gibt an, dass ein Dienst nicht innerhalb der vorgegebenen Zeit auf die Anfrage eines Webhooks geantwortet hat. Das Zeitlimit kann nicht angepasst werden.