Webhookを設定する

記事番号:040600

kintoneでWebhookを利用すると、kintoneのアプリで特定の操作が行われた際に、その内容を指定した外部サービスに送信します。
たとえば、レコードが追加されたときにその内容をチャットサービスに投稿する、といった連携を、プログラムを書くことなく設定できます。

Webhookの仕組み

Webhookの連携先として、多数のサービスとの連携を支援してくれるツールを指定すると、それらが対応しているさまざまなサービスとkintoneを連携できます。
連携を支援してくれるツールとしては、Zapier、Microsoft Power Automate、IFTTTなどがあります。

イラスト：Webhookの仕組み

Webhookの設定を行うと、kintoneのアプリで以下の操作が行われた際に通知が送信されます。

  • レコードの追加
  • レコードの編集
  • レコードの削除
  • コメントの書き込み
  • ステータスの更新（プロセス管理のステータスが更新されたとき）

kintoneで操作を行ったときの通知のパラメーターについては、「kintoneの操作で送信されるWebhookの通知内容」を参照してください。

Webhookの設定の流れ

Webhookは次の手順で設定します。

(1) 連携支援ツール（Zapierなど）でトリガーを設定する
(2) kintoneでWebhookを設定する
(3) 連携支援ツールでアクションの設定をする

設定例

ここではZapierを使って、「kintoneにレコードが追加されたらGmailに通知する」設定例を説明します。

事前準備

Webhookの連携設定を行う前に、次の準備を行ってください。

  • Gmailアカウントの作成
  • kintoneのアプリを作成

準備ができたら、次の設定を行います。

(1) Zapierでトリガーを設定する

  1. 「Zapier」のWebサイトにアクセスし、サインアップします。
    Zapierのアカウントがない場合は、新規作成するか、またはGoogleアカウントなどでサインアップしてください。

  2. ZapierのWebサイトにある[Create Zap]をクリックします。

  3. トリガー選択画面で、検索ボックスに「Webhook」と入力し、[Webhooks by Zapier]をクリックします。 スクリーンショット：Webhookのトリガーを選択している

  4. 「Event」で[Catch Hook]を選択し、[Continue]をクリックします。 スクリーンショット：[Catch Hook]を選択している

  5. 次に表示される画面も、そのまま[Continue]をクリックします。 スクリーンショット：Eventを選択したあとの画面が表示されている

  6. Webhook URL が生成されるので、[Copy]をクリックします。
    テキストエディターなどに、URLをペーストしておいてください。 スクリーンショット：[Copy]を枠線で強調している

次にkintoneでWebhookを設定します。ZapierのWebページはそのまま開いておいてください。

(2) kintoneでWebhookを設定する

  1. 「レコードの一覧」画面で、画面右上にある歯車の形をした[アプリを設定]アイコンをクリックします。
    スクリーンショット：[アプリを設定]アイコンが枠線で強調されている

  2. 「アプリの設定」画面で、[設定]タブの「カスタマイズ／サービス連携」にある[Webhook]をクリックします。

  3. 「Webhook」画面で、[追加する]をクリックします。

  4. 「Webhookの追加」画面で、設定するWebhookの説明を入力します。
    入力した説明はWebhookの設定の一覧画面に表示されます。64文字まで入力できます。

  5. 「Webhook URL」に、「Zapierでトリガーを設定する」の手順6でコピーしたURLをペーストします。
    ペーストしたURLの先頭にある「https://」は不要なため、削除してください。
    URL欄には最大1,024文字まで入力できます。 スクリーンショット：「Webhookの追加」画面が表示されている

  6. 「通知を送信する条件」で、Webhookの通知を送信する操作を指定します。
    ここでは、[レコードの追加]にチェックを入れます。 スクリーンショット：「通知を送信する条件」が表示されている

  7. 「このWebhookを有効にする」にチェックを入れます。
    初期設定ではチェックが入っています。

  8. 画面右下の[保存]をクリックします。

  9. 「Webhook」画面で、画面上部に表示されるメッセージの[アプリの設定]をクリックするか、画面左下の[アプリの設定に戻る]をクリックします。

  10. 「アプリの設定」画面で、[アプリを更新]をクリックします。

  11. 「アプリを更新」ダイアログで、[アプリを更新]をクリックします。

  12. Zapierで設定したトリガーのテストを行うため、kintoneのアプリに新規でレコード追加します。

  13. ZapierのWebサイトに戻り、[Test trigger]をクリックします。
    スクリーンショット：[Test trigger]が表示された画面

  14. テストが成功したことを確認して、[Continue]をクリックします。
    テストが成功しない場合は、何度か[Test trigger]を試してください。
    それでも失敗する場合、Webhook URLにコピー＆ペーストしたURLに誤りがないかなど、確認してください。

(3) Zapierでアクションの設定をする

  1. Zapierのアクションの設定が表示されるので、[Gmail]を選択します。
    スクリーンショット：[Gmail]が枠線で強調されている

  2. アクションイベント画面で、「Event」に[Send Email]を選択し、[Continue]をクリックします。
    スクリーンショット：「Event」に[Send Email]が選択されている

  3. Gmailアカウントを選択し、[Continue]をクリックします。
    Gmailにログインしていない場合は、Gmailへのログイン許可を確認する画面が表示されます。 スクリーンショット：Gmailのアカウントを選択している

  4. Gmailに通知される内容を設定します。
    「To」に受信するGmailアドレスを入力し、Subject、Bodyなど必要な内容を設定したあと[Continue]をクリックします。
    スクリーンショット：Gmailに通知する内容を設定している

  5. 設定内容を確認し、[Test & continue]をクリックします。

  6. [Publish Zap]をクリックします。

  7. 宛先のGmailにメールが届いたことを確認し、[Publish & Turn On]をクリックします。

設定したZapが有効になりました。

kintoneのWebhookの設定を変更する

kintoneのWebhookの設定内容をあとから変更できます。手順は、次のとおりです。

  1. 「レコードの一覧」画面で、画面右上にある歯車の形をした[アプリを設定]アイコンをクリックします。
    スクリーンショット：[アプリを設定]アイコンが枠線で強調されている

  2. 「アプリの設定」画面で、[設定]タブの「カスタマイズ／サービス連携」にある[Webhook]をクリックします。

  3. 「Webhook」画面で、設定を変更したいWebhookの一番右の列の[編集]アイコンをクリックします。
    スクリーンショット：[編集]を枠線で強調している

  4. 「Webhookの編集」画面で、設定内容を編集し、[保存]をクリックします。

  5. 「Webhook」画面で、画面上部に表示されるメッセージの[アプリの設定]をクリックするか、画面左下の[アプリの設定に戻る]をクリックします。

  6. 「アプリの設定」画面で、[アプリを更新]をクリックします。

  7. 「アプリを更新」ダイアログで、[アプリを更新]をクリックします。