Documentation Index

Fetch the complete documentation index at: https://docs.document360.com/llms.txt

Use this file to discover all available pages before exploring further.

Disclaimer: Dit artikel is gegenereerd door automatische vertaling.

Webhook meldingskanaal

Prev Next

Een webhook-meldingskanaal in Document360 is een geautomatiseerde methode om realtime gebeurtenisgegevens van je kennisbank naar een externe applicatie te sturen telkens wanneer een bepaalde actie plaatsvindt. Webhooks elimineren de noodzaak voor handmatige monitoring door gestructureerde JSON-payloads direct naar een URL naar keuze te sturen — zoals een Slack-kanaal, een aangepaste integratie of een automatiseringsplatform. Je kunt meerdere webhook-kanalen instellen en elk kanaal koppelen aan specifieke kennisbankgebeurtenissen via de Notification mapping-instellingen .


Wanneer je webhook-meldingskanalen gebruikt

Gebruik webhook-meldingen wanneer je wilt automatiseren hoe je team of externe systemen reageren op veranderingen in de kennisbank.

  • Teamwaarschuwingen: Informeer een support- of documentatieteam in Slack of Microsoft Teams zodra een artikel wordt gepubliceerd, bijgewerkt of verwijderd — zonder dat iemand het portaal handmatig hoeft te controleren.
  • Cache-ongeldigverklaring: Detecteer artikelverwijderingsgebeurtenissen (waaronder slugs voor alle talen) en verwijder automatisch de bijbehorende vermeldingen uit je contentcache.
  • Workflowautomatisering: Activeer downstreamprocessen in tools zoals Make of Zapier wanneer specifieke gebeurtenissen plaatsvinden, zoals een nieuw artikel dat wordt gepubliceerd of een extensietoken wordt verwijderd.
  • Audit en naleving: Stream kennisbankactiviteiten naar een loggdienst om een realtime auditspoor te behouden van wie wat heeft veranderd en wanneer.

Voordat je begint

  • Zorg dat de bestemmingswebhook-URL klaar is — dit is het eindpunt dat door de ontvangende applicatie wordt geleverd (bijvoorbeeld een Slack-inkomende webhook-URL, een Make scenario webhook, of je eigen server-eindpunt).
  • Als de ontvangende applicatie authenticatie vereist, verkrijg dan de autorisatiesleutel voordat je begint.

Hoe je een webhook-meldingskanaal opzet

  1. Navigeer naar Instellingen () > Kennisbankportaal in de linker navigatiebalk.

  2. Selecteer in het linker navigatiepaneel Meldingen.
    Het tabblad Meldingskanalen is standaard geselecteerd.

  3. Klik op Nieuw kanaal.

  4. Selecteer in het paneel Beschikbare kanalen Webhook en klik op Volgende.

    Notification channels in Document360, highlighting Webhook as an available option.

    Het configuratiepaneel Kanaal verschijnt.

  5. Voer in het veld Vriendelijke naam een unieke naam in voor dit webhook-kanaal.

  6. Selecteer in het dropdown Request-methode POST of PUT afhankelijk van wat de ontvangende applicatie verwacht.

  7. Voer in het Webhook URL-veld de bestemmings-URL in waar meldingen verzonden moeten worden.

  8. Kies in het dropdown 'Inhoud aanvragen ' het berichtformaat voor de payload.

  9. Als de ontvangende applicatie extra HTTP-headers nodig heeft, klik dan op Add new () onder Standaardheaders en voeg elke header toe als een sleutel-waarde-paar.

  10. Als authenticatie vereist is, voer dan de autorisatiesleutel in het bijbehorende veld.

  11. Klik op Opslaan.

Configuration settings for a Webhook channel including URL and authorization key.

Het webhook-kanaal wordt aangemaakt en vermeld onder Meldingskanalen. Om het te activeren, ga je naar het tabblad Meldingsmapping en wijs je het kanaal toe aan de gebeurtenissen die je wilt volgen.

OPMERKING

Voor details over ondersteunde HTTP-verzoekheaders en hun verwachte formaten, raadpleeg de MDN Request-headerreferentie.


Best practices

  • Gebruik beschrijvende vriendelijke namen die zowel de bestemming als de gebeurtenisscope identificeren — bijvoorbeeld, Slack-ArticlePublish of Make-AllEvents — zodat kanalen gemakkelijk te onderscheiden zijn bij het toewijzen van meldingen.
  • Beperk elk kanaal tot een gerichte set gebeurtenissen in plaats van alle gebeurtenissen via één webhook te routeren. Dit maakt het makkelijker om fouten te beheren en specifieke gebeurtenistypen onafhankelijk opnieuw te proberen.
  • Beveilig je endpoint met een autorisatiesleutel wanneer de ontvangende applicatie deze ondersteunt, om te voorkomen dat ongeautoriseerde payloads je systemen bereiken.
  • Gebruik het Slugs-veld in verwijdergebeurtenissen om direct de juiste cache-vermeldingen in alle talen te identificeren en te wissen wanneer een artikel wordt verwijderd, zodat verouderde inhoud wordt voorkomen.

FAQ

 
         

Welke informatie is opgenomen in een webhook-melding?

   
   
     

Wanneer een webhook wordt geactiveerd, stuurt Document360 een gestructureerde JSON-payload naar de geconfigureerde URL. De payload omvat het gebeurtenistype, de gebruiker die de actie heeft uitgevoerd, de UTC-tijdstempel en metadata over het betreffende artikel of project. De exacte velden verschillen per gebeurtenis — zie de voorbeelden van ladingen hieronder voor details.

   
 
 
 
         

Hoe ziet een voorbeeld van een webhook-payload eruit?

   
   
     

Hieronder staat een voorbeeldpayload voor het opgeslagen Event van de Artikelinstellingen :

{
  "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"
}

De payloadvelden zijn:

Veld Beschrijving
Naam kennisbank De naam van het kennisbasisproject.
Evenement De actie die de webhook heeft geactiveerd (bijvoorbeeld artikel gepubliceerd).
Gebruiker / Gebruiker e-mail Het teamlid dat de actie uitvoerde.
Ingelogd (UTC) Datum en tijd van de actie in UTC.
Artikelnaam / Artikel-id Details van het betreffende artikel.
Taal / Taalcode De taal van het artikel.
Projectversie-id Unieke identificatie van de kennisbasisversie die bij het artikel hoort.
Projectversienaam Weergavenaam van de kennisbankversie die aan het artikel is gekoppeld.

De velden voor de projectversie-id en de naam van de projectversie zijn nu standaard in alle artikelgerelateerde webhook-gebeurtenissen, waaronder: Artikelinstellingen opgeslagen, Artikelomleidingsregel toegevoegd, Artikelomleidingsregel bijgewerkt en Artikelomleidingsregel verwijderd. Dit stelt je in staat om betrouwbaar de bijbehorende versie voor elke artikelactie te identificeren zonder extra API-aanroepen.

   
 
 
 
         

Bevat de delete-event payload de artikelslug?

   
   
     

Ja. Wanneer een artikel wordt verwijderd, bevat de payload een Slugs-veld dat de slug van het verwijderde artikel teruggeeft in elke taal waarin het beschikbaar was. Hierdoor kun je direct de juiste cache-vermeldingen identificeren en verwijderen zodra de webhook wordt geactiveerd, zonder extra API-aanroepen te hoeven doen.

{
  "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" }
  ]
}
   
 
 
 
         

Verschillen payloadstructuren voor niet-artikelgebeurtenissen?

   
   
     

Ja. De ladingstructuur varieert afhankelijk van het type evenement. Het Gebeurtenisveld weerspiegelt altijd de triggeractie, en de overige velden zijn specifiek voor het betrokken object. Bijvoorbeeld, een extensie-tokenverwijderingsevent bevat een extensieveld , een widgetinstellingsgebeurtenis een widgetinstellingsnaamveld , en een Drive-mapgebeurtenis een mapnaamveld . Velden die niet op een bepaald evenement van toepassing zijn, worden weggelaten uit de payload.

{
  "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"
}