Webhookの削除

Webhookの削除

Webhookは、開発者コンソールまたはAPIを使用して削除できます。

開発者コンソール

Webhookを削除するには、以下の手順に従います。

  1. 開発者コンソールで、[Webhook] タブに移動します。
  2. WebhookのIDをクリックして、削除するWebhookを選択します。
  3. [削除] ボタンをクリックします。
  4. 警告メッセージの下に表示される [削除] をクリックして、操作を確定します。

API

ファイルやフォルダからWebhookを削除するには、WebhookのIDを指定してWebhookを削除エンドポイントを使用する必要があります。この値は、すべてのWebhookのリストを取得エンドポイントを使用して取得できます。

cURL
curl -i -X DELETE "https://api.box.com/2.0/webhooks/3321123" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
.NET
await client.WebhooksManager.DeleteWebhookAsync("11111");
Python
client.webhook(webhook_id='12345').delete()
print('The webhook was successfully deleted!')
Node
client.webhooks.delete('1234')
	.then(() => {
		// deletion succeeded — no value returned
	});
iOS
client.webhooks.delete(webhookId: "22222") { result: Result<Void, BoxSDKError>} in
    guard case .success = result else {
        print("Error deleting webhook")
        return
    }

    print("Webhook successfully deleted")
}

Webhookの自動削除

このエンドポイントを使用していなくても、Webhookが削除される場合があります。

Webhookは以下の理由で削除される可能性があります。

  • Boxアプリケーションを削除すると、そのアプリケーションに関連付けられているすべてのWebhookが自動的に削除されます。

  • Webhookに関連付けられているアクティブなアクセストークンをすべて削除すると、そのWebhookが自動的に削除されます。これには、開発者トークンとパスワードが含まれます。

  • 最後に成功した通知が設定したURLに配信されてから30日が経過し、最後に通知の配信が成功した日からユーザーが最後にイベントをトリガーした日までの期間が14日を超えた場合。

    ユーザーがファイルをダウンロードするシナリオを見てみましょう。この操作により、Webhookがトリガーされ、設定したURLを使用して共有リンクを削除します。次の図では、このシナリオを表し、Webhookが削除されるタイミングを示しています。

    Webhookの削除

    • ユーザーイベントトリガー: ユーザーがイベント (例: ファイルのダウンロード) を開始したタイミング。
    • 通知トリガー: ファイルがダウンロードされたことを示す通知がWebhookに送信されたタイミング。
    • 最終の通知配信: Webhookが特定のURLにメッセージ (共有リンクの削除など) を送信したタイミング。

これらのすべてのケースで、BoxはWEBHOOK.DELETEDというイベント名を含むWebhookペイロードを通知URLに送信します。ペイロードの本文には以下の追加情報が含まれます。

"additional_info": {
  "reason": "auto_cleanup"
}