Box Developer Blog
Published in

Box Developer Blog

新機能: 開発者コンソールのV2 Webhook

先週木曜日、Box Platformでは、非常に多くの開発者から要望されていたWebhookサービスの機能強化をリリースしました。これにより、開発者コンソールで直接、V2 Webhookを作成、更新、削除できるようになりました。

あまり詳しくないユーザー向けに説明すると、Webhookでは、Boxコンテンツでイベントを監視し、イベントが発生した場合に任意のURLに対する通知を受信できます。例えば、ワークフローで、ファイルがダウンロードされるまで待ってから共有リンクを削除する場合、Webhookをファイルに設定することができ、ダウンロードイベントの通知時に、スクリプトで共有リンクを削除するAPI呼び出しを開始するようにできます。

Webhookのフロー

前提条件

  • カスタムアプリケーションを作成するか作成済みであることが必要になります。
  • 新しいアプリケーションの場合は、実際に使用する前に、Boxプライマリ管理者に対して承認するよう求めることが必要になる場合があります。
  • アプリケーションでは、[Webhookを管理する] というアプリケーションスコープを選択しておく必要があります。
アプリケーションスコープの設定

Webhookの管理

既存のアプリケーションを使用していて、以前にWebhookを作成済みの場合は、V2またはV1の下にWebhookが一覧表示されます。V1とV2の違いについては、こちらの表を参照してください。

Webhookの構成画面

Webhookの作成

Webhookを作成する前に、署名キーを作成したいと考えます。署名キーが強く推奨される理由については多くの情報がこちらに記載されていますが、要約すると、Webhook署名は、Boxから送信されたWebhookペイロードが送信中に改ざんされていないことを確認するために役立ちます。

[署名キーを管理] をクリックします。

[署名キーを管理]

まだ作成していない場合は、[キーを生成] をクリックします。また、キーをローテーションする場合は、[リセット] をクリックできます。

署名キーの管理

メインのWebhook画面に戻り、[Webhookを作成] > [V2] をクリックします。

V2 Webhookの作成

テキストボックスにURLアドレスを貼り付けます。この例では、webhook.siteのURLアドレスを使用します。

Webhookをトリガーする対象となるコンテンツを選択します。V2では、ルートフォルダを使用できません。

最後に、Webhookを起動するトリガーをすべて選択します。

Webhookの構成

URLのサービスが受け取る情報の例を以下に示します。ヘッダーにある署名キーに注目してください。レスポンス全体は、こちらで確認できます。

Webhookのテスト

Webhookの編集

以前作成したWebhookを編集するには、IDをクリックした後、[Webhookを編集] をクリックします。これにより、Webhookの構成画面が再度表示され、URLやトリガーを変更できます。

Webhookを削除することもできますが、元に戻すことはできないのでご注意ください。また、Webhookが削除されるその他の理由については、Webhookに関する開発者用ドキュメントのこちらのセクションも確認してください。

Webhookの選択
Webhookの編集

この新しいリリースをぜひご利用ください。質問がある場合は、Boxの開発者向けフォーラムに英語で投稿してください。また、Webhookに関するリクエストがある場合は、Box Pulseに英語で投稿してください。

--

--

News and stories for working with the Box APIs

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store