Job Runner

Webhook から渡されたレコードを取得する

概要

kintone Webhook から渡されたレコードを取得します。

使い方

kintone Webhook では、kintone から Webhook へ通知する内容に、その通知を発生させたレコードの内容か、またはレコードIDが含まれます。「Webhook から渡されたレコードを取得する」ではそのレコード内容を取得し、後続のアクションで使用できるようにします。

通知の元になった操作が「レコードの追加」「レコードの編集」「プロセス管理のステータスの更新」のいずれかであった場合は、特に事前の設定なしでレコードを取得できます。

「コメントの書き込み」の場合は、事前に「kintone 接続設定を行う」を行って、元のアプリからレコードを取得するための接続設定を行っておく必要があります。

kintone 標準の Webhook 起動方法でなく、kintone アプリのカスタマイズから「kintone Webhook を起動する」を使用して Webhook を起動した場合、レコードが複数あるかどうかで変わります。

「レコードの削除」の場合は取得できません。この場合、ジョブの実行時にエラーになります。

まとめると、以下のようになります。

通知の元になった操作 事前設定
レコードの追加 不要
レコードの編集 不要
レコードの削除 非対応
コメントの書き込み kintone 接続設定を行う」が必要
プロセス管理のステータスの更新 不要
「kintone Webhook を起動する」 複数レコードであれば「kintone 接続設定を行う」が必要。1レコードであれば不要

設定するパラメーター

パラメーターはありません。

レコード取得条件の発生有無

条件 発生有無
レコード1行が準備できた時 発生します
レコード全行が準備できた時 発生します

複数レコードの取得について

kintone 標準の Webhook では、一回の呼び出しでレコードは1行分が渡され、複数行が一度に送られることはありません。従って、kintone 標準の方法で Webhook を起動した場合、「Webhook から渡されたレコードを取得する」で取得できるレコードは高々1行となります。

一方、Customine で作成した kintone カスタマイズで「kintone Webhook を起動する」を使用すると、複数のレコードをまとめて Webhook に渡すことが可能です。この場合、「Webhook から渡されたレコードを取得する」は渡された複数行をすべて取得できます。その際「レコード1行が準備できた時」は複数行それぞれに対して発生します。

複数のレコードを受け取る場合、kintone カスタマイズ側のバージョンが 1.132(2021年5月20日リリース)以降であれば、Webhook のカスタマイズ側で「Webhook から渡されたレコードを取得する」を実行する前に、「kintone 接続設定を行う」を行っておく必要があります。これは Webhook 側からあらためて kintone のレコードを取りに行くためです。

制限事項

  • 通知の元になった操作が「レコードの削除」であった場合は取得できません。この場合、ジョブの実行時にエラーになります。

  • Webhook の発生条件が「コメントの書き込み」であった場合、Webhook 発生からジョブが起動される前の間にそのレコードが削除されてしまっている場合、レコードは取得できません。この場合、エラーにはなりませんが、「レコード1行が準備できた時」も「レコード全行が準備できた時」も発生しません。

  • 定期実行タスクでは使用できません。

関連記事