EasyUC
Deutsch
Aurora

Design auswählen

4.8.7

Administration

Webhooks und Zustellprotokoll

Änderungen an Benutzern, Telefonen und Sprachboxen als HTTP-POST an ein Fremdsystem melden.

EasyUC · Version 4.8.7

In EasyUC: EasyUC Cisco → Verwaltung → Integrationen & Kommunikation → Webhooks

Wozu dient das

Ein Webhook meldet Ereignisse aus EasyUC an ein anderes System. Sobald ein Endbenutzer, ein Telefon, ein Geräteprofil, eine Sprachbox oder eine Endbenutzer-Aufgabe angelegt, geändert oder gelöscht wird, sendet EasyUC eine POST-Anfrage mit den Details an die hinterlegte Adresse.

Typische Empfänger sind Ticketsysteme, Inventar- oder Abrechnungssysteme. EasyUC protokolliert jede Zustellung mit Anfrage, Antwort und Antwortcode. Schlägt eine Zustellung fehl, versucht EasyUC es erneut, insgesamt bis zu acht Mal.

Voraussetzungen

  • Ein Konto mit dem Zugriffstyp Administrator (Vollzugriff) (ROLE_APP_ADMIN) oder das Eigentümerkonto (ROLE_OWNER). Nur diese Konten sehen das Menü Verwaltung.
  • Eine Adresse des Empfängers, die POST-Anfragen annimmt und vom EasyUC-Server aus erreichbar ist.
  • Bei HTTPS ein Zertifikat des Empfängers, dem der EasyUC-Server vertraut.
  • Falls der Empfänger eine Anmeldung verlangt: Benutzername und Kennwort für Basic Auth.
  • Für Fehlermails: eingerichteter E-Mail-Versand.

Schritt für Schritt: Webhook anlegen

  1. Öffnen Sie den Arbeitsbereich EasyUC Cisco.
  2. Wählen Sie Verwaltung → Integrationen & Kommunikation → Webhooks.
  3. Klicken Sie oben rechts auf Webhook hinzufügen.
  4. Tragen Sie unter Payload URL die Adresse des Empfängers ein, zum Beispiel https://tickets.intern/hooks/easyuc.
  5. Lassen Sie unter SSL-Prüfung die Auswahl SSL-Prüfung aktivieren stehen.
  6. Verlangt der Empfänger eine Anmeldung, schalten Sie Zugangsdaten (Basic Auth) ein und füllen Sie Benutzername, Passwort und Passwort wiederholen aus.
  7. Tragen Sie unter E-Mail-Adressen hinzufügen (Adresse eingeben und Enter drücken) die Adressen ein, die bei einem Zustellfehler eine Mail bekommen sollen.
  8. Wählen Sie unter Welche Ereignisse (Aktionen) sollen diesen Webhook auslösen? entweder Alles senden oder Einzelne Aktionen auswählen und haken Sie dann je Objekt Erstellen, Aktualisieren und Löschen an.
  9. Wählen Sie unter Auf welche CUCM-Verbindungen soll dieser Webhook angewendet werden? entweder Alle oder Verbindungen auswählen und dann die Cluster unter Verbindungen.
  10. Klicken Sie auf Erstellen. Der Webhook erscheint in der Liste mit der Marke aktiviert und dem Hinweis Dieser Hook wurde noch nie ausgelöst.

Schritt für Schritt: Zustellung prüfen

  1. Lösen Sie ein passendes Ereignis aus, zum Beispiel durch Ändern eines Testbenutzers.
  2. Klicken Sie in der Zeile des Webhooks auf Aktionen → Audit-Logs.
  3. Lesen Sie die Spalte Ereignisstatus: ausstehend, wird verarbeitet, erfolgreich oder Fehler, dazu der Antwortcode des Empfängers.
  4. Klicken Sie in der Zeile auf Anzeigen → Anfrage gesendet, um die übertragenen Daten zu sehen.
  5. Klicken Sie auf Anzeigen → Antwort empfangen, um die Antwort des Empfängers zu sehen.

Schritt für Schritt: Webhook ändern, abschalten oder löschen

  1. Klicken Sie in der Zeile auf Aktionen → Aktualisieren. Das Fenster Webhook aktualisieren öffnet sich.
  2. Zum vorübergehenden Abschalten schalten Sie Aktivieren aus. Die übrigen Felder verschwinden, die Einstellungen bleiben gespeichert.
  3. Ändern Sie bei Bedarf Adresse, Ereignisse oder Verbindungen und klicken Sie auf Aktualisieren.
  4. Zum Entfernen wählen Sie Aktionen → Löschen und bestätigen die Rückfrage Sind Sie sicher?.

Felder und Optionen

Feld / AktionBedeutung und Verwendung
AktivierenNur beim Bearbeiten. Aus: Der Webhook sendet nichts. Neue Webhooks sind aktiviert.
Payload URLAdresse, an die EasyUC die POST-Anfrage sendet.
SSL-PrüfungSSL-Prüfung aktivieren (Standard) prüft das Zertifikat des Empfängers. Deaktivieren (nicht empfohlen) schaltet die Prüfung ab.
Zugangsdaten (Basic Auth)Schalter Aktiviert oder Deaktiviert. Ein: EasyUC meldet sich mit Benutzername und Passwort beim Empfänger an. Standard: aus.
E-Mail-Adressen hinzufügenEmpfänger einer Mail bei Zustellfehlern. Mehrere Adressen möglich, jede mit Enter abschließen.
Alles senden / Einzelne Aktionen auswählenStandard: Alles senden. Bei Einzelauswahl erscheinen die Objektgruppen.
EndbenutzerErstellen, Aktualisieren, Löschen sowie Automatische Löschung (Kurzinfo) für Benutzer, die die automatische Bereinigung entfernt.
SprachnachrichtenErstellen, Aktualisieren, Löschen für Sprachboxen.
TelefoneErstellen, Aktualisieren, Löschen für Geräte.
GeräteprofileErstellen, Aktualisieren, Löschen für Geräteprofile.
Endbenutzer-AufgabenErstellen und Löschen. Dazu die Wahl Vollständige Aufgabeninfos senden (Standard) oder Kompakte Aufgabeninfos senden.
Alle / Verbindungen auswählenStandard: Alle Cluster. Bei Auswahl nur Ereignisse aus den gewählten Verbindungen.
Erneute Zustellung (Zustellprotokoll)Zeigt true, wenn der Eintrag ein weiterer Zustellversuch ist, sonst false.
Erstellt am / Zugestellt amZeitpunkt des Ereignisses und der erfolgreichen Zustellung. Darunter steht gegebenenfalls gesendet nach <Anzahl> Versuchen oder nicht zugestellt nach 8 Versuchen.

Ergebnis prüfen und Fehler eingrenzen

  • Erfolg: Im Zustellprotokoll steht erfolgreich mit dem Antwortcode des Empfängers und einer Zeit unter Zugestellt am.
  • Status Fehler mit einem Antwortcode ab 400: Der Empfänger hat die Anfrage abgelehnt. Prüfen Sie Adresse, Zugangsdaten und die Antwort unter Antwort empfangen.
  • Status Fehler ohne brauchbaren Antwortcode: EasyUC erreicht den Empfänger nicht oder vertraut dem Zertifikat nicht. Prüfen Sie Namensauflösung, Firewall und Zertifikatskette. Schalten Sie die SSL-Prüfung nicht dauerhaft ab.
  • Status ausstehend (nach <Anzahl> Versuchen): EasyUC versucht die Zustellung erneut. Nach acht Versuchen steht nicht zugestellt nach 8 Versuchen.
  • Der Empfänger muss damit umgehen können, dass dasselbe Ereignis mehrfach ankommt.
  • Es entsteht kein Eintrag: Das Ereignis passt nicht zur Auswahl der Aktionen oder Verbindungen oder der Webhook ist deaktiviert.

Weiterlesen