Notiondesk API を使用してヘルプセンターの統合を管理します。

Notiondesk API を使用すると、ヘルプセンターのサードパーティ統合（分析、ライブチャット、タグマネージャープロバイダーなど）の一覧表示、設定、無効化を行うことができます。この API を使用すれば、1 つのスクリプトで複数のヘルプセンターに同じ分析またはチャット設定を展開できます。

方法	パス	範囲	する
`GET`	`/sites/{site_id}/integrations`	`read`	設定済みのプロバイダーを一覧表示します
`PATCH`	`/sites/{site_id}/integrations/{type}`	`admin`	プロバイダを設定して有効化します
`POST`	`/sites/{site_id}/integrations/{type}/disable`	`admin`	プロバイダーをオフにする

プロバイダーの設定と停止には、統合を含む計画が必要です。

プロバイダーは、ヘルプセンターのすべてのページでサードパーティースクリプトを読み込みます。Googleタグマネージャーコンテナは、所有者が公開したコンテンツを実行し、PlausibleまたはUmamiは、分析スクリプトの読み込み元を決定します。そのため、統合を変更するにはスコープが必要です。信頼できる統合のみにキーを割り当ててください。proxy_urladminadmin

サポート対象のプロバイダー

`type`	分野	必須	形式	セットアップガイド
`google-analytics`	`tracking_id`	はい	Google Analytics 4 の測定 ID: `G-` と 10 文字の大文字または数字 (例: `G-ABCDEFGHIJ`)	Googleアナリティクス
`plausible-analytics`	`domain`	はい	Plausibleに登録されているあなたのサイトドメイン	もっともらしい分析
`plausible-analytics`	`proxy_url`	いいえ	スクリプトをプロキシする`https`オリジン（例：`https://plausible.example.com`）
`umami`	`website_id`	はい	文字、数字、`-`、`_`	うま味
`umami`	`proxy_url`	いいえ	スクリプトをプロキシする`https`オリジン（例：`https://umami.example.com`）
`intercom`	`app_id`	はい	文字、数字、`-`、`_`	インターホン
`crisp`	`app_id`	はい	文字、数字、`-`、`_`	サクサク
`helpscout`	`beacon_id`	はい	文字、数字、`-`、`_`	スカウトを手伝ってください
`google-tag-manager`	`container_id`	はい	文字、数字、`-`、`_`、例えば`GTM-ABC123`	Googleタグマネージャー

各値は最大255文字の文字列です。いずれも秘密情報ではなく、それぞれがプロバイダーのスクリプトがページ内で必要とする識別子です。Notiondesk はプロバイダーに対してフォーマットをチェックしますが、ID自体はチェックしません。

連携しているサービスを一覧表示してください

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "type": "plausible-analytics",
      "settings": {"domain": "help.example.com", "proxy_url": null},
      "enabled": true
    },
    {
      "type": "crisp",
      "settings": {"app_id": "7d1c9a2e-5b4f-4e3a-9c8d-2f1e0a9b8c7d"},
      "enabled": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

分野	意味
`type`	プロバイダー
`settings`	プロバイダーのフィールド。`null` は、ダッシュボードでプロバイダーが構成されずにオンになったときに使用されます。
`enabled`	ヘルプセンターがプロバイダーを読み込むかどうか

このリストには、無効になっているプロバイダーが順不同で含まれており、常に1つの応答に収まります。設定されていないプロバイダーはリストに含まれていません。

プロバイダの設定

プロバイダーのフィールドをそのパスに送信します。ルートは統合情報とともに200 OKという応答を返します。

curl -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/plausible-analytics" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"domain": "help.example.com"}'

{
  "type": "plausible-analytics",
  "settings": {"domain": "help.example.com", "proxy_url": null},
  "enabled": true
}

アップデートを行うと、必ずプロバイダが有効になります。__ PRESERVED_29__ フィールドは存在しません。プロバイダを無効にするには、無効化ルートを使用してください。

省略したフィールドは、保存された値を保持します。設定済みのプロバイダを変更せずに再度有効にするには、{} を送信してください。

プロキシを削除するには、 "proxy_url": null を送信してください。

アップデートのたびにヘルプセンター全体が更新され、キャッシュされたページがクリアされ、すべてのページが再構築されます。

注:現在のフォーマットが適用される前に保存された値（Google Analytics ID やではない値など）は検証に失敗します。そのフィールドに有効な値を送信するまで、そのプロバイダーのすべての更新は 400 を返します。UA-proxy_urlhttpsvalidation_error{}

プロバイダーをオフにする

ルートは 204 No Content に応答し、ヘルプセンターはプロバイダの読み込みを停止します。設定は保持されるため、リストには enabled: false と表示されたままになりますが、更新ルートに {} が送信されると、プロバイダが再び有効になります。

既にオフになっているプロバイダ、または設定されていないプロバイダをオフにした場合も、204 という応答が返され、何も変更されないため、再試行は常に安全です。

エラー

curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/google-tag-manager/disable" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

状態	いつ	`code`
400	必須フィールドが欠落しているか空である、値がフォーマットと一致しない、または255文字を超えている、保存された値がフォーマットに違反して本文から除外されている、または本文に不明なフィールドがある	`validation_error`
403	キーには `read` スコープ、または変更用の `admin` がありません	`insufficient_scope`
403	ご利用のプランには統合機能が含まれていないか、キーの作成者がこのヘルプセンターを変更できません。	`permission_denied`
404	ワークスペースにヘルプセンターが存在しないか、`type` はサポートされていないプロバイダーです。	`not_found`

エラーエンベロープおよびその他のコードについては、「Notiondesk API エラー、レート制限、および再試行の処理」を参照してください。

よくある質問

Notiondesk API を使用してカスタムスクリプトを追加できますか？

いいえ。カスタムJavaScriptはダッシュボードでのみ設定できます。詳しくは「カスタムJavaScriptでヘルプセンターを強化する」をご覧ください。

なぜ私のキーでは統合設定ができないのですか？

統合を変更するには、ワークスペースの所有者または管理者が作成したキーのみが保持する admin スコープが必要です。また、プランには統合を含める必要があります。

連携機能を無効にすると、その設定は削除されますか？

いいえ。設定は保持され、プロバイダの更新ルートに{}を送信すると、プロバイダ側で再び有効になります。

Universal Analyticsの`UA-` IDを使用できますか？

いいえ。このAPIは、G-で始まるGoogle Analytics 4の測定IDのみを受け付けます。

次は？

Notiondesk API を使用してヘルプセンターの分析情報を取得します。

Notiondesk API を使用してヘルプセンターのブランディングとテーマをカスタマイズします

APIキーを使用してNotiondesk APIで認証します。

目次