📦

BoxにWebhookを登録する

2022/01/20に公開約1,000字

この記事はBoxにwebhookを登録する際の忘備録です。

BoxCLIの環境構築についてはこちら

https://zenn.dev/rabbit/articles/5c13befec9c01e

CLIが正常に接続されているか確認

box users:get me
# Type: user
# ID: xxxxxxxxxx
# Name: xxxxxxxxxx
# Login: AutomationUser_xxxxxxxxxx

user情報が表示されれば正常です。

webhookのトリガーを設定する。

今回は、webhook.site を利用してwebhookのイベントを受け取っていきます。
ユニークなwebhook用のURLを生成してくれるサービスです。非常に便利です。

https://webhook.site/

フォルダが作成されたことをトリガーにwebhookが実行されるようにCLIから登録します。
--addressにはwebhook.siteで生成されたURLを渡します。

box webhooks:create folder <folder_id> --triggers FOLDER.CREATED --address https://webhook.site/xxxxxxxxxx

box webhooks コマンドについて

https://github.com/box/boxcli/blob/main/docs/webhooks.md

Webhookイベントトリガー一覧

https://ja.developer.box.com/guides/webhooks/triggers/

実際にwebhookが登録されているか確認する。

先ほど、指定したfolder_idのフォルダ内にフォルダを作成すると、webhook.siteにリクエストが飛んできます。🎉

これで、BoxにWebhookを登録することができました。
開発前にどういったパラメーターが飛んできているのかもわかるので考慮しながら開発を進めることができて大変良いですね。😊

Discussion

ログインするとコメントできます