Webhookを使ってみよう

目次

Webhookとは

Webhookは、特定の動作をきっかけに、サービス上の情報を他のサービスに通知できるしくみです。
kintoneのWebhookでは、たとえば、レコードの追加をしたときに、追加したレコードの内容を他のサービスに通知できます。

kintone REST APIとWebhookのどちらを利用しても、外部サービスがレコードの情報を取得できますが、両者には違いがあります。
それは、「情報のやりとりがうまれるきっかけ」です。

kintone REST APIで情報のやりとりが生まれるきっかけは、「kintone REST APIを実行したとき」です。
外部サービス側からkintone REST APIを実行し、レコードを取得します。
対して、kintone Webhookにおける情報のやりとりが生まれるきっかけは、「kintoneが操作されたとき」です。
Webhookでは、kintoneでレコードを追加したとき、kintone側から外部サービスにレコードデータが送信されます。

このように、kintone REST APIでは「情報の取得側」がきっかけを作るのに対し、Webhookでは「情報の通知側」がきっかけを作ります。

それでは、Webhookの動作について、実際にkintoneで確認してみましょう。

kintoneのWebhookを使ってみよう

Webhookの通知を簡単に受信できるサービス「webhook.site」とkintoneを使って、Webhookの動作を体感してみます。

1. Webhookの送信先となるURLを発行する

webhook.site (External link) にアクセスし、kintoneの情報を通知するURLを発行します。
Copy to clipboardをクリックして、発行したURLをコピーします。

2. kintoneでWebhookを設定する

kintoneアプリ設定の「Webhook」にて、通知先のURLと「通知を送信する条件」を設定します。

URLはwebhook.siteで発行したURLを指定します。
今回は、通知を送信する条件として「レコードの追加」にチェックを入れます。
設定を保存したら【アプリの更新】を忘れずクリックしましょう。

3. Webhookの通知を確認する

kintoneのアプリにレコードを登録すると、webhook.siteにアプリやレコードの情報が通知されます。

Webhookの使いどころと注意点

Webhookを利用することで、kintoneの操作をきっかけとした外部サービス連携が可能になります。
たとえば、プロセス管理のステータスが更新されたらSlackにメッセージを送信したり、kintoneにレコード登録した内容を自動でGoogle SpreadSheetに登録したり、といった使い方が考えられますね。

kintoneが対応している「通知を送信する条件」は、次のとおりです。ブラウザーの画面上の操作だけでなく、kintone REST APIによる操作でも通知されます。

  • レコードの追加
  • レコードの編集
  • レコードの削除
  • コメントの書き込み
  • ステータスの更新

主な注意点として、kintoneでWebhookを送信できるのは、1分間に60回までです。
kintoneの操作で送信されるWebhookの通知内容の詳細は、 kintoneの操作で送信されるWebhookの通知内容 (External link) を参照してください。

まとめ

これにて、はじめようkintone APIは終了です。
今まで学んだことをもとに、ドキュメントやTipsを活用して理解を深めてください。
困ったときはコミュニティで質問をしたり、困っている人の手助けをしたりして、さらにカスタマイズ力を磨いていきましょう。