Wydarzenia webhook i ich zawartość

Każde zdarzenie webhooka Notiondesk, które możesz wybrać, format żądania odbierany przez serwer i dane zawarte w każdym zdarzeniu.

8 min czytania

Każde żądanie webhooka informuje o tym, co wydarzyło się w Twoim obszarze roboczym lub jednym z jego centrów pomocy. W tym artykule wymieniono wszystkie zdarzenia, które możesz wybrać dla punktu końcowego, jak wygląda każde żądanie i co zawiera.

Szybka ścieżka: Wybierz zdarzenia w Ustawieniach > Deweloperzy > Webhooki , w sekcji Zdarzenia w punkcie końcowym. Każde żądanie to plik JSON z , , , i .POSTideventversionoccurred_atsite_iddata

Wydarzenia, które możesz wybrać

Pulpit nawigacyjny grupuje zdarzenia w taki sam sposób, jak poniższe tabele. Pierwsza kolumna to nazwa wyświetlana w selektorze zdarzeń. Druga to nazwa zdarzenia, którą serwer otrzymuje w event.

Łączność

Na pulpicie nawigacyjnym Wydarzenie Wysłane kiedy
Otrzymano wiadomość kontaktową Odwiedzający wysyła Twój formularz kontaktowycontact_message.created

Treść

Na pulpicie nawigacyjnym Wydarzenie Wysłane kiedy
Artykuł utworzony Dodano nowy artykuł lub nowy język artykułuarticle.created
Artykuł zaktualizowany Treść artykułu ulega zmianie podczas synchronizacjiarticle.updated
Artykuł opublikowany Opublikowano artykuł w językuarticle.published
Artykuł nieopublikowany Opublikowany język artykułu nie jest już publikowanyarticle.unpublished
Artykuł usunięty Artykuł został usuniętyarticle.deleted
Artykuł przetłumaczony Artykuł jest automatycznie tłumaczony na nowy językarticle.translated
Dodano reakcję Czytelnik reaguje na artykułarticle.reaction.added
Reakcja zmieniona Czytelnik zmienia swoją reakcjęarticle.reaction.changed
Reakcja usunięta Czytelnik usuwa swoją reakcjęarticle.reaction.removed
Otrzymano opinię na temat artykułu Czytelnik wysyła pisemną opinię na temat artykułuarticle.feedback.created
Kategoria utworzona Dodano nową kategorię lub nowy język kategoriicategory.created
Kategoria zaktualizowana Zawartość kategorii zmienia się podczas synchronizacjicategory.updated
Kategoria usunięta Kategoria została usuniętacategory.deleted
Opublikowano wpis w dzienniku zmian Opublikowano artykuł w kategorii dziennika zmianchangelog.published
Synchronizacja zakończona Synchronizacja z Notion kończysync.completed
Synchronizacja nie powiodła się Synchronizacja z Notion nie powiodła sięsync.failed

article.updated i category.updated nie są wysyłane, gdy zmienia się tylko status lub inne właściwości. Zdarzenia kategorii są wysyłane raz dla każdego języka.

Liczba reakcji i opinii na temat artykułów jest ograniczona do 120 zdarzeń na minutę dla każdego centrum pomocy. Zdarzenia przekraczające limit nie są wysyłane, dlatego skorzystaj z analityki centrum pomocy, aby uzyskać łączną liczbę zdarzeń.

Ustawienia centrum pomocy

Na pulpicie nawigacyjnym Wydarzenie Wysłane kiedy
Ustawienia centrum pomocy zostały zapisane Ustawienia centrum pomocy zostały zapisanesite.updated
Zapisano kod niestandardowy Niestandardowy kod CSS lub JavaScript jest zapisywanysite.custom_code.updated
Zweryfikowano domenę niestandardową Twoja domena niestandardowa zaczyna obsługiwać centrum pomocysite.domain.verified
Nie można sprawdzić domeny niestandardowej Nie można nawiązać połączenia z Twoją domeną niestandardowąsite.domain.verification_failed
Zaktualizowano integrację Integracja jest konfigurowana, zmieniana, włączana lub wyłączanaintegration.updated
Pojęcie połączone Pojęcie jest połączonenotion.connected
Pojęcie odłączone Pojęcie jest odłączonenotion.disconnected
Utracono dostęp do pojęcia Notiondesk nie może już odczytać Twoich stron Notionnotion.access_lost
Zaktualizowano chatbota AI Ustawienia chatbota ulegają zmianie, jest on włączany lub wyłączanychatbot.updated
Dodano wskazówki dotyczące chatbota Do chatbota dodano wskazówkichatbot.guidance.created
Zaktualizowano wskazówki dotyczące chatbotów Zmiana wytycznychchatbot.guidance.updated
Usunięto wskazówki dotyczące chatbota Usunięto wskazówkęchatbot.guidance.deleted
Dodano przekierowanie Dodano przekierowanieredirect.created
Przekierowanie zaktualizowane Zmiana przekierowaniaredirect.updated
Przekierowanie usunięte Przekierowanie zostało usunięteredirect.deleted

Niestandardowe domeny są regularnie sprawdzane, więc zdarzenia dotyczące domeny mogą zostać zgłoszone już kilka minut po wprowadzeniu zmiany.

Przestrzeń robocza

Wydarzenia w obszarze roboczym nie są powiązane z jednym centrum pomocy, więc ich site_id jest null.

Na pulpicie nawigacyjnym Wydarzenie Wysłane kiedy
Zmieniono nazwę obszaru roboczego Obszar roboczy został przemianowanyworkspace.updated
Otrzymano prośbę o dołączenie Ktoś prosi o dołączenie do przestrzeni roboczejworkspace.join_request.created
Prośba o dołączenie zatwierdzona Prośba o dołączenie została zatwierdzonaworkspace.join_request.approved
Prośba o dołączenie odrzucona Prośba o dołączenie została odrzuconaworkspace.join_request.declined
Zaproszono kolegę z drużyny Zaproszono kolegę z drużynyteam_member.invited
Dołączył kolega z drużyny Zaproszony członek drużyny akceptujeteam_member.joined
Zmiana roli członka zespołu Zmiana roli członka drużynyteam_member.role_changed
Włączono lub wyłączono członka zespołu Członek drużyny jest włączany lub wyłączanyteam_member.status_changed
Usunięto kolegę z drużyny Członek drużyny został usuniętyteam_member.removed
Kolega z drużyny się zalogował Członek zespołu loguje się. Wysyłane jest tylko do otwartego przez niego obszaru roboczego.team_member.logged_in
Utworzono klucz API Utworzono klucz APIapi_key.created
Klucz API został obrócony Klucz API jest obracanyapi_key.rotated
Klucz API został odwołany Klucz API został odwołanyapi_key.revoked
Utworzono centrum pomocy Utworzono centrum pomocysite.created
Centrum pomocy zostało usunięte Centrum pomocy zostaje usunięte, podczas gdy w obszarze roboczym nadal znajduje się inne centrum pomocy onlinesite.deleted

Wydarzenie testowe

Na pulpicie nawigacyjnym Wydarzenie Wysłane kiedy
Wydarzenie testowe Klikasz Wyślij zdarzenie testowe w punkcie końcowymping

Nie można wybrać ping z listy zdarzeń. Trafia ono tylko do testowanego punktu końcowego, jego site_id to null i jest wysyłane jednorazowo, bez ponawiania.

Co zawiera każde żądanie

Notiondesk wysyła żądanie POST z treścią JSON:

{
  "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"
    }
  }
}
Pole Co to jest
idIdentyfikator zdarzenia. Pozostaje taki sam po ponownym wysłaniu żądania, więc użyj go, aby wykryć duplikaty.
eventNazwa wydarzenia, na przykład article.published
versionWersja tego formatu żądania
occurred_atKiedy zdarzenie miało miejsce, jako data i godzina ISO 8601
site_idCentrum pomocy, z którego pochodzi zdarzenie, lub null w przypadku zdarzeń w obszarze roboczym i zdarzenia testowego
dataRzeczy, których dotyczy wydarzenie. Zobacz, co zawierają dane

Każde żądanie zawiera również następujące nagłówki:

Chodnikowiec Wartość
Content-Typeapplication/json
User-AgentND-Webhooks/1.0
X-ND-EventNazwa wydarzenia, taka sama jak event w treści
X-ND-DeliveryIdentyfikator tego dostarczenia do tego punktu końcowego. Pozostaje taki sam po kolejnych próbach.
X-ND-SignaturePodpis potwierdzający, że żądanie pochodzi z Notiondesk. Weryfikacja została omówiona w sekcji „Weryfikacja, czy webhook pochodzi z Notiondesk”.

Jakie dane zawierają

data przechowuje jeden lub więcej obiektów, w zależności od zdarzenia:

Wydarzenie Co znajduje się w data
contact_message.createdcontact_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.translatedarticle w nowym języku i source_locale
article.deletedarticle: id
__ZAREZERWOWANE_193__, __ZAREZERWOWANE_192__, __ZAREZERWOWANE_191__ article: id i reaction: type
article.feedback.createdarticle: id oraz feedback: id, name, email, message, locale
__ZACHOWANE_177__, __ZACHOWANE_176__ category: id, locale, name, slug
category.deletedcategory: id
sync.completedsync: trigger, duration_seconds, pages_synced, pages_updated
sync.failedsync: reason, pages_processed
__ZACHOWANE_157__, __ZACHOWANE_156__ site: id, name, url
site.deletedsite: id
site.custom_code.updatedcustom_code: type (css lub js)
__ZAREZERWOWANE_143__, __ZAREZERWOWANE_142__ domain: name
integration.updatedintegration: type, enabled
__ZAREZERWOWANE_135__, __ZAREZERWOWANE_134__, __ZAREZERWOWANE_133__ Pusty obiekt, {}
chatbot.updatedchatbot: id, name, enabled
chatbot.guidance.created, chatbot.guidance.updated guidance: id, type, title, enabled
chatbot.guidance.deleted__ZAREZERWOWANE_118__: __ZAREZERWOWANE_117__
__ZAREZERWOWANE_116__, __ZAREZERWOWANE_115__ redirect: id, source_path, type, article_id, category_id
redirect.deleted__ZAREZERWOWANE_107__: __ZAREZERWOWANE_106__
workspace.updatedworkspace: 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.removedteam_member: id
team_member.logged_inuser: id, email, name
api_key.created, api_key.revoked api_key: id, prefix, label, scopes, expires_at
api_key.rotatedapi_key dla nowego klucza i previous_api_key: id
pingmessage

data nigdy nie zawiera załączników, sekretów, kodu niestandardowego ani szczegółów rozliczeniowych.

Przykładowe dane według rodziny zdarzeń

Te przykłady pokazują tylko data. Reszta żądania jest taka sama dla każdego zdarzenia.

Formularz kontaktowy, contact_message.created:

Artykuły, article.translated:

status to status tego języka: draft, review, published, archived lub translation source. url może być null, jeśli centrum pomocy nie ma jeszcze adresu.

Reakcje i opinie, article.feedback.created:

W przypadku reakcji reaction.type odpowiada smiley, neutral_face lub disappointed. Centra pomocy, które wyświetlają przyciski kciuka, wysyłają smiley w przypadku odpowiedzi „Tak” i disappointed w przypadku odpowiedzi „Nie”. W przypadku opinii article.id odpowiada null, gdy artykuł już nie istnieje.

Kategorie, category.created:

Synchronizacje, sync.completed i sync.failed:

trigger to manual, api lub automatic. reason to pages_failed, gdy nie można zsynchronizować niektórych stron, lub failed, gdy synchronizacja została zatrzymana.

Ustawienia centrum pomocy, redirect.created:

Obszar roboczy i współpracownicy, team_member.role_changed:

role jest admin, editor, billing_manager lub viewer. status jest enabled, disabled lub pending_invite.

Klucze API, api_key.rotated:

Wydarzenie testowe, ping:

Obsługuj zdarzenia w swoim odbiorniku

{
  "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."
}
  • Odpowiedz szybko. Najpierw zwróć kod statusu 2xx, a następnie wykonaj zadanie. Notiondesk czeka 5 sekund na rozpoczęcie odpowiedzi serwera i łącznie 10 sekund, odczytując jedynie kod statusu.
  • Spodziewaj się duplikatów. To samo zdarzenie może pojawić się więcej niż raz, na przykład po ponownej próbie. Pomiń wszystkie zdarzenia id, które już przetworzyłeś.
  • Nie kieruj się kolejnością. Wydarzenia mogą pojawić się w nieuporządkowanej kolejności. Użyj occurred_at, gdy kolejność ma znaczenie.
  • Odczytaj dane jako najnowszy stan. data jest odczytywany w momencie wysłania zdarzenia, więc dwie szybkie zmiany w artykule mogą spowodować zmianę jego późniejszej wersji. Jeśli do tego czasu element zniknie, zdarzenie jest pomijane.

Często zadawane pytania

Czy otrzymam pełną treść artykułu?

Nie. Wydarzenia artykułów zawierają tytuł, slug, adres URL i status. Użyj API Notiondesk, jeśli potrzebujesz więcej informacji.

Jak mogę dowiedzieć się, z którego centrum pomocy pochodzi dane zdarzenie?

Przeczytaj site_id. Jest to identyfikator centrum pomocy lub null w przypadku zdarzeń w obszarze roboczym i zdarzenia testowego.

Dlaczego nie otrzymałem zdarzenia dla każdej reakcji?

Liczba reakcji i opinii na temat artykułów jest ograniczona do 120 na minutę dla każdego centrum pomocy. Zdarzenia przekraczające limit nie są wysyłane. Skorzystaj z analityki centrum pomocy, aby uzyskać łączną liczbę zdarzeń.

Czy mogę otrzymać to samo wydarzenie dwa razy?

Tak, na przykład po ponownej próbie. id pozostaje bez zmian, więc zignoruj ​​ten, który już przetworzyłeś.

Co oznacza wersja?

Informuje, który format żądania został użyty. Żądania obecnie używają 2026-11-06.

Powiązane artykuły

Czy ta strona była pomocna?

Still need help? Ask us