Einen Benachrichtigungs-Webhook erstellen

Online bearbeiten

Benachrichtigungs-Webhooks sind externe API-Aufrufe, mit denen Sie bei bestimmten Ereignissen Daten an einen Drittanbieter senden können.

Informationen zu dieser Task

Sie können die Anfrage- URL der externen API konfigurieren, die Sie starten möchten, und alle Header oder Parameter hinzufügen, die für den Start der Anfrage- URL erforderlich sind. Informationen zu Ereignis-Payloads finden Sie unter „Ereignistypen und Payloads “.

In der JSON-Datei zur Webhook-Konfiguration ist eine Eigenschaft notification vorhanden. Diese Eigenschaft ist ein verschachteltes JSON-Objekt, das alle benachrichtigungsspezifischen Konfigurationsoptionen enthält. Die Eigenschaft interests ist in diesem notification-Objekt definiert. Wenn ein Ereignis ausgelöst wird, wird sie mit jedem Element in der Eigenschaft interests abgeglichen. Wenn ein Element in der interests Eigenschaft eine Übereinstimmung ergibt, wird das Ereignis an den Webhook-Empfänger gesendet. Interessen werden der Reihe nach geprüft; bei Anwendungsfällen mit hohen Anforderungen sollten Sie daher die breiteste Übereinstimmung an erster Stelle setzen.

Ein Interesse besteht aus zwei Feldern, einem freundlichen name und einer Liste von clauses. Diese Klauseln entscheiden darüber, ob die Interessen übereinstimmen oder nicht. Die Bedingungen sind durch eine AND Operation miteinander verknüpft, und nur wenn sie alle erfüllt sind, wird das Interesse befriedigt. Eine Klausel besteht aus drei Feldern:

key
value
operation - Gültige Werte sind include und exclude.

Der Schlüssel ist ein JSON-Eigenschaftsname und dient dazu, anzugeben, an welcher Stelle im Ereignis geprüft werden soll, ob diese Klausel zutrifft. Der Schlüssel kann verwendet werden, um Schlüssel der obersten Ebene oder Schlüssel innerhalb des Datenobjekts eines Ereignisses auszuwerten. Wenn auf das Datenobjekt verwiesen wird, wird die JSON-Punktnotation verwendet, zum Beispiel data.action. Der Wert entspricht dem Erwartungswert des untersuchten Feldes. Der Operator gibt an, ob eine Übereinstimmung mit dieser Klausel dazu führt, dass das Ereignis einbezogen oder ausgeschlossen wird.

Wenn beispielsweise Authentifizierungsereignisse im Mittelpunkt stehen, Sie aber Authentifizierungen, die über eine Verbundlösung erfolgen, herausfiltern möchten, verwenden Sie folgende Klauseln:

Key: event_type, Value: authentication, Operation: include
Key: data.subtype, Value: federation, Operation: exclude

Diese Klauseln werden zu logischen Ausdrücken:

event_type IST authentication UND data.subtype IST NICHT federation.

Weitere Informationen finden Sie unter „Benachrichtigungs-Webhooks “.

Vorgehensweise

Gehen Sie zu „Integrationen “ > „Benachrichtigungs-Webhooks “.
Klicken Sie auf „Webhook erstellen “.
Geben Sie einen Namen für den Webhook an.
Sie können auch einen Eigner und E-Mail-Kontaktinformationen angeben.
Geben Sie eine oder mehrere Anforderungs-URLs für die API an.
Wählen Sie den Typ der Authentifizierung aus.

Basis

Geben Sie den Benutzernamen und das Kennwort an.

Header

Geben Sie den Headernamen und den geheimen Authentifizierungsschlüssel an. Wenn beim geheimen Schlüssel die Groß-/Kleinschreibung beachtet werden muss, wählen Sie das Kontrollkästchen Beachten aus.

Ohne

Es sind keine Authentifizierungsinformationen erforderlich.

OAuth

Geben Sie den Tokenendpunkt an, wählen Sie aus, ob der geheime Clientschlüssel "post" oder "basis" ist, und geben Sie die Client-ID und den geheimen Clientschlüssel ein.
Hinweis: Aus dem Beitrag des Kunden geht hervor, dass das Geheimnis als Attribut gespeichert ist. "Client basic" gibt an, dass der geheime Schlüssel im Header gespeichert wird.

JSON Web Token (JWT)

Geben Sie den Wert des „ HTTP “-Headers, den „Sub“-Claim, die maximale Gültigkeitsdauer des JWT und den Signaturalgorithmus an. Wenn Sie möchten, können Sie auch ein Präfix für JWT-Header-Werte sowie JWT-Header-Schlüssel und Claim-Namen angeben.

Gegenseitiges TLS ( mTLS )

Geben Sie die Bezeichnung des MTLS-Zertifikats an.
Optional: Geben Sie beliebige benutzerdefinierte Kopfzeilen und Werte ein.
Optional: „Dead Letters “ aktivieren.
Unter „Dead Letters“ werden nicht zustellbare Benachrichtigungen aufgeführt.
1. Aktivieren Sie die Option „Automatischen Abgleich von Dead-Letter-Nachrichten versuchen“ und wählen Sie das Intervall für den Abgleich aus.
  Sie können festlegen, dass die Benachrichtigung alle 5, 15 oder 30 Minuten erneut gesendet wird.
Klicken Sie auf Weiter.
Legen Sie die Ereignisabonnements für Ihren Webhook fest.
Sobald eines der von Ihnen festgelegten Ereignisse eintritt, wird eine Benachrichtigung für den Webhook ausgelöst. Wählen Sie ein vordefiniertes Ereignis aus oder fügen Sie ein benutzerdefiniertes Ereignis hinzu. Sie müssen mindestens ein Ereignis angeben.
Optional: Klicken Sie auf „Vordefinierte Ereignisse “.
1. Aktivieren Sie das Kontrollkästchen für eines oder mehrere der vordefinierten Ereignisse.
  - Alle Authentifizierungsereignisse
  - Fehlgeschlagene Authentifizierungsereignisse
  - Benutzerprofil geändert
  - Benutzerprofil erstellt
  Die von Ihnen ausgewählten Ereignisse werden im Detailbereich unter „Ausgewählte Ereignisse “ aufgelistet.
2. Klicken Sie auf „Hinzufügen “.
  Sie gelangen zurück zur Seite „Ereignisabonnement“, und die Ereignisse werden im Abschnitt „Ereigniskonfiguration“ aufgelistet.
Optional: Klicken Sie auf „Benutzerdefiniertes Ereignis hinzufügen “.
1. Geben Sie einen Namen für das Ereignis ein.
  Sie können auch eine Beschreibung des Ereignisses angeben.
2. Geben Sie die Interessen an, die das Ereignis auslösen.
  Ereignisse bestehen aus einem Eigenschaft-Wert-Paar, das den Wert „wahr“ ergeben muss, damit das Ereignis ausgelöst wird.
3. Geben Sie an, ob die Zinsen einbezogen oder ausgeschlossen werden sollen.
  Sie können die Optionen „include“ und user.type admin „exclude“ festlegen event_type authentication , um den Webhook bei jedem Authentifizierungsereignis auszulösen, das nicht von einem Administrator stammt.
4. Optional: Geben Sie weitere Interessen an.
Klicken Sie auf „Hinzufügen “.
Sie gelangen zurück zur Seite „Ereignisabonnement“, und das Ereignis wird im Abschnitt „Ereigniskonfiguration“ aufgeführt.
Optional: Fügen Sie weitere benutzerdefinierte Ereignisse hinzu.
Klicken Sie auf „Erstellen “.
Der Webhook wird auf der Seite „Benachrichtigungs-Webhooks“ aufgeführt und angezeigt.
Optional: Passen Sie die Ereignisse des Webhooks an.
1. Fügen Sie weitere benutzerdefinierte und vordefinierte Ereignisse hinzu.
2. Ereignisse bearbeiten
  1. Wählen Sie das Ereignis aus, das Sie bearbeiten möchten, und klicken Sie auf das Stiftsymbol.
  2. Sie können den Namen oder die Beschreibung ändern. Sie können Interessen hinzufügen oder ändern.
  3. Klicken Sie auf „Aktualisieren “.
3. Um einen Termin zu löschen, wählen Sie ihn aus und klicken Sie auf das Symbol „Löschen “.
Optional: Ändern Sie die Verbindungsdaten.
1. Wählen Sie „Verbindungsdetails“ aus.
2. Ändern Sie alle Einstellungen mit Ausnahme von „Zweck“ und „Integrationsversion “.
3. Testen Sie die Verbindung.
4. Den Gesundheitsstatus anzeigen.
5. Lösche den Webhook.
Wenn Sie Änderungen vorgenommen haben, klicken Sie auf „Änderungen speichern “.
Klicken Sie auf „Benachrichtigungs-Webhooks“, um zur Seite „Benachrichtigungs-Webhooks“ zurückzukehren.