Webhookを設定する
kintoneでWebhookを利用すると、kintoneのアプリで特定の操作が行われた際に、その内容を指定した外部サービスに送信することができます。
たとえば、レコードが追加されたときにその内容をチャットサービスに投稿する、といった連携を、プログラムを書くことなく設定することが可能です。
Webhookは、kintoneスタンダードコースでのみ利用できます。
Webhookの仕組み
Webhookの連携先として、多数のサービスとの連携を支援してくれるツールを指定すると、それらが対応しているさまざまなサービスとkintoneを連携することができます。
連携を支援してくれるツールとしては、Zapier、Microsoft Power Automate、IFTTTなどがあります。
Webhookの設定を行うと、kintoneのアプリで以下の操作が行われた際に通知が送信されます。
- レコードの追加
- レコードの編集
- レコードの削除
- コメントの書き込み
- ステータスの更新(プロセス管理のステータスが更新されたとき)
kintoneで操作を行ったときの通知のパラメーターについては、kintoneの操作で送信されるWebhookの通知内容を参照してください。
設定例
ここではZapierを使って、「kintoneにレコードが追加されたらGmailに通知する」設定例を説明します。
事前準備
Webhookの連携設定を行う前に、次の準備を行ってください。
- Gmailアカウントの作成
- kintoneのアプリを作成
準備ができたら、次の設定を行います。
Zapierでトリガーを設定する
-
ZapierのWebサイトにアクセスし、サインアップします。
Zapierのアカウントがない場合は、新規作成するか、またはGoogleアカウントなどでサインアップしてください。 -
ZapierのWebサイトにある[MAKE A ZAP]をクリックします。
-
「Name your zap」に任意のタイトルを入力します。
-
トリガー選択画面で、検索ボックスに「Webhook」と入力し、「Webhooks by Zapier」をクリックします。
-
トリガーイベントで「Catch Hook」を選択し、[CONTINUE]をクリックします。
-
Custom Webhook URL が生成されるので、[Copy]をクリックします。
テキストエディターなどに、URLをペーストしておいてください。
kintoneでWebhookを設定する
-
kintoneでWebhookの設定画面を開きます。
レコード一覧画面の右上にあるアプリ設定ボタンをクリックし、「設定」タブの「カスタマイズ/サービス連携」にある[Webhook]を選択します。
-
追加ボタン
をクリックします。
-
設定するWebhookの説明を入力します。
入力した説明はWebhookの設定の一覧画面に表示されます。64文字まで入力できます。 -
Webhook URLに、Zapierでトリガーを設定するの手順6でコピーしたURLをペーストします。 ペーストしたURLの先頭にある「https://」は不要なため、削除します。
URL欄には最大1,024文字まで入力できます。 -
通知を送信する条件では、Webhookの通知を送信する操作を指定します。
ここでは、「レコードの追加」にチェックを付けます。 -
設定したWebhookを有効にするかどうかを選択します。初期設定では有効です。
-
[保存]をクリックします。
-
Webhookの設定画面右下の[アプリの設定に戻る]をクリックします。
-
アプリの設定画面右上の[アプリを更新]をクリックし、[OK]をクリックします。
-
Zapierで設定したトリガーのテストを行うため、kintoneのアプリに新規でレコード追加します。
-
ZapierのWebサイトに戻り、[CONTINUE]をクリックして、[Test trigger]をクリックします。
-
テストが成功したことを確認して、[CONTINUE]をクリックします。
テストが成功しない場合は、何度か[Test trigger]を試してください。
それでも失敗する場合、Webhook URLにコピー&ペーストしたURLに誤りがないかなど、確認してください。
Zapierでアクションの設定をする
-
Zapierのアクションの設定が表示されるので、Gmailを選択します。
-
アクションイベントで「Send Email」を選択し、[CONTINUE]をクリックします。
-
Gmailアカウントを選択し、[CONTINUE]をクリックします。
Gmailにログインしていない場合は、Gmailへのログイン許可を確認する画面が表示されます。 -
Gmailに通知される内容を設定します。「To」に受信するGmailアドレスを入力し、Subject、Bodyなど必要な内容を設定します。
設定後、[CONTINUE]をクリックします。
-
設定内容を確認し、[TEST & CONTINUE]をクリックします。
-
宛先のGmailにメールが届いたことを確認し、[TURN ON ZAP]をクリックします。
-
設定したZapをONにして有効にします。
kintoneのWebhookの設定を変更する
kintoneのWebhookの設定内容をあとから変更する手順は次のとおりです。
-
設定を変更したいWebhookの編集ボタン
をクリックします。
-
Webhookの設定画面右下の[アプリの設定に戻る]をクリックします。
-
アプリの設定画面右上の[アプリを更新]をクリックし、[OK]をクリックします。
kintoneのWebhookの設定を削除する
kintoneのWebhookの設定を削除する手順は次のとおりです。
- 削除したいWebhookの削除ボタン
をクリックして、[削除する]をクリックします。
- Webhookの設定画面右下の[アプリの設定に戻る]をクリックします。
- アプリの設定画面右上の[アプリを更新]をクリックし、[OK]をクリックします。
Webhookの利用を禁止する(cybozu.com共通管理者の操作)
Webhookの利用を許可したくない場合や利用予定がない場合などは、cybozu.com共通管理者はWebhookの利用を禁止することができます。
Webhookの利用を禁止すると、すべてのアプリの設定画面で[Webhook]のメニューが表示されなくなり、Webhookの追加・閲覧・編集ができなくなります。また、設定済みのWebhookの通知は送信されなくなります。
Webhookの利用を禁止する手順は、Webhookの送信を制御するのページを参照してください。