kintone(キントーン)のWebhookで外部サービス連携

こんにちは。kintone(キントーン)導入支援のギャンです。
今回は「kintone(キントーン)のWebhookで外部サービス連携」ということで、kintoneのWebhookを使った外部サービス連携についてまとめてみました。

Webhookとは

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

Webhookの仕組み

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

Webhookの連携先の連携を支援してくれるツール

連携を支援してくれるツールとしては、ZapierMicrosoft Power AutomateIFTTTYoomなどがあります。以下にそれぞれのツールをご紹介いたします。

Zaiper(ザピアー)

Zapierは3,000種類以上のアプリを連携させ、さまざまな業務を自動化・効率化できるアメリカ発のノーコードツールです。自動化サービス(iPaaS)としては世界シェアNo1です。無料プランもあります。英語版のみで日本語版はありません。

Microsoft Power Automate

Microsoft Power Automateはマイクロソフトが提供する業務の自動化ツールで、ノーコードでパソコン業務を自動化できます。日本語対応しています。デスクトップ版は無料ですが、クラウド版は有料です。

IFTTT(イフト)

FTTTは、アメリカ発のインターネット上のさまざまなプラットフォームやソーシャルメディアを連携することが可能なサービスです。EmailやSMSのほか、Gmail、YouTube、Facebook、Instagramなどの人気サービスも利用することができます。無料プランもあります。日本語版はありません。

Yoom(ユーム)

Yoomは様々なSaaSと連携した、独自の業務ツールを作成できる日本発のノーコードプラットフォームです。 フロントオフィスからバックオフィスまで、様々な部門で業務の自動化・効率化を実現します。無料プランがあります。

アプリの操作が行われるとWebhookが通知を送信

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

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

なお、次の方法でレコードを操作した場合は、Webhookの通知は送信されませんので、注意が必要です。

  • Excel/CSVファイルを読み込んでレコードを操作する
  • 複数のレコードを一括削除する
  • 複数のレコードを一括操作するREST APIを使用してレコードを操作する

Webhookの設定

Webhookは次の流れで設定します。

1.連携支援ツール(Zapierなど)でトリガーを設定する

Zaiperの場合、以下の手順になります。

①ログインして「Zap(連携設定)」を作成します。
②トリガー選択画面で、検索ボックスに「Webhook」と入力し「Webhooks by Zapier」をクリックします。
③「Event」で「Catch Hook」を選択し、[Continue]をクリックし、次の画面でも[Continue]をクリックします。
④Webhook URL が生成されるので、[Copy]をクリックしテキストエディターなどに、URLをペーストしておきます。

2.kintoneでWebhookを設定する

①kintoneアプリの設定画面を表示し、「設定」タブの「カスタマイズ/サービス連携」にある[Webhook]を選択します。
②[追加する]をクリックします。
③設定するWebhookの説明を入力します。
④Webhook URLに、ZaiperでコピーしたURLをペーストします。ペーストしたURLの先頭にある「https://」は不要なため、削除してください。
⑤通知を送信する条件では、Webhookの通知を送信する操作(レコードの追加など)を指定します。
⑥「このWebhookを有効にする」にチェックを付けて「保存」します。
⑦「アプリの設定」で「アプリを更新」します。

3.連携支援ツールでアクションの設定をする。

Zaiperの場合、以下の手順になります。

①アクションの設定で連携するアプリケーションを選択します。
②選択したアプリケーションのアクションイベントを選択します。
③アクションに必要な設定を行います。
④設定内容を確認し、[Test & continue]をクリックします。
⑤[Publish Zap]をクリックします。
⑥アクションが実行されたことを確認したら[Publish & Turn On]をクリックすることでZapが有効となります。

Webhookの設定の注意点

なお、Webhookは10個まで設定できます。また、Webhookの通知は、ドメイン単位で1分間に60回まで送信されます。1分間に60回を超えてレコードを操作すると、61回目以降の操作ではWebhookの通知が送信されませんのでご注意下さい。

WebhookでGmailに通知する例

cybozu developer networkに、Zaiperを利用し、kintone の Webhook で Gmail に通知する例が紹介されていますので、参考にして下さい。
コーディングなしで超簡単!kintone の Webhook で Gmail に通知する

kintoneのWebhookで外部サービス連携のまとめ

kintoneのWebhookを使うことで、ノーコードでkintoneと外部サービスを連携することができるようになりますので、大変便利です。例えばkintoneアプリにレコードが追加されるとチャットアプリにDMが届くといった使い方ができます。ぜひ、活用していただければと思います。