Webhookの設定

Webhookは、ほかのプログラムがSpaceBuilderの指定したフォルダへファイルを自動的に送信するときに使う、専用の受信アドレスです。たとえば、スキャナー、業務システム、自動化プログラムで作成したファイルを、人が操作することなくフォルダに保存できます。

このページでは、管理者がサーバー全体のWebhookの使用範囲と制限を設定します。実際のフォルダにWebhookを作成して受信アドレスを使用する方法は、フォルダWebhookを参照してください。

設定前に確認する事項

• 外部からWebhookを呼び出すには、SpaceBuilderに接続できるアドレスを用意しておく必要があります。
• Webhookアドレスには認証用のシークレットが含まれます。アドレス全体は、管理者と連携プログラムの担当者だけで共有します。
• インターネットに公開する場合は、HTTPSの使用を推奨します。
• 受信するファイルが大きいほど、サーバーのメモリとストレージの使用量が増えます。

Webhookポリシーの設定

管理者設定で、Webhook機能を使用する対象とセキュリティレベルを選択します。

容量とリクエスト制限の設定

Webhookで一度に受信できるサイズとリクエスト回数を設定します。一般的な環境では、デフォルト値のまま使用できます。

ペイロードは、Webhookで送られるファイルとリクエスト情報を合わせた内容全体を指します。ファイル以外の情報も含まれるため、表示されるサイズは実際のファイルより少し大きくなることがあります。

設定したサイズを超えるとファイルは保存されず、413 Request Entity Too Largeの応答が返されます。大容量ファイルを頻繁に送信する環境には、通常のファイルアップロードのほうが適しています。

一度に受信できるサイズを増やす

8 MBより大きいファイルをWebhookで受信する必要がある場合は、次のように変更します。

1. 管理者ページでサービス構成 > ファイルエリアを開き、**Webhook（自動データ受信）**カードを開きます。
2. 最大ペイロードサイズの入力欄に必要なサイズを入力します。
3. 入力欄の右側でMBまたはGBの単位を選択します。
4. 設定を保存します。
5. まず小さいファイルで送信を確認してから、必要なファイルを送信します。

たとえば、最大20 MB程度のファイルを受信する場合は、数値に20、単位にMBを選択します。サーバーが対応する設定範囲は1 KB~1 GBです。

Webhookをインターネットに公開する場合は、CloudflareやNginxにもリクエスト制限を設定すると、異常に多いリクエストをサーバーに届く前に遮断できます。

推奨する設定の順序

1. インバウンドWebhookを使用するをオンにします。
2. フォルダでWebhookを作成できるように、ユーザーAPIキー発行を許可するをオンにします。
3. 個人フォルダで受信する必要がある場合にのみ、個人フォルダーのWebhookを許可をオンにします。
4. 容量とリクエスト制限は、デフォルト値を使用します。
5. 設定を保存したあと、実際に使用するフォルダでWebhookを作成します。
6. まず小さいテストファイルを送信して、保存場所と権限を確認します。

問題が発生したとき

関連ドキュメント

• フォルダWebhook
• デバイス情報
• 外部接続方式の選択