Webhookイベントとその内容

選択できるすべての Notiondesk ウェブフック イベント、サーバーが受信するリクエスト フォーマット、および各イベントに含まれるデータ。

4 分で読めます

各Webhookリクエストは、ワークスペースまたはそのヘルプセンターで発生した事象を通知します。この記事では、エンドポイントで選択できるすべてのイベント、各リクエストの形式、および含まれる内容について説明します。

クイックパス:エンドポイントの「イベント」の下にある「設定」>「開発者」>「Webhook」でイベントを選択します。各リクエストは、、、、、およびを含む JSON です。POSTideventversionoccurred_atsite_iddata

選択できるイベント

ダッシュボードでは、以下の表と同じようにイベントがグループ化されます。最初の列は、イベントピッカーに表示される名前です。2番目の列は、サーバーが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 は、ステータスまたはその他のプロパティのみが変更された場合は送信されません。カテゴリ イベントは、言語ごとに 1 回送信されます。

各ヘルプセンターにおける反応および記事へのフィードバックは、1分あたり120件に制限されています。この上限を超えるイベントは送信されないため、合計数についてはヘルプセンターの分析ツールをご利用ください。

ヘルプセンターの設定

ダッシュボードでイベント送信時
ヘルプセンターの設定が保存されましたヘルプセンターの設定が保存されますsite.updated
カスタムコードが保存されましたカスタムCSSまたはJavaScriptが保存されますsite.custom_code.updated
カスタムドメイン検証済みカスタムドメインがヘルプセンターの提供を開始しますsite.domain.verified
カスタムドメインチェックに失敗しましたカスタムドメインにアクセスできませんでしたsite.domain.verification_failed
統合が更新されました統合の設定、変更、有効化、無効化が行われます。integration.updated
概念が関連している概念はつながっているnotion.connected
概念が断絶している概念が断絶しているnotion.disconnected
Notationへのアクセスが失われましたNotiondesk は、あなたの Notion ページを読み取ることができなくなりました。notion.access_lost
AIチャットボットがアップデートされましたチャットボットの設定が変更されるか、オンまたはオフになります。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 は JSON ボディを含む POST リクエストを送信します。

{
  "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イベントのID。リクエストが再試行されても同じなので、重複を検出するために使用します。
eventイベント名、例: article.published
versionこのリクエスト形式のバージョン
occurred_atイベントが発生したとき、ISO 8601 日付と時刻として
site_idイベントの発生元となるヘルプセンター、またはワークスペースイベントとテストイベントの場合はnull
dataイベントの内容。データの内容を参照してください。

各リクエストには、以下のヘッダーも含まれます。

ヘッダ価値
Content-Typeapplication/json
User-AgentND-Webhooks/1.0
X-ND-Eventイベント名は、本文中のeventと同じです。
X-ND-Deliveryこのエンドポイントへの配信のID。再試行後も同じです。
X-ND-SignatureリクエストがNotiondeskから送信されたことを証明する署名。その確認方法については、「WebhookがNotiondeskから送信されたことを確認する」を参照してください。

データの内容

data には、イベントに応じて 1 つ以上のオブジェクトが格納されます。

イベント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.translated新しい言語では article、そして source_locale
article.deletedarticle: id
article.reaction.added、article.reaction.changed、article.reaction.removed article: id、および reaction: type
article.feedback.createdarticle: id、および feedback: id、name、email、message、locale
category.created、category.updated category: id、locale、name、slug
category.deletedcategory: id
sync.completedsync: trigger、duration_seconds、pages_synced、pages_updated
sync.failedsync: reason、pages_processed
site.updated、site.created site: id、name、url
site.deletedsite: id
site.custom_code.updatedcustom_code: type (css または js)
site.domain.verified、site.domain.verification_failed domain: name
integration.updatedintegration: type、enabled
notion.connected、notion.disconnected、notion.access_lost空のオブジェクト、{}
chatbot.updatedchatbot: id、name、enabled
chatbot.guidance.created、chatbot.guidance.updated guidance: id、type、title、enabled
chatbot.guidance.deletedguidance: id
redirect.created、redirect.updated redirect: id、source_path、type、article_id、category_id
redirect.deletedredirect: id
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.rotated新しいキーには api_key、previous_api_key: id が設定されます。
pingmessage

data には、添付ファイル、秘密情報、カスタムコード、請求情報などは一切含まれません。

イベントファミリー別のサンプルデータ

これらの例では、data のみを示しています。リクエストの残りの部分は、どのイベントでも同じです。

お問い合わせフォーム、contact_message.created:

記事、article.translated:

status はその言語のステータスです。draft、review、published、archived、または translation source のいずれかです。ヘルプセンターにまだ住所が登録されていない場合は、url は null になることがあります。

反応とフィードバック、article.feedback.created:

リアクションの場合、reaction.type は smiley、neutral_face、または disappointed になります。サムズボタンを表示するヘルプセンターでは、はいの場合は smiley、いいえの場合は disappointed が送信されます。フィードバックの場合、記事が存在しなくなった場合は article.id は null になります。

カテゴリ、category.created:

同期ファイル、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が読み込まれるため、記事への2回の迅速な変更はどちらも最新バージョンを保持できます。その時点でアイテムが存在しない場合は、イベントはスキップされます。

よくある質問

記事の全文を読むことはできますか?

いいえ。記事イベントには、タイトル、スラッグ、URL、ステータスが含まれます。さらに情報が必要な場合は、Notiondesk API を使用してください。

どのヘルプセンターから発生したイベントかを確認するにはどうすればよいですか?

site_id をお読みください。これはヘルプセンターの ID です。ワークスペース イベントおよびテスト イベントの場合は null をお読みください。

なぜ全ての反応に対してイベントが発生しなかったのか?

各ヘルプセンターにおける反応および記事へのフィードバックは、1分あたり120件に制限されています。上限を超えたイベントは送信されません。合計数については、ヘルプセンターの分析ツールをご利用ください。

同じイベントを2回受け取ることはできますか?

はい、例えば再試行後などです。id は変更されないため、既に処理済みのものは無視してください。

バージョンとはどういう意味ですか?

これは、どのリクエスト形式が使用されたかを示します。現在のリクエストでは、2026-11-06 が使用されます。

関連する記事

このページは役に立ちましたか?

Still need help? Ask us