Jede Webhook-Anfrage informiert Sie über Ereignisse in Ihrem Workspace oder einem seiner Hilfezentren. Dieser Artikel listet alle Ereignisse auf, die Sie für einen Endpunkt auswählen können, beschreibt das Aussehen jeder Anfrage und deren Inhalt.
POSTideventversionoccurred_atsite_iddataVeranstaltungen, die Sie auswählen können
Das Dashboard gruppiert Ereignisse analog zu den unten stehenden Tabellen. Die erste Spalte enthält den Namen, der in der Ereignisauswahl angezeigt wird. Die zweite Spalte enthält den Ereignisnamen, den Ihr Server in event empfängt.
Kontakte
| Im Dashboard | Ereignis | Gesendet, wenn |
|---|---|---|
| Kontaktnachricht empfangen | Ein Besucher sendet Ihr Kontaktformular ab | contact_message.created |
Inhalt
| Im Dashboard | Ereignis | Gesendet, wenn |
|---|---|---|
| Artikel erstellt | Ein neuer Artikel oder eine neue Sprachversion eines Artikels wird hinzugefügt. | article.created |
| Artikel aktualisiert | Der Inhalt eines Artikels ändert sich während einer Synchronisierung. | article.updated |
| Artikel veröffentlicht | Die Sprache eines Artikels wird veröffentlicht | article.published |
| Artikel unveröffentlicht | Eine veröffentlichte Version eines Artikels wird nicht mehr veröffentlicht. | article.unpublished |
| Artikel gelöscht | Ein Artikel wurde gelöscht | article.deleted |
| Artikel übersetzt | Ein Artikel wird automatisch in eine neue Sprache übersetzt. | article.translated |
| Reaktion hinzugefügt | Ein Leser reagiert auf einen Artikel | article.reaction.added |
| Reaktion geändert | Ein Leser ändert seine Reaktion | article.reaction.changed |
| Reaktion entfernt | Ein Leser entfernt seine Reaktion | article.reaction.removed |
| Feedback zum Artikel erhalten | Ein Leser sendet schriftliches Feedback zu einem Artikel | article.feedback.created |
| Kategorie erstellt | Eine neue Kategorie oder eine neue Sprache einer Kategorie wird hinzugefügt. | category.created |
| Kategorie aktualisiert | Der Inhalt einer Kategorie ändert sich während einer Synchronisierung. | category.updated |
| Kategorie gelöscht | Eine Kategorie wird gelöscht | category.deleted |
| Änderungsprotokolleintrag veröffentlicht | Ein Artikel in der Kategorie „Änderungsprotokoll“ wird veröffentlicht | changelog.published |
| Synchronisierung abgeschlossen | Die Synchronisierung mit Notion wird abgeschlossen | sync.completed |
| Synchronisierung fehlgeschlagen | Die Synchronisierung mit Notion schlägt fehl. | sync.failed |
Die Ereignisse article.updated und category.updated werden nicht gesendet, wenn sich nur der Status oder andere Eigenschaften ändern. Kategorieereignisse werden einmal pro Sprache gesendet.
Reaktionen und Artikel-Feedback sind auf 120 Ereignisse pro Minute und Hilfezentrum begrenzt. Ereignisse, die dieses Limit überschreiten, werden nicht gesendet. Die Gesamtzahlen finden Sie in den Analysetools Ihres Hilfezentrums.
Einstellungen im Hilfezentrum
| Im Dashboard | Ereignis | Gesendet, wenn |
|---|---|---|
| Einstellungen des Hilfezentrums gespeichert | Eine Hilfecenter-Einstellung wird gespeichert | site.updated |
| Benutzerdefinierter Code gespeichert | Benutzerdefiniertes CSS oder JavaScript wird gespeichert | site.custom_code.updated |
| Benutzerdefinierte Domain verifiziert | Ihre benutzerdefinierte Domain dient nun dem Hilfezentrum. | site.domain.verified |
| Überprüfung der benutzerdefinierten Domäne fehlgeschlagen | Ihre benutzerdefinierte Domain konnte nicht erreicht werden. | site.domain.verification_failed |
| Integration aktualisiert | Eine Integration wird eingerichtet, geändert, aktiviert oder deaktiviert. | integration.updated |
| Notion verbunden | Notion ist verbunden | notion.connected |
| Notion getrennt | Notion ist nicht verbunden. | notion.disconnected |
| Notion-Zugriff verloren | Notiondesk kann Ihre Notion-Seiten nicht mehr lesen. | notion.access_lost |
| KI-Chatbot aktualisiert | Die Einstellungen des Chatbots ändern sich, oder er wird ein- oder ausgeschaltet. | chatbot.updated |
| Chatbot-Anleitung hinzugefügt | Dem Chatbot wurde eine Anleitung hinzugefügt. | chatbot.guidance.created |
| Chatbot-Leitfaden aktualisiert | Eine Leitlinie ändert sich | chatbot.guidance.updated |
| Chatbot-Anleitung gelöscht | Eine Richtlinie wird gelöscht | chatbot.guidance.deleted |
| Weiterleitung hinzugefügt | Eine Weiterleitung wird hinzugefügt | redirect.created |
| Weiterleitung aktualisiert | Eine Weiterleitung ändert | redirect.updated |
| Weiterleitung gelöscht | Eine Weiterleitung wird gelöscht | redirect.deleted |
Benutzerdefinierte Domains werden regelmäßig überprüft, daher können Domain-Ereignisse einige Minuten nach der Änderung eintreffen.
Arbeitsplatz
Workspace-Ereignisse sind nicht an ein bestimmtes Hilfezentrum gebunden, daher ist ihre site_id die null.
| Im Dashboard | Ereignis | Gesendet, wenn |
|---|---|---|
| Arbeitsbereich umbenannt | Der Arbeitsbereich wurde umbenannt | workspace.updated |
| Beitrittsanfrage erhalten | Jemand bittet darum, dem Arbeitsbereich beitreten zu können. | workspace.join_request.created |
| Beitrittsanfrage genehmigt | Ein Beitrittsantrag wurde genehmigt | workspace.join_request.approved |
| Beitrittsanfrage abgelehnt | Die Beitrittsanfrage wurde abgelehnt. | workspace.join_request.declined |
| Teamkollege eingeladen | Ein Teamkollege wird eingeladen | team_member.invited |
| Teamkollege schloss sich an | Ein eingeladener Teamkollege nimmt an | team_member.joined |
| Die Rolle des Teammitglieds hat sich geändert | Die Rolle eines Teammitglieds ändert sich | team_member.role_changed |
| Teammitglied ein- oder ausgeschaltet | Ein Teammitglied ist ein- oder ausgeschaltet. | team_member.status_changed |
| Teammitglied entfernt | Ein Teammitglied wird entfernt | team_member.removed |
| Teamkollege hat sich angemeldet | Ein Teammitglied meldet sich an. Die Nachricht wird standardmäßig nur an den von ihm geöffneten Arbeitsbereich gesendet. | team_member.logged_in |
| API-Schlüssel erstellt | Ein API-Schlüssel wird erstellt | api_key.created |
| API-Schlüssel rotiert | Ein API-Schlüssel wird rotiert | api_key.rotated |
| API-Schlüssel widerrufen | Ein API-Schlüssel wurde widerrufen | api_key.revoked |
| Hilfezentrum erstellt | Es wird ein Hilfezentrum erstellt | site.created |
| Hilfezentrum gelöscht | Ein Hilfecenter wird gelöscht, während der Arbeitsbereich noch ein anderes Online-Hilfecenter enthält. | site.deleted |
Testereignis
| Im Dashboard | Ereignis | Gesendet, wenn |
|---|---|---|
| Testereignis | Sie klicken auf „Testereignis senden“ für einen Endpunkt | ping |
Sie können ping nicht in der Ereignisliste auswählen. Es wird nur an den von Ihnen getesteten Endpunkt gesendet, dessen site_id ist null, und es wird einmalig ohne Wiederholungsversuche gesendet.
Was jede Anfrage enthält
Notiondesk sendet eine POST-Anfrage mit einem 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"
}
}
}| Feld | Was es ist |
|---|---|
id | Die Ereignis-ID. Sie bleibt bei wiederholten Anfragen gleich; verwenden Sie sie daher, um Duplikate zu erkennen. |
event | Der Ereignisname, zum Beispiel article.published |
version | Die Version dieses Anfrageformats |
occurred_at | Zeitpunkt des Ereignisses, als Datum und Uhrzeit gemäß ISO 8601 |
site_id | Das Hilfecenter, aus dem das Ereignis stammt, oder null für Arbeitsbereichsereignisse und das Testereignis |
data | Worum es bei der Veranstaltung geht. Siehe: Welche Daten enthalten |
Jede Anfrage enthält außerdem folgende Header:
| Kopfzeile | Wert |
|---|---|
Content-Type | application/json |
User-Agent | ND-Webhooks/1.0 |
X-ND-Event | Der Ereignisname, derselbe wie event im Nachrichtentext. |
X-ND-Delivery | Die ID dieser Zustellung an diesen Endpunkt. Sie bleibt bei Wiederholungsversuchen gleich. |
X-ND-Signature | Die Signatur, die belegt, dass die Anfrage von Notiondesk stammt, wird im Abschnitt „Überprüfen, ob ein Webhook von Notiondesk stammt“ beschrieben. |
Welche Daten enthalten
data enthält je nach Ereignis ein oder mehrere Objekte:
| Ereignis | Was ist in data enthalten? |
|---|---|
contact_message.created | contact_message: id, name, email, subject, message, locale |
article.created, article.updated, article.published, article.unpublished, changelog.published | article: id, locale, title, slug, url, status |
article.translated | article in der neuen Sprache und source_locale |
article.deleted | article: id |
article.reaction.added, article.reaction.changed, article.reaction.removed | article: id, und reaction: type |
article.feedback.created | article: id, und feedback: id, name, email, message, locale |
category.created, category.updated | category: id, locale, name, slug |
category.deleted | category: id |
sync.completed | sync: trigger, duration_seconds, pages_synced, pages_updated |
sync.failed | sync: reason, pages_processed |
site.updated, site.created | site: id, name, url |
site.deleted | site: id |
site.custom_code.updated | custom_code: type (css oder js) |
site.domain.verified, site.domain.verification_failed | domain: name |
integration.updated | integration: type, enabled |
notion.connected, notion.disconnected, notion.access_lost | Ein leeres Objekt, {} |
chatbot.updated | chatbot: id, name, enabled |
chatbot.guidance.created, chatbot.guidance.updated | guidance: id, type, title, enabled |
chatbot.guidance.deleted | guidance: id |
redirect.created, redirect.updated | redirect: id, source_path, type, article_id, category_id |
redirect.deleted | redirect: id |
workspace.updated | workspace: id, name |
workspace.join_request.created, .approved, .declined | join_request: id, email, status |
team_member.invited, .joined, .role_changed, .status_changed | team_member: id, email, role, status |
team_member.removed | team_member: id |
team_member.logged_in | user: id, email, name |
api_key.created, api_key.revoked | api_key: id, prefix, label, scopes, expires_at |
api_key.rotated | api_key für den neuen Schlüssel und previous_api_key: id |
ping | message |
data enthält niemals Anhänge, Geheimnisse, benutzerdefinierten Code oder Abrechnungsdetails.
Beispieldaten nach Ereignisfamilie
Diese Beispiele zeigen nur data. Der Rest der Anfrage ist für jedes Ereignis gleich.
Kontaktformular, contact_message.created:
Artikel, article.translated:
status gibt den Status der jeweiligen Sprache an: draft, review, published, archived oder translation source. url kann null sein, wenn das Hilfezentrum noch keine Adresse hat.
Reaktionen und Feedback, article.feedback.created:
Bei Reaktionen entspricht reaction.type smiley, neutral_face oder disappointed. Hilfezentren mit Daumen-Emojis senden smiley für „Ja“ und disappointed für „Nein“. Bei Feedback entspricht article.id null, wenn der Artikel nicht mehr existiert.
Kategorien, category.created:
Syncs, sync.completed und sync.failed:
trigger ist manual, api oder automatic. reason ist pages_failed, wenn einige Seiten nicht synchronisiert werden konnten, oder failed, wenn die Synchronisierung abgebrochen wurde.
Hilfecenter-Einstellungen, redirect.created:
Arbeitsbereich und Teammitglieder, team_member.role_changed:
role ist admin, editor, billing_manager oder viewer. status ist enabled, disabled oder pending_invite.
API-Schlüssel, api_key.rotated:
Testereignis, ping:
Ereignisse im Empfänger verarbeiten
{
"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."
}- Reagiere schnell. Sende zuerst den Statuscode
2xxzurück und führe dann die Verarbeitung durch. Notiondesk wartet 5 Sekunden, bis dein Server antwortet, insgesamt 10 Sekunden, und liest dabei nur den Statuscode.
- Rechnen Sie mit Duplikaten. Dasselbe Ereignis kann mehrfach auftreten, beispielsweise nach einem Wiederholungsversuch. Überspringen Sie alle bereits verarbeiteten
id-Ereignisse.
- Verlassen Sie sich nicht auf die Reihenfolge. Ereignisse können in beliebiger Reihenfolge eintreffen. Verwenden Sie
occurred_at, wenn die Reihenfolge wichtig ist.
- Die Daten werden als aktuellster Stand gelesen.
datawird beim Senden des Ereignisses gelesen, sodass zwei schnelle Änderungen an einem Artikel beide die neuere Version enthalten können. Wenn der Artikel bis dahin nicht mehr vorhanden ist, wird das Ereignis übersprungen.
Häufig gestellte Fragen
Erhalte ich den vollständigen Artikelinhalt?
Nein. Artikelereignisse enthalten Titel, Slug, URL und Status. Verwenden Sie die Notiondesk API, falls Sie weitere Informationen benötigen.
Wie kann ich feststellen, von welchem Hilfezentrum eine Veranstaltung stammt?
Lesen Sie site_id. Dies ist die ID des Hilfecenters, oder null für Arbeitsbereichsereignisse und das Testereignis.
Warum wurde nicht für jede Reaktion ein Ereignis ausgelöst?
Reaktionen und Artikel-Feedback sind auf 120 Ereignisse pro Minute und Hilfezentrum begrenzt. Ereignisse, die dieses Limit überschreiten, werden nicht gesendet. Die Gesamtzahlen finden Sie in den Analysetools Ihres Hilfezentrums.
Kann ich dasselbe Ereignis zweimal erhalten?
Ja, beispielsweise nach einem erneuten Versuch. Die id bleibt unverändert, daher können Sie bereits verarbeitete Versuche ignorieren.
Was bedeutet Version?
Es zeigt an, welches Anfrageformat verwendet wurde. Anfragen verwenden derzeit 2026-11-06.