Webhook für Benachrichtigung erstellen

Online bearbeiten

Benachrichtigungs-Webhooks sind externe API-Aufrufe, mit denen Sie Daten an einen Drittanbieter senden, wenn bestimmte Ereignisse auftreten.

Informationen zu dieser Task

Sie können URL der externen API, die Sie starten möchten, konfigurieren und alle Header-Parameter hinzufügen, die zum Starten URL erforderlich sind. Informationen zu Ereignis-Nutzlasten finden Sie unter Ereignistypen und Nutzlasten.

In der Webhook-Konfigurations-JSON ist die 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 Eigenschaft interests als Übereinstimmung ausgewertet wird, wird das Ereignis an das Webhook-Ziel gesendet. Die Interessen werden in der Reihenfolge geprüft, so dass in leistungsfähigen Anwendungsfällen die breiteste Übereinstimmung an erster Stelle steht.

Ein Interesse besteht aus zwei Feldern, einem freundlichen name und einer Liste von clauses. Diese Klauseln entscheiden, ob das Interesse eine Übereinstimmung ist oder nicht. Die Klauseln werden mit einer AND -Operation verknüpft und nur dann, wenn sie alle dem Interesse entsprechen, erfüllt. Eine Klausel besteht aus drei Feldern:

  • key
  • value
  • operation -Gültige Werte sind include und exclude.
Der Schlüssel ist ein JSON-Eigenschaftsname und wird verwendet, um anzugeben, wo im Ereignis, um zu bestimmen, ob diese Klausel übereinstimmt. Der Schlüssel kann verwendet werden, um Schlüssel der höchsten Ebene oder Schlüssel im Datenobjekt eines Ereignisses auszuwerten. Wenn es auf das Datenobjekt verweist, wird die JSON-Punktschreibweise verwendet, z. B. data.action. Der Wert ist der erwartete Wert des zu überprüfenden Felds. Die Operation gibt an, ob eine Übereinstimmung mit dieser Klausel bewirkt, dass das Ereignis eingeschlossen oder ausgeschlossen wird.

Wenn beispielsweise Authentifizierungsereignisse das Schlüsselinteresse darstellen, Sie aber Authentifizierungen herausfiltern möchten, die über die Föderation auftreten, verwenden Sie die folgenden Klauseln:

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

Diese Klauseln werden zur logischen Auswertung:

event_type IST authentication UND data.subtype IST NICHT federation.

Weitere Informationen finden Sie unter Benachrichtigungs-Webhooks.

Vorgehensweise

  1. Navigieren Sie zu „Integrationen“ > „Benachrichtigungs-Webhooks “.
  2. Klicken Sie auf Webhook erstellen.
  3. Geben Sie einen Namen für den Webhook an.
    Sie können auch einen Eigner und E-Mail-Kontaktinformationen angeben.
  4. Geben Sie eine oder mehrere Anforderungs-URLs für die API an.
  5. 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: Der Clientbeitrag gibt an, dass der geheime Schlüssel als Attribut gespeichert wird. "Client basic" gibt an, dass der geheime Schlüssel im Header gespeichert wird.
    JSON Web Token (JWT)
    Geben Sie HTTP, den Unteranspruch, die maximale Gültigkeitsdauer des JWT und den Signaturalgorithmus an. Bei Bedarf können Sie auch ein Präfix für JWT-Headerwerte, JWT-Headerschlüssel und Deklarationsnamen angeben.
    Gegenseitige TLS (mTLS)
    Geben Sie die MTLS-Zertifikatsbezeichnung an.
  6. Optional: Geben Sie beliebige benutzerdefinierte Header und Werte ein.
  7. Optional: Deaktivierte E-Mails aktivieren.
    Die Funktion für nicht zustellbare Nachrichten zeichnet nicht erfolgreiche Benachrichtigungen auf.
    1. Aktivieren Sie Abgleich für nicht zustellbare Nachrichten automatisch versuchen und wählen Sie das Abgleichsintervall für den Versuch aus.
      Sie können angeben, dass die Benachrichtigung alle 5, 15 oder 30 Minuten erneut gesendet werden soll.
  8. Klicken Sie auf Weiter.
  9. Geben Sie die Ereignissubskriptionen für Ihren Webhook an.
    Wenn eines der angegebenen 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.
  10. Optional: Klicken Sie auf „Vordefinierte Ereignisse “.
    1. Wählen Sie das Kontrollkästchen für eines oder mehrere der vordefinierten Ereignisse aus.
      • Alle Authentifizierungsereignisse
      • Fehlgeschlagene Authentifizierungsereignisse
      • Benutzerprofil geändert
      • Benutzerprofil erstellt
      Die ausgewählten Ereignisse werden im Teilfenster Details für Ausgewählte Ereignisseaufgelistet.
    2. Klicken Sie auf Hinzufügen.
      Sie kehren zur Seite Ereignissubskription zurück und die Ereignisse werden im Abschnitt Ereigniskonfiguration aufgeführt.
  11. Optional: Klicken Sie auf „Benutzerdefiniertes Ereignis hinzufügen “.
    1. Geben Sie einen Namen für das Ereignis an
      Sie können auch eine Beschreibung des Ereignisses angeben.
    2. Geben Sie die Interessen an, die das Ereignis auslösen.
      Ereignisse sind ein Eigenschaft/Wert-Paar, das als wahr ausgewertet werden muss, um das Ereignis auszulösen.
    3. Geben Sie an, ob die Zinsen eingeschlossen oder ausgeschlossen werden.
      Sie können event_type authentication include und user.type admin exclude angeben, um den Webhook bei allen Authentifizierungsereignissen auszulösen, die nicht von und admin stammen.
    4. Optional: Weitere Interessen angeben.
  12. Klicken Sie auf Hinzufügen.
    Sie kehren zur Seite Ereignissubskription zurück und das Ereignis wird im Abschnitt Ereigniskonfiguration aufgelistet.
  13. Optional: Weitere benutzerdefinierte Ereignisse hinzufügen.
  14. Klicken Sie auf Erstellen.
    Der Webhook wird auf der Seite Benachrichtigungs-Webhooks aufgelistet und angezeigt.
  15. Optional: Ändern Sie die Ereignisse des Webhooks.
    1. Fügen Sie weitere angepasste und vordefinierte Ereignisse hinzu
    2. Ereignisse bearbeiten
      1. Wählen Sie das Ereignis aus, das Sie ändern möchten, und klicken Sie auf das Stiftsymbol Bearbeitungssymbol.
      2. Sie können den Namen oder die Beschreibung ändern. Sie können die Interessen hinzufügen oder ändern.
      3. Klicken Sie auf Aktualisieren.
    3. Um ein Ereignis zu entfernen, wählen Sie es aus und klicken Sie auf das Symbol Subtraktionszeichen innerhalb eines Kreises„Entfernen“.
  16. Optional: Ändern Sie die Verbindungsdetails.
    1. Wählen Sie Verbindungsdetailsaus.
    2. Ändern Sie alle Einstellungen mit Ausnahme von Zweck und Integrationsversion.
    3. Testen Sie die Verbindung.
    4. Zeigen Sie den Allgemeinzustand an.
    5. Löschen Sie den Webhook.
  17. Wenn Sie Änderungen vorgenommen haben, klicken Sie auf Änderungen speichern.
  18. Klicken Sie auf Benachrichtigungs-Webhooks , um zur Seite Benachrichtigungs-Webhooks zurückzukehren.