Webhook-gebeurtenissen en wat ze bevatten

Elk Notiondesk webhook-evenement dat u kunt selecteren, het aanvraagformaat dat uw server ontvangt en welke gegevens elk evenement bevat.

8 min lezen

Elke webhookaanvraag vertelt je wat er in je werkruimte of een van de helpcentra is gebeurd. Dit artikel geeft een overzicht van alle gebeurtenissen die je voor een eindpunt kunt selecteren, hoe elke aanvraag eruitziet en wat deze bevat.

Snelkoppeling: Selecteer gebeurtenissen in Instellingen > Ontwikkelaars > Webhooks , onder Gebeurtenissen op een eindpunt. Elk verzoek is een JSON-object met , , , , en .POSTideventversionoccurred_atsite_iddata

Evenementen waaruit je kunt kiezen

Het dashboard groepeert gebeurtenissen op dezelfde manier als de onderstaande tabellen. De eerste kolom is de naam die u in de gebeurteniskiezer ziet. De tweede kolom is de gebeurtenisnaam die uw server ontvangt in event.

Contacten

In het dashboard Evenement Verzonden wanneer
Contactbericht ontvangen Een bezoeker stuurt uw contactformulier.contact_message.created

Inhoud

In het dashboard Evenement Verzonden wanneer
Artikel aangemaakt Er wordt een nieuw artikel of een artikel in een andere taal toegevoegd.article.created
Artikel bijgewerkt De inhoud van een artikel verandert tijdens een synchronisatie.article.updated
Artikel gepubliceerd De taal van een artikel wordt gepubliceerdarticle.published
Artikel niet gepubliceerd De gepubliceerde taal van een artikel wordt niet langer gepubliceerd.article.unpublished
Artikel verwijderd Een artikel is verwijderd.article.deleted
Artikel vertaald Een artikel wordt automatisch in een nieuwe taal vertaald.article.translated
Reactie toegevoegd Een lezer reageert op een artikel.article.reaction.added
De reactie veranderde. Een lezer verandert zijn reactie.article.reaction.changed
Reactie verwijderd Een lezer verwijdert zijn reactiearticle.reaction.removed
Feedback op het artikel ontvangen Een lezer stuurt schriftelijke feedback op een artikel.article.feedback.created
Categorie aangemaakt Er wordt een nieuwe categorie of een nieuwe taal voor een categorie toegevoegd.category.created
Categorie bijgewerkt De inhoud van een categorie verandert tijdens een synchronisatie.category.updated
Categorie verwijderd Een categorie is verwijderd.category.deleted
Wijzigingslogboekvermelding gepubliceerd Een artikel in een changelog-categorie is gepubliceerd.changelog.published
Synchronisatie voltooid De synchronisatie met Notion is voltooid.sync.completed
Synchronisatie mislukt Een synchronisatie met Notion mislukt.sync.failed

article.updated en category.updated worden niet verzonden wanneer alleen de status of andere eigenschappen veranderen. Categoriegebeurtenissen worden één keer per taal verzonden.

Het aantal reacties en feedback op artikelen is beperkt tot 120 gebeurtenissen per minuut per helpcentrum. Gebeurtenissen boven deze limiet worden niet verzonden; raadpleeg daarom de analyses van uw helpcentrum voor het totaal aantal gebeurtenissen.

Instellingen van het helpcentrum

In het dashboard Evenement Verzonden wanneer
Instellingen van het helpcentrum opgeslagen Een instelling voor het helpcentrum wordt opgeslagen.site.updated
Aangepaste code opgeslagen Aangepaste CSS of JavaScript wordt opgeslagensite.custom_code.updated
Aangepast domein geverifieerd Uw aangepaste domein wordt nu gebruikt om het helpcentrum te hosten.site.domain.verified
Controle van aangepast domein mislukt Uw aangepaste domein kon niet worden bereikt.site.domain.verification_failed
Integratie bijgewerkt Een integratie wordt ingesteld, gewijzigd, in- of uitgeschakeld.integration.updated
Notie verbonden Notion is verbondennotion.connected
Het idee is losgekoppeld. Notion is niet verbonden.notion.disconnected
Toegang tot Notion verloren Notiondesk kan uw Notion-pagina's niet langer lezen.notion.access_lost
AI-chatbot bijgewerkt De instellingen van de chatbot worden gewijzigd, of de chatbot wordt in- of uitgeschakeld.chatbot.updated
Chatbot-begeleiding toegevoegd Er wordt een handleiding toegevoegd aan de chatbot.chatbot.guidance.created
Handleiding voor chatbots bijgewerkt Een richtlijn wijzigtchatbot.guidance.updated
Chatbot-begeleiding verwijderd Een richtlijn is verwijderd.chatbot.guidance.deleted
Omleiding toegevoegd Er wordt een omleiding toegevoegd.redirect.created
Omleiding bijgewerkt Een omleiding verandertredirect.updated
Omleiding verwijderd Een omleiding is verwijderd.redirect.deleted

Aangepaste domeinen worden regelmatig gecontroleerd, waardoor domeingebeurtenissen enkele minuten na de wijziging kunnen binnenkomen.

Werkruimte

Werkruimtegebeurtenissen zijn niet gekoppeld aan één helpcentrum, dus hun site_id is null.

In het dashboard Evenement Verzonden wanneer
Werkruimte hernoemd De werkruimte is hernoemd.workspace.updated
Aanmeldingsverzoek ontvangen Iemand vraagt ​​om deel te nemen aan de werkruimte.workspace.join_request.created
Aanvraag tot deelname goedgekeurd Een aanvraag om lid te worden is goedgekeurd.workspace.join_request.approved
Verzoek om lid te worden afgewezen Een verzoek om lid te worden is afgewezen.workspace.join_request.declined
Teamgenoot uitgenodigd Een teamgenoot wordt uitgenodigdteam_member.invited
Teamgenoot sloot zich aan Een uitgenodigde teamgenoot accepteertteam_member.joined
De rol van teamgenoot is gewijzigd. De rol van een teamgenoot verandert.team_member.role_changed
Teamgenoot in- of uitgeschakeld Een teamgenoot wordt aan- of uitgeschakeld.team_member.status_changed
Teamgenoot verwijderd Een teamgenoot wordt verwijderd.team_member.removed
Teamgenoot heeft zich aangemeld Een teamlid meldt zich aan. De berichten worden alleen verzonden naar de werkruimte die hij of zij standaard opent.team_member.logged_in
API-sleutel aangemaakt Er wordt een API-sleutel aangemaakt.api_key.created
API-sleutel geroteerd Een API-sleutel wordt regelmatig vernieuwd.api_key.rotated
API-sleutel ingetrokken Een API-sleutel is ingetrokken.api_key.revoked
Helpcentrum aangemaakt Er wordt een helpcentrum opgericht.site.created
Helpcentrum verwijderd Een helpcentrum wordt verwijderd, terwijl de werkruimte nog steeds een ander online helpcentrum heeft.site.deleted

Testevenement

In het dashboard Evenement Verzonden wanneer
Testevenement Je klikt op 'Testgebeurtenis verzenden' op een eindpunt.ping

Je kunt ping niet selecteren in de lijst met gebeurtenissen. Het gaat alleen naar het eindpunt dat je test, de site_id daarvan is null, en het wordt eenmalig verzonden, zonder herhaalpogingen.

Wat elk verzoek inhoudt

Notiondesk verzendt een POST verzoek met een JSON-body:

{
  "id": "019a8f2e-4b1c-7d3e-9f40-5a6b7c8d9e01",
  "event": "article.published",
  "version": "2026-11-06",
  "occurred_at": "2026-11-17T14:32:05+00:00",
  "site_id": "019a8f2e-0b7d-7c3a-9e15-4f2a6b8c0d11",
  "data": {
    "article": {
      "id": "1763391842",
      "locale": "en",
      "title": "Reset your password",
      "slug": "reset-your-password",
      "url": "https://help.acme-support.com/en/articles/reset-your-password",
      "status": "published"
    }
  }
}
Veld Wat het is
idDe ID van de gebeurtenis. Deze blijft hetzelfde wanneer een verzoek opnieuw wordt geprobeerd, dus gebruik hem om duplicaten te herkennen.
eventDe naam van het evenement, bijvoorbeeld article.published
versionDe versie van dit verzoekformaat
occurred_atWanneer de gebeurtenis plaatsvond, als een ISO 8601-datum en -tijdstip.
site_idHet helpcentrum waar de gebeurtenis vandaan komt, of null voor werkruimtegebeurtenissen en de testgebeurtenis
dataWaar het evenement over gaat. Zie Wat de gegevens bevatten .

Elk verzoek bevat ook de volgende headers:

Koptekst Waarde
Content-Typeapplication/json
User-AgentND-Webhooks/1.0
X-ND-EventDe naam van het evenement is hetzelfde als event in de body.
X-ND-DeliveryDe ID van deze levering aan dit eindpunt. Deze blijft hetzelfde bij elke nieuwe poging.
X-ND-SignatureDe handtekening die bewijst dat het verzoek afkomstig is van Notiondesk. Het controleren hiervan wordt beschreven in 'Verifiëren of een webhook afkomstig is van Notiondesk'.

Welke gegevens bevatten

data bevat een of meer objecten, afhankelijk van de gebeurtenis:

Evenement Wat zit er in data?
contact_message.created__GERESERVEERD_218__: __GERESERVEERD_217__, __GERESERVEERD_216__, __GERESERVEERD_215__, __GERESERVEERD_214__, __GERESERVEERD_213__, __GERESERVEERD_212__
__GERESERVEERD_211__, __GERESERVEERD_210__, __GERESERVEERD_209__, __GERESERVEERD_208__, __GERESERVEERD_207__ __GERESERVEERD_206__: __GERESERVEERD_205__, __GERESERVEERD_204__, __GERESERVEERD_203__, __GERESERVEERD_202__, __GERESERVEERD_201__, __GERESERVEERD_200__
article.translatedarticle in de nieuwe taal, en source_locale
article.deleted__GEVESTIGD_195__: __GEVESTIGD_194__
__GERESERVEERD_193__, __GERESERVEERD_192__, __GERESERVEERD_191__ __GERESERVEERD_190__: __GERESERVEERD_189__, en __GERESERVEERD_188__: __GERESERVEERD_187__
article.feedback.created__GERESERVEERD_185__: __GERESERVEERD_184__, en __GERESERVEERD_183__: __GERESERVEERD_182__, __GERESERVEERD_181__, __GERESERVEERD_180__, __GERESERVEERD_179__, __GERESERVEERD_178__
__GEVANGEN_177__, __GEVANGEN_176__ __GERESERVEERD_175__: __GERESERVEERD_174__, __GERESERVEERD_173__, __GERESERVEERD_172__, __GERESERVEERD_171__
category.deleted__GEVANGEN_169__: __GEVANGEN_168__
sync.completed__GERESERVEERD_166__: __GERESERVEERD_165__, __GERESERVEERD_164__, __GERESERVEERD_163__, __GERESERVEERD_162__
sync.failed__GERESERVEERD_160__: __GERESERVEERD_159__, __GERESERVEERD_158__
__GEVANGEN_157__, __GEVANGEN_156__ __GERESERVEERD_155__: __GERESERVEERD_154__, __GERESERVEERD_153__, __GERESERVEERD_152__
site.deleted__GERESERVEERD_150__: __GERESERVEERD_149__
site.custom_code.updated__GERESERVEERD_147__: __GERESERVEERD_146__ (__GERESERVEERD_145__ of __GERESERVEERD_144__)
__GEVANGEN_143__, __GEVANGEN_142__ __GEVANGEN_141__: __GEVANGEN_140__
integration.updated__GERESERVEERD_138__: __GERESERVEERD_137__, __GERESERVEERD_136__
__GERESERVEERD_135__, __GERESERVEERD_134__, __GERESERVEERD_133__ Een leeg object, {}
chatbot.updated__GERESERVEERD_130__: __GERESERVEERD_129__, __GERESERVEERD_128__, __GERESERVEERD_127__
__GEVANGEN_126__, __GEVANGEN_125__ __GERESERVEERD_124__: __GERESERVEERD_123__, __GERESERVEERD_122__, __GERESERVEERD_121__, __GERESERVEERD_120__
chatbot.guidance.deleted__GERESERVEERD_118__: __GERESERVEERD_117__
__GEVANGEN_116__, __GEVANGEN_115__ __GERESERVEERD_114__: __GERESERVEERD_113__, __GERESERVEERD_112__, __GERESERVEERD_111__, __GERESERVEERD_110__, __GERESERVEERD_109__
redirect.deleted__GEVANGEN_107__: __GEVANGEN_106__
workspace.updated__GERESERVEERD_104__: __GERESERVEERD_103__, __GERESERVEERD_102__
__GERESERVEERD_101__, __GERESERVEERD_100__, __GERESERVEERD_99__ __GERESERVEERD_98__: __GERESERVEERD_97__, __GERESERVEERD_96__, __GERESERVEERD_95__
__GERESERVEERD_94__, __GERESERVEERD_93__, __GERESERVEERD_92__, __GERESERVEERD_91__ __GERESERVEERD_90__: __GERESERVEERD_89__, __GERESERVEERD_88__, __GERESERVEERD_87__, __GERESERVEERD_86__
team_member.removed__GERESERVEERD_84__: __GERESERVEERD_83__
team_member.logged_in__GERESERVEERD_81__: __GERESERVEERD_80__, __GERESERVEERD_79__, __GERESERVEERD_78__
__GERESERVEERD_77__, __GERESERVEERD_76__ __GERESERVEERD_75__: __GERESERVEERD_74__, __GERESERVEERD_73__, __GERESERVEERD_72__, __GERESERVEERD_71__, __GERESERVEERD_70__
api_key.rotatedapi_key voor de nieuwe sleutel, en previous_api_key: id
pingmessage

data bevat nooit bijlagen, geheimen, aangepaste code of factuurgegevens.

Voorbeeldgegevens per gebeurtenisfamilie

Deze voorbeelden tonen alleen data. De rest van het verzoek is voor elk evenement hetzelfde.

Contactformulier, __GEVESTIGD_61__:

Artikelen, __GERESERVEERD_60__:

status geeft de status van die taal aan: draft, review, published, archived of translation source. url kan null zijn als het helpcentrum nog geen adres heeft.

Reacties en feedback, __GESERVEERD_51__:

Voor reacties wordt reaction.type vervangen door smiley, neutral_face of disappointed. Helpcentra die duimknoppen weergeven, sturen smiley voor Ja en disappointed voor Nee. Bij feedback wordt article.id vervangen door null wanneer het artikel niet meer bestaat.

Categorieën, __GERESERVEERD_42__:

Synchronisaties, sync.completed en sync.failed:

trigger is manual, api of automatic. reason is pages_failed wanneer sommige pagina's niet konden worden gesynchroniseerd, of failed wanneer de synchronisatie is gestopt.

Instellingen van het helpcentrum, __GESERVEERD_32__:

Werkplek en teamgenoten, __GEVESTIGD_31__:

role is admin, editor, billing_manager of viewer. status is enabled, disabled of pending_invite.

API-sleutels, api_key.rotated:

Testgebeurtenis, ping:

Verwerk gebeurtenissen in uw ontvanger.

{
  "contact_message": {
    "id": "019a8f31-5c2e-7a41-8b9d-2e6f0a7c4b23",
    "name": "Jamie Rivera",
    "email": "[email protected]",
    "subject": "Invoice question",
    "message": "Hi, where can I download my latest invoice?",
    "locale": "en"
  }
}
{
  "article": {
    "id": "1763391842",
    "locale": "fr",
    "title": "Réinitialiser votre mot de passe",
    "slug": "reinitialiser-votre-mot-de-passe",
    "url": "https://help.acme-support.com/fr/articles/reinitialiser-votre-mot-de-passe",
    "status": "published"
  },
  "source_locale": "en"
}
{
  "article": { "id": "1763391842" },
  "feedback": {
    "id": "019a8f33-8d4f-7b52-a1c3-6e9b2d0f7a35",
    "name": "Sam Lee",
    "email": "[email protected]",
    "message": "The screenshots don't match the new settings page.",
    "locale": "en"
  }
}
{
  "category": {
    "id": "1763392017",
    "locale": "en",
    "name": "Billing",
    "slug": "billing"
  }
}
{
  "sync": {
    "trigger": "automatic",
    "duration_seconds": 42,
    "pages_synced": 120,
    "pages_updated": 3
  }
}
{
  "sync": {
    "reason": "pages_failed",
    "pages_processed": 118
  }
}
{
  "redirect": {
    "id": "019a8f35-2a6c-7d63-b4e8-0c1f5a9d3e47",
    "source_path": "/old-help/reset-password",
    "type": "article",
    "article_id": "1763391842",
    "category_id": null
  }
}
{
  "team_member": {
    "id": "019a8f37-7e1b-7f74-8c2d-9a4e6b1f0c59",
    "email": "[email protected]",
    "role": "editor",
    "status": "enabled"
  }
}
{
  "api_key": {
    "id": "019a8f39-3f8a-7185-9d6e-1b7c4e2a8d6b",
    "prefix": "nd_wsk_4fa9c2e17b30",
    "label": "CRM sync",
    "scopes": ["read"],
    "expires_at": null
  },
  "previous_api_key": { "id": "0199c4d2-6b3e-7296-ae0f-5d8a1c7e9b7d" }
}
{
  "message": "Test event from Notiondesk."
}
  • Reageer snel. Stuur eerst de statuscode 2xx terug en voer daarna de werkzaamheden uit. Notiondesk wacht 5 seconden totdat uw server begint te reageren en in totaal 10 seconden, en leest alleen de statuscode.
  • Verwacht duplicaten. Dezelfde gebeurtenis kan meer dan eens voorkomen, bijvoorbeeld na een herhaalpoging. Sla alle id die je al hebt verwerkt over.
  • Vertrouw niet op de volgorde. Gebeurtenissen kunnen in een willekeurige volgorde plaatsvinden. Gebruik occurred_at wanneer de volgorde wel belangrijk is.
  • Lees de gegevens als de meest recente status. data wordt gelezen wanneer de gebeurtenis wordt verzonden, zodat twee snelle wijzigingen aan een artikel beide de latere versie kunnen bevatten. Als het artikel dan niet meer bestaat, wordt de gebeurtenis overgeslagen.

Veelgestelde vragen

Krijg ik de volledige inhoud van het artikel te zien?

Nee. Artikelgebeurtenissen bevatten de titel, slug, URL en status. Gebruik de Notiondesk API als je meer informatie nodig hebt.

Hoe kan ik zien van welk helpcentrum een ​​evenement afkomstig is?

Lees site_id. Dit is de ID van het helpcentrum, of null voor werkruimtegebeurtenissen en de testgebeurtenis.

Waarom heb ik niet voor elke reactie een evenement gekregen?

Het aantal reacties en feedback op artikelen is beperkt tot 120 gebeurtenissen per minuut per helpcentrum. Gebeurtenissen boven deze limiet worden niet verzonden. Raadpleeg de analysegegevens van uw helpcentrum voor de totalen.

Kan ik hetzelfde evenement twee keer ontvangen?

Ja, bijvoorbeeld na een nieuwe poging. De id blijft hetzelfde, dus negeer een item dat je al hebt verwerkt.

Wat betekent 'versie'?

Het geeft aan welk aanvraagformaat is gebruikt. Aanvragen gebruiken momenteel 2026-11-06.

Gerelateerde artikelen

Was deze pagina nuttig?

Still need help? Ask us