Each webhook request tells you what happened in your workspace or one of its help centers. This article lists every event you can pick for an endpoint, what each request looks like and what it contains.
POST with id, event, version, occurred_at, site_id and data.Events you can pick
The dashboard groups events the same way as the tables below. The first column is the name you see in the event picker. The second is the event name your server receives in event.
Contacts
| In the dashboard | Event | Sent when |
|---|---|---|
| Contact message received | contact_message.created | A visitor sends your contact form |
Content
| In the dashboard | Event | Sent when |
|---|---|---|
| Article created | article.created | A new article, or a new language of an article, is added |
| Article updated | article.updated | An article's content changes during a sync |
| Article published | article.published | A language of an article is published |
| Article unpublished | article.unpublished | A published language of an article is no longer published |
| Article deleted | article.deleted | An article is deleted |
| Article translated | article.translated | An article is translated automatically into a new language |
| Reaction added | article.reaction.added | A reader reacts to an article |
| Reaction changed | article.reaction.changed | A reader changes their reaction |
| Reaction removed | article.reaction.removed | A reader removes their reaction |
| Article feedback received | article.feedback.created | A reader sends written feedback on an article |
| Category created | category.created | A new category, or a new language of a category, is added |
| Category updated | category.updated | A category's content changes during a sync |
| Category deleted | category.deleted | A category is deleted |
| Changelog entry published | changelog.published | An article in a changelog category is published |
| Sync completed | sync.completed | A sync with Notion finishes |
| Sync failed | sync.failed | A sync with Notion fails |
article.updated and category.updated are not sent when only the status or other properties change. Category events are sent once per language.
Reactions and article feedback are capped at 120 events per minute for each help center. Events over the cap are not sent, so use your help center analytics for totals.
Help center settings
| In the dashboard | Event | Sent when |
|---|---|---|
| Help center settings saved | site.updated | A help center setting is saved |
| Custom code saved | site.custom_code.updated | Custom CSS or JavaScript is saved |
| Custom domain verified | site.domain.verified | Your custom domain starts serving the help center |
| Custom domain check failed | site.domain.verification_failed | Your custom domain could not be reached |
| Integration updated | integration.updated | An integration is set up, changed, turned on or turned off |
| Notion connected | notion.connected | Notion is connected |
| Notion disconnected | notion.disconnected | Notion is disconnected |
| Notion access lost | notion.access_lost | Notiondesk can no longer read your Notion pages |
| AI chatbot updated | chatbot.updated | The chatbot's settings change, or it is turned on or off |
| Chatbot guidance added | chatbot.guidance.created | A guidance is added to the chatbot |
| Chatbot guidance updated | chatbot.guidance.updated | A guidance changes |
| Chatbot guidance deleted | chatbot.guidance.deleted | A guidance is deleted |
| Redirect added | redirect.created | A redirect is added |
| Redirect updated | redirect.updated | A redirect changes |
| Redirect deleted | redirect.deleted | A redirect is deleted |
Custom domains are checked regularly, so domain events can arrive a few minutes after the change.
Workspace
Workspace events are not tied to one help center, so their site_id is null.
| In the dashboard | Event | Sent when |
|---|---|---|
| Workspace renamed | workspace.updated | The workspace is renamed |
| Join request received | workspace.join_request.created | Someone asks to join the workspace |
| Join request approved | workspace.join_request.approved | A join request is approved |
| Join request declined | workspace.join_request.declined | A join request is declined |
| Teammate invited | team_member.invited | A teammate is invited |
| Teammate joined | team_member.joined | An invited teammate accepts |
| Teammate role changed | team_member.role_changed | A teammate's role changes |
| Teammate turned on or off | team_member.status_changed | A teammate is turned on or off |
| Teammate removed | team_member.removed | A teammate is removed |
| Teammate signed in | team_member.logged_in | A teammate signs in. Sent only to the workspace they open by default |
| API key created | api_key.created | An API key is created |
| API key rotated | api_key.rotated | An API key is rotated |
| API key revoked | api_key.revoked | An API key is revoked |
| Help center created | site.created | A help center is created |
| Help center deleted | site.deleted | A help center is deleted while the workspace still has another online help center |
Test event
| In the dashboard | Event | Sent when |
|---|---|---|
| Test event | ping | You click Send test event on an endpoint |
You can't pick ping in the event list. It goes only to the endpoint you test, its site_id is null, and it is sent once, with no retries.
What each request contains
Notiondesk sends a POST request with a 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"
}
}
}| Field | What it is |
|---|---|
id | The event's ID. It stays the same when a request is retried, so use it to spot duplicates |
event | The event name, for example article.published |
version | The version of this request format |
occurred_at | When the event happened, as an ISO 8601 date and time |
site_id | The help center the event comes from, or null for workspace events and the test event |
data | The things the event is about. See What data contains |
Each request also carries these headers:
| Header | Value |
|---|---|
Content-Type | application/json |
User-Agent | ND-Webhooks/1.0 |
X-ND-Event | The event name, the same as event in the body |
X-ND-Delivery | The ID of this delivery to this endpoint. It stays the same across retries |
X-ND-Signature | The signature that proves the request comes from Notiondesk. Checking it is covered in Verify that a webhook comes from Notiondesk |
What data contains
data holds one or more objects, depending on the event:
| Event | What is in data |
|---|---|
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 the new language, and source_locale |
article.deleted | article: id |
article.reaction.added, article.reaction.changed, article.reaction.removed | article: id, and reaction: type |
article.feedback.created | article: id, and 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 or js) |
site.domain.verified, site.domain.verification_failed | domain: name |
integration.updated | integration: type, enabled |
notion.connected, notion.disconnected, notion.access_lost | An empty object, {} |
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 for the new key, and previous_api_key: id |
ping | message |
data never contains attachments, secrets, custom code or billing details.
Example data by event family
These examples show only data. The rest of the request is the same for every event.
Contact form, contact_message.created:
{
"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"
}
}Articles, article.translated:
{
"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"
}status is the status of that language: draft, review, published, archived or translation source. url can be null if the help center has no address yet.
Reactions and feedback, article.feedback.created:
{
"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"
}
}For reactions, reaction.type is smiley, neutral_face or disappointed. Help centers that show thumbs buttons send smiley for Yes and disappointed for No. On feedback, article.id is null when the article no longer exists.
Categories, category.created:
{
"category": {
"id": "1763392017",
"locale": "en",
"name": "Billing",
"slug": "billing"
}
}Syncs, sync.completed and sync.failed:
{
"sync": {
"trigger": "automatic",
"duration_seconds": 42,
"pages_synced": 120,
"pages_updated": 3
}
}{
"sync": {
"reason": "pages_failed",
"pages_processed": 118
}
}trigger is manual, api or automatic. reason is pages_failed when some pages could not be synced, or failed when the sync stopped.
Help center settings, redirect.created:
{
"redirect": {
"id": "019a8f35-2a6c-7d63-b4e8-0c1f5a9d3e47",
"source_path": "/old-help/reset-password",
"type": "article",
"article_id": "1763391842",
"category_id": null
}
}Workspace and teammates, team_member.role_changed:
{
"team_member": {
"id": "019a8f37-7e1b-7f74-8c2d-9a4e6b1f0c59",
"email": "[email protected]",
"role": "editor",
"status": "enabled"
}
}role is admin, editor, billing_manager or viewer. status is enabled, disabled or pending_invite.
API keys, api_key.rotated:
{
"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" }
}Test event, ping:
{
"message": "Test event from Notiondesk."
}Handle events in your receiver
- Respond quickly. Return any
2xxstatus code first, then do the work. Notiondesk waits 5 seconds for your server to start answering and 10 seconds in total, and only reads the status code.
- Expect duplicates. The same event can arrive more than once, for example after a retry. Skip any
idyou already processed.
- Don't rely on order. Events can arrive out of order. Use
occurred_atwhen order matters.
- Read data as the latest state.
datais read when the event is sent, so two quick changes to an article can both carry the later version. If the item is gone by then, the event is skipped.
Common questions
Do I get the full article content?
No. Article events carry the title, slug, URL and status. Use the Notiondesk API if you need more.
How do I tell which help center an event comes from?
Read site_id. It is the ID of the help center, or null for workspace events and the test event.
Why didn't I get an event for every reaction?
Reactions and article feedback are capped at 120 events per minute for each help center. Events over the cap are not sent. Use your help center analytics for totals.
Can I receive the same event twice?
Yes, for example after a retry. The id stays the same, so ignore one you have already processed.
What does version mean?
It tells you which request format was used. Requests currently use 2026-11-06.