手動によるWebhookの作成

ガイドWebhookWebhookの管理手動によるWebhookの作成

手動によるWebhookの作成

Box APIを介してWebhookを作成する方法に加えて、開発者コンソールから手動でWebhookを作成することもできます。このプロセスは、多くの場合Webhook V1と呼ばれます。

制約事項

開発者コンソールを使用して作成されたWebhookは、ユーザーのアカウント内のすべてのファイルとフォルダに対する変更を監視します。このようなWebhookを作成する際は、Webhookをバインドする特定のオブジェクトを指定することはできません。

単一のファイルまたはフォルダにWebhookを作成するには、WebhookのAPIを使用してください。

このプロセスで作成されたWebhookは、ユーザーのすべてのWebhookのリストを作成しても表示されません。

V1 Webhookの作成

開発者コンソールを使用して新しいWebhookを作成するには、以下の手順に従います。

  1. 開発者コンソールに移動し、Webhookを追加するアプリを選択します。
  2. サイドバーから[Webhook]を選択します。
  3. [新規Webhookの作成]ボタンをクリックします。
  4. フォームに入力してWebhookを作成し、フォームを保存します。Webhookが呼び出すエンドポイントURLを必ず入力します。また、1つ以上のコールバックパラメータとWebhookに追加するデータも必ず選択します。
  5. アプリのインストールURL https://[enterprise_name].app.box.com/services/[service_short_name]にアクセスします。ここで、enterprise_nameは会社のサブドメインであり、Boxウェブアプリにアクセスして、ブラウザがリダイレクトされるドメインを調べることで確認できます。service_short_nameは、アプリケーションの名前をすべて小文字にし、英数字以外の文字をアンダースコアに置き換えたものです。たとえば、Your App Name [Dev]your_app_name_devになります。

コールバックパラメータ

V2 Webhookとは異なり、これらの手動によるWebhookは、送信するデータを設定する必要があります。このデータは、本文のクエリ文字列として、またはname=Contract.pdf&type=fileのようなクエリパラメータとして送信されます。

これで、ユーザーのアカウント内のオブジェクトで発生したイベントに対してWebhookがトリガーされるようになりました。

開発者モード

デフォルトでは、V1 Webhookは、アプリケーションの開発者であり、開発者コンソールでアプリにアクセスできるユーザーに対してのみ機能します。これらのWebhookをすべてのユーザーに対して有効にするには、サポートにお問い合わせください。