はじめよう kintone API

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 を活用して理解を深めてください。
困ったときはコミュニティで質問をしたり、困っている人の手助けをしたりして、さらにカスタマイズ力を磨いていきましょう。