Каждый запрос веб-перехватчика сообщает вам о том, что произошло в вашем рабочем пространстве или в одном из его справочных центров. В этой статье перечислены все события, которые вы можете выбрать для конечной точки, как выглядит каждый запрос и что он содержит.
POSTideventversionoccurred_atsite_iddataМероприятия, которые вы можете выбрать
На панели мониторинга события группируются так же, как и в таблицах ниже. Первый столбец — это имя, которое вы видите в окне выбора событий. Второй — это имя события, которое ваш сервер получает в event.
Контакты
| На панели управления | Событие | Отправлено, когда |
|---|---|---|
| Сообщение об обращении получено | Посетитель отправляет вашу контактную форму. | contact_message.created |
Содержание
| На панели управления | Событие | Отправлено, когда |
|---|---|---|
| Статья создана | Добавляется новая статья или статья на новом языке. | article.created |
| Статья обновлена. | Содержание статьи изменяется во время синхронизации. | article.updated |
| Статья опубликована | Язык статьи опубликован. | article.published |
| Статья не опубликована | Язык публикации статьи больше не используется. | article.unpublished |
| Статья удалена | Статья удалена | article.deleted |
| Статья переведена | Статья автоматически переводится на новый язык. | article.translated |
| Реакция добавлена | Реакция читателя на статью | article.reaction.added |
| Реакция изменилась | Реакция читателя меняется. | article.reaction.changed |
| Реакция удалена | Читатель удаляет свою реакцию | article.reaction.removed |
| Получены отзывы на статью. | Читатель отправляет письменный отзыв на статью. | article.feedback.created |
| Создана категория | Добавляется новая категория или новый язык в рамках категории. | category.created |
| Категория обновлена | Содержимое категории изменяется во время синхронизации. | category.updated |
| Категория удалена | Категория удалена | category.deleted |
| Опубликована запись в журнале изменений | Опубликована статья в категории "Журнал изменений" | changelog.published |
| Синхронизация завершена. | Синхронизация с Notion завершилась. | sync.completed |
| Синхронизация не удалась | Синхронизация с Notion завершается неудачей. | sync.failed |
Сообщения article.updated и category.updated не отправляются, если изменяется только статус или другие свойства. События категории отправляются один раз для каждого языка.
Количество реакций и отзывов на статьи ограничено 120 событиями в минуту для каждого справочного центра. События, превышающие этот лимит, не отправляются, поэтому используйте аналитику вашего справочного центра для подсчета общего количества событий.
Настройки справочного центра
| На панели управления | Событие | Отправлено, когда |
|---|---|---|
| Сохранены настройки справочного центра | Настройки справочного центра сохранены. | site.updated |
| Сохраненный пользовательский код | Пользовательские CSS-стили или JavaScript-код сохраняются. | site.custom_code.updated |
| Домен пользователя подтвержден | Ваш собственный домен начинает предоставлять доступ к справочному центру. | site.domain.verified |
| Проверка пользовательского домена не удалась. | Не удалось получить доступ к вашему пользовательскому домену. | site.domain.verification_failed |
| Интеграция обновлена. | Интеграция настраивается, изменяется, включается или выключается. | integration.updated |
| Понятие связано | Понятие взаимосвязано | notion.connected |
| Понятие разъединено | Понятие разрознено | notion.disconnected |
| Доступ к информации потерян. | Notiondesk больше не может читать ваши страницы Notion | notion.access_lost |
| Обновлен чат-бот с искусственным интеллектом. | Настройки чат-бота изменяются, или он включается/выключается. | chatbot.updated |
| Добавлены инструкции для чат-бота. | В чат-бот добавлено руководство. | chatbot.guidance.created |
| Обновлены рекомендации по использованию чат-ботов. | Изменения в рекомендациях | chatbot.guidance.updated |
| Удалены инструкции для чат-бота. | Указание удалено | chatbot.guidance.deleted |
| Добавлено перенаправление | Добавлено перенаправление | redirect.created |
| Перенаправление обновлено | Изменение перенаправления | redirect.updated |
| Перенаправление удалено | Перенаправление удалено | redirect.deleted |
Проверка пользовательских доменов выполняется регулярно, поэтому события, связанные с доменом, могут поступать через несколько минут после внесения изменений.
Рабочее пространство
События в рабочей области не привязаны к одному центру поддержки, поэтому их site_id равно null.
| На панели управления | Событие | Отправлено, когда |
|---|---|---|
| Рабочее пространство переименовано | Рабочее пространство переименовано. | workspace.updated |
| Получен запрос на присоединение. | Кто-то просит присоедиться к рабочему пространству. | workspace.join_request.created |
| Запрос на присоединение одобрен. | Заявка на присоединение одобрена. | workspace.join_request.approved |
| Запрос на присоединение отклонен. | Запрос на присоединение отклонен. | workspace.join_request.declined |
| Приглашен товарищ по команде | Приглашен товарищ по команде | team_member.invited |
| Товарищ по команде присоединился | Приглашенный товарищ по команде принимает приглашение. | team_member.joined |
| Роль товарища по команде изменилась. | Роль товарища по команде меняется. | team_member.role_changed |
| Включить или выключить товарища по команде | Член команды включен или выключен | team_member.status_changed |
| Товарищ по команде удален | Один из членов команды удален. | team_member.removed |
| Товарищ по команде вошел в систему | Коллега входит в систему. По умолчанию отправляется только в открытое им рабочее пространство. | team_member.logged_in |
| Создан ключ API. | Создан ключ API. | api_key.created |
| API-ключ повернут | Ключ API был заменен. | api_key.rotated |
| Ключ API отозван | API-ключ отозван. | api_key.revoked |
| Создан справочный центр. | Создан центр поддержки. | site.created |
| Центр поддержки удален | Центр поддержки удаляется, в то время как в рабочем пространстве по-прежнему существует другой онлайн-центр поддержки. | site.deleted |
Тестовое событие
| На панели управления | Событие | Отправлено, когда |
|---|---|---|
| Тестовое событие | Вы нажимаете кнопку «Отправить тестовое событие» на конечной точке. | ping |
Вы не можете выбрать ping в списке событий. Оно отправляется только на проверяемую вами конечную точку, её site_id равен null, и отправляется один раз без повторных попыток.
Что содержит каждый запрос
Notiondesk отправляет запрос POST с телом в формате 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"
}
}
}| Поле | Что это такое |
|---|---|
id | Идентификатор события. Он остается неизменным при повторной попытке запроса, поэтому используйте его для обнаружения дубликатов. |
event | Название события, например, article.published |
version | Версия данного формата запроса |
occurred_at | Дата и время события, указанные в соответствии со стандартом ISO 8601. |
site_id | Центр поддержки, из которого поступило событие, или null для событий рабочей области и тестового события. |
data | Суть мероприятия. Посмотрите, что содержат данные. |
Каждый запрос также содержит следующие заголовки:
| Заголовок | Ценить |
|---|---|
Content-Type | application/json |
User-Agent | ND-Webhooks/1.0 |
X-ND-Event | Название события, такое же, как event в тексте сообщения. |
X-ND-Delivery | Идентификатор доставки на этот конечный пункт. Он остается неизменным при повторных попытках. |
X-ND-Signature | Подпись, подтверждающая запрос, получена от Notiondesk. Проверка этого описана в разделе «Проверка того, что веб-хук получен от Notiondesk». |
Какие данные содержат
В зависимости от события, data содержит один или несколько объектов:
| Событие | Что содержится в 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 на новом языке и source_locale |
article.deleted | article: id |
article.reaction.added, article.reaction.changed, article.reaction.removed | article: id, и reaction: type |
article.feedback.created | article: id, и 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 | __КОНСЕРВИРОВАНО_150__: __КОНСЕРВИРОВАНО_149__ |
site.custom_code.updated | custom_code: type (css или js) |
site.domain.verified, site.domain.verification_failed | domain: name |
integration.updated | integration: type, enabled |
notion.connected, notion.disconnected, notion.access_lost | Пустой объект, {} |
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 для нового ключа, и previous_api_key: id |
ping | message |
data никогда не содержит вложений, секретов, пользовательского кода или платежных данных.
Пример данных по семействам событий
В этих примерах показано только data. Остальная часть запроса одинакова для всех событий.
Форма обратной связи, contact_message.created:
Статьи, __СОХРАНЕНО_60__:
status — это статус данного языка: draft, review, published, archived или translation source. url может быть null, если у центра поддержки еще нет адреса.
Реакции и отзывы, article.feedback.created:
Для реакций значение reaction.type соответствует smiley, neutral_face или disappointed. Центры поддержки, отображающие кнопки с изображением большого пальца, отправляют smiley для «Да» и disappointed для «Нет». В случае обратной связи значение article.id соответствует null, если статья больше не существует.
Категории, __СОХРАНЕНО_42__:
Синхронизация, sync.completed и sync.failed:
trigger — это manual, api или automatic. reason — это pages_failed, если некоторые страницы не удалось синхронизировать, или failed, если синхронизация остановилась.
Настройки справочного центра, redirect.created:
Рабочее пространство и коллеги, team_member.role_changed:
role — это admin, editor, billing_manager или viewer. status — это enabled, disabled или pending_invite.
Ключи API, api_key.rotated:
Тестовое событие, ping:
Обрабатывайте события в вашем приемнике.
{
"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."
}- Реагируйте быстро. Сначала верните любой код состояния
2xx, а затем выполните работу. Notiondesk ожидает 5 секунд, пока ваш сервер начнет отвечать, и 10 секунд в общей сложности, и только считывает код состояния.
- Ожидайте дубликатов. Одно и то же событие может поступать несколько раз, например, после повторной попытки. Пропустите все уже обработанные события
id.
- Не полагайтесь на порядок. События могут происходить в произвольном порядке. Используйте
occurred_at, когда порядок имеет значение.
- Данные считываются как последнее состояние.
dataсчитывается при отправке события, поэтому два быстрых изменения в статье могут отражать более позднюю версию. Если к этому моменту элемент исчезнет, событие пропускается.
Часто задаваемые вопросы
Получу ли я полный текст статьи?
Нет. События статьи содержат заголовок, URL-адрес, URL-адрес и статус. Используйте API Notiondesk, если вам нужно больше информации.
Как определить, из какого справочного центра поступило сообщение?
Прочитайте site_id. Это идентификатор справочного центра, или null для событий рабочей области и тестового события.
Почему за каждую реакцию не выпадало событие?
Количество реакций и отзывов на статьи ограничено 120 событиями в минуту для каждого справочного центра. События, превышающие этот лимит, не отправляются. Используйте аналитику вашего справочного центра для получения общих данных.
Могу ли я получить одно и то же событие дважды?
Да, например, после повторной попытки. Значение id остается неизменным, поэтому игнорируйте уже обработанные значения.
Что означает "версия"?
Это показывает, какой формат запроса был использован. В настоящее время запросы используют формат 2026-11-06.