Webhook-Benachrichtigungskanal

Ein Webhook-Benachrichtigungskanal in Document360 ist eine automatisierte Methode, um Echtzeit-Ereignisdaten aus Ihrer Wissensdatenbank an eine externe Anwendung zu senden, wann immer eine bestimmte Aktion ausgeführt wird. Webhooks machen manuelle Überwachung überflüssig, indem sie strukturierte JSON-Payloads direkt auf eine URL Ihrer Wahl übertragen – wie einen Slack-Kanal, eine benutzerdefinierte Integration oder eine Automatisierungsplattform. Du kannst mehrere Webhook-Kanäle konfigurieren und jeden einzelnen über die Benachrichtigungskarten-Einstellungen bestimmten Ereignissen der Knowledge Base zuordnen.

Wann sollte man Webhook-Benachrichtigungskanäle verwenden

Nutzen Sie Webhook-Benachrichtigungen, wenn Sie automatisieren möchten, wie Ihr Team oder externe Systeme auf Änderungen in der Wissensdatenbank reagieren.

• Team-Benachrichtigungen: Benachrichtigen Sie ein Support- oder Dokumentationsteam in Slack oder Microsoft Teams sofort, wenn ein Artikel veröffentlicht, aktualisiert oder gelöscht wird – ohne dass jemand das Portal manuell überprüfen muss.
• Cache-Ungültigkeit: Erkennen Sie Artikellöschereignisse (einschließlich Slugs für alle Sprachen) und entfernen Sie automatisch die entsprechenden Einträge aus Ihrem Inhaltscache.
• Workflow-Automatisierung: Lösen Sie nachgelagerte Prozesse in Tools wie Make oder Zapier aus, wenn bestimmte Ereignisse auftreten, wie etwa ein neuer Artikel veröffentlicht wird oder ein Erweiterungstoken gelöscht wird.
• Audit und Compliance: Streamen Sie Aktivitäten der Wissensdatenbank zu einem Logging-Service, um eine Echtzeit-Audit-Spur zu erhalten, wer wann was geändert hat.

Bevor du anfängst

• Haben Sie die Ziel-Webhook-URL bereit – dies ist der Endpunkt, der von der empfangenden Anwendung bereitgestellt wird (z. B. eine Slack-Eingehende Webhook-URL, ein Make-Szenario-Webhook oder Ihr eigener Server-Endpunkt).
• Wenn die empfangende Anwendung eine Authentifizierung benötigt, erhalten Sie vor Beginn den Autorisierungsschlüssel .

Wie man einen Webhook-Benachrichtigungskanal einrichtet

1. Navigiere zu Einstellungen () > Knowledge Base-Portal in der linken Navigationsleiste.

2. Wählen Sie im linken Navigationsfeld Benachrichtigungen aus.
   Der Tab Benachrichtigungskanäle ist standardmäßig ausgewählt.

3. Klicken Sie auf Neuen Kanal.

4. Im Panel Verfügbare Kanäle wählen Sie Webhook aus und klicken Sie auf Nächst.

   

   Das Kanal-Konfigurationspanel erscheint.

5. Im Feld Freundlicher Name geben Sie einen eindeutigen Namen für diesen Webhook-Kanal ein.

6. Im Dropdown-Menü der Anfrage-Methode wählen Sie POST oder PUT, je nachdem, was die empfangende Anwendung erwartet.

7. Im Webhook-URL-Feld geben Sie die Ziel-URL ein, in der Benachrichtigungen gesendet werden sollen.

8. Im Dropdown-Menü "Inhalt anfordern " wählen Sie das Nachrichtenformat für die Nutzlast.

9. Wenn die empfangende Anwendung zusätzliche HTTP-Header benötigt, klicken Sie unter Standard-Headern auf Add new () und fügen Sie jeden Header als Schlüssel-Wert-Paar hinzu.

10. Wenn eine Authentifizierung erforderlich ist, geben Sie den Autorisierungsschlüssel im entsprechenden Feld ein.

11. Klicken Sie auf Speichern.

Der Webhook-Kanal wird erstellt und unter Benachrichtigungskanälen aufgeführt. Um es zu aktivieren, gehe zum Tab Benachrichtigungszuordnung und ordne den Kanal den Ereignissen zu, die du verfolgen möchtest.

Best Practices

• Verwenden Sie beschreibende freundliche Namen , die sowohl das Ziel als auch den Ereignisumfang identifizieren – zum Beispiel oder Slack-ArticlePublish Make-AllEvents –, damit Kanäle bei der Zuordnung von Benachrichtigungen leicht zu unterscheiden sind.
• Fokussiere jeden Kanal auf eine fokussierte Menge von Ereignissen, anstatt alle Ereignisse über einen einzigen Webhook zu leiten. Das erleichtert es, Fehler zu verwalten und bestimmte Ereignistypen unabhängig zu wiederholen.
• Sichern Sie Ihren Endpunkt mit einem Autorisierungsschlüssel, wann immer die empfangende Anwendung ihn unterstützt, um zu verhindern, dass unautorisierte Nutzlasten Ihre Systeme erreichen.
• Verwenden Sie das Slugs-Feld in Delete-Events , um sofort die korrekten Cache-Einträge in allen Sprachen zu identifizieren und zu löschen, wenn ein Artikel entfernt wird, um veralteten Inhalt zu vermeiden.

FAQ

{
  "Knowledge base name": "Document360 2.0",
  "Event": "Article settings saved",
  "User": "Matt Sterling",
  "User email": "matt.sterling@document360.co",
  "Logged on (UTC)": "09/12/2025 06:15:00",
  "Article name": "Getting Started",
  "Article id": "e1444f0x-0xx0-000x-xxx0-0x3f2bc3713c",
  "Language": "English",
  "Language code": "en",
  "Project version id": "55144000-0xxx-000x-0000-0x2346b3bms3",
  "Project version name": "1.0"
}

{
  "Knowledge base name": "My Knowledge Base",
  "Event": "Article deleted",
  "User": "John Doe",
  "User email": "johndoe@example.com",
  "Logged on (UTC)": "02/13/2026 10:57:16",
  "Article name": "Getting Started Guides",
  "Article id": "24a4e58a-9d64-453c-8f00-4159eb94b82e",
  "Language": "English",
  "Project version id": "0644e0fe-2ae1-4d16-a993-98b81524d5c4",
  "Language code": "en",
  "Slugs": [
    { "language": "en", "slug": "getting-started" },
    { "language": "fr", "slug": "demarrer" },
    { "language": "de", "slug": "erste-schritte" }
  ]
}

{
  "Knowledge base name": "Document360 2.0",
  "Event": "Extension token deleted",
  "User": "Matt Sterling",
  "User email": "matt.sterling@document360.co",
  "Logged on (UTC)": "09/12/2025 06:47:10",
  "Extension": "MAKE"
}