Webhooks verwalten

Erstellen eines Webhooks

Um einen Webhook zu erstellen, wählen Sie eine der folgenden Optionen aus:

• Wählen Sie in der Orchestrator-Symbolleiste das Plus-Symbol und dann Webhook aus.
• Wählen Sie auf der Mandantenseite die Option Webhooks und dann Webhook hinzufügen aus.

Fahren Sie als Nächstes auf der Seite Webhook hinzufügen mit der folgenden Konfiguration fort:

1. Geben Sie im obligatorischen Feld Name einen Namen für Ihren Webhook ein. Eine Zeichenfolge mit maximal 128 Zeichen ist zulässig.
   Hinweis:

   Stellen Sie sicher, dass der Name eindeutig ist, da zwei Live-Webhooks nicht denselben Namen auf Mandantenebene verwenden können. Ein bestimmter Name wird freigegeben, wenn der entsprechende Webhook gelöscht wird.

2. Geben Sie im Feld Beschreibung eine Beschreibung für Ihren Webhook ein. Ein String mit maximal 256 Zeichen ist zulässig.
3. Geben Sie im Feld URL eine benutzerdefinierte URL ein, an die Sie Informationen von Orchestrator senden möchten.
4. Aktivieren Sie das Kontrollkästchen SSL-Überprüfung deaktivieren, wenn die Webhook-Kommunikation nicht sicher sein soll. Diese Option wird nicht empfohlen!
5. Entfernen Sie die Markierung im Kontrollfeld Aktiviert (Enabled), wenn der Webhook, den Sie erstellen, deaktiviert werden soll.
6. (Optional) Fügen Sie ein benutzerdefiniertes Geheimnis mit einer Länge von bis zu 100 Zeichen hinzu, wenn die Webhook-Authentifizierung sicherer sein soll.
7. Wählen Sie die Option Alle Ereignisse senden (Send All Events) oder Einzelne Ereignisse auswählen (Select Individual Events). Mit der ersten Option können Sie alle verfügbaren Orchestrator-Ereignisse zur angegebenen URL senden, während Sie mit der letzteren einzelne Ereignisse angeben können.
8. Klicken Sie auf Speichern (Save). Der Webhook wurde erstellt. Sobald die entsprechenden Nutzdaten ausgelöst werden, erhalten Sie diese.

Bearbeiten eines Webhooks

1. Klicken Sie auf die entsprechende Schaltfläche Bearbeiten (Edit). Die Seite Bearbeiten (Edit) wird eingeblendet.
2. Nehmen Sie die notwendigen Änderungen an Ihrem Webhook vor (alle Felder können bearbeitet werden).
3. Klicken Sie auf Aktualisieren (Update). Ihre Änderungen werden erfolgreich gespeichert und die aktualisierte Seite Webhooks wird angezeigt.

Aktivieren oder Deaktivieren eines Webhooks

Um einen Webhook zu aktivieren oder zu deaktivieren, klicken Sie auf den Umschalter in der Spalte Aktiviert (Enabled). Bei einem aktivierten Webhook ist der Umschalter blau.

Wichtig:

Webhooks, die in mehr als 50 % der Fälle pro Tag an 7 aufeinanderfolgenden Tagen fehlschlagen, werden automatisch deaktiviert. In diesem Fall werden Sie benachrichtigt und ein Eintrag wird im Prüfungsfenster aufgezeichnet. Der Prüfungseintrag wird dem Benutzersystemadministrator zugeordnet, einem Catch-All-Benutzernamen für vom System ausgeführte Aktionen.

Entfernen eines Webhooks

1. Klicken Sie auf die entsprechende Schaltfläche Löschen (Delete). Sie werden aufgefordert, dies zu bestätigen.
2. Klicken Sie auf Ja (Yes). Der Webhook wird entfernt und die aktualisierte Seite Webhooks (Webhooks) wird eingeblendet.