Webhookの削除
Webhookの削除
Box上のファイルやフォルダからWebhookを削除するには、削除するWebhookのIDをAPIに渡す必要があります。
cURL
curl -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")
}
その他の削除の理由
APIを使用していなくても、Webhookが削除される場合があります。
Webhookは以下の理由で削除される可能性があります。
- Boxアプリケーションを削除すると、アプリケーションに関連付けられているすべてのWebhookが削除されます。
- Webhookに関連付けられているすべてのアクセストークンを削除した場合。
- システムで決められている時間内にWebhookを配信できなかった場合、BoxによってそのWebhookが自動的に削除されます。
これらのすべてのケースで、BoxはWEBHOOK.DELETED
イベント名を含むWebhookペイロードを通知URLに送信します。この場合、ペイロードの本体には以下の追加情報が含まれます。
"additional_info": {
"reason": "auto_cleanup"
}