カスタマイズ

kintone Webhook を起動する

概要

Customine で作成した kintone Webhook を起動します。

実際の Webhook 発動条件を満たしていなくても起動することができます。

使い方

事前に Customine Job Runner の「kintone Webhook」カスタマイズを作成し、ジョブを生成しておきます。

また、gusuku の APIキーが必要になります。この APIキーは kintone アプリの APIトークンとは異なります。gusuku の APIキーは gusuku 共通管理画面から発行・取得することができます。

アクションを実行すると、指定されたカスタマイズの kintone Webhook を起動するように gusuku のサーバーに要求します。要求するのは生成済みのジョブを起動することのみで、ジョブの生成は行いません。

アクションは起動要求が伝わった時点で完了になります。要求された kintone Webhook がまだ実行中で終了していなくてもアクションは完了になります。例えば kintone Webhook が5分かかる処理内容だったとしても、起動要求が1秒で終われば、アクションは1秒で完了します。

この Webhook は kintone から発するものではなく Customine から疑似的に発生させるものです。従って、kintone の Webhook 設定画面中にある「Webhookログ」画面上には記録されません。代わりに Customine の実行履歴画面で確認できます。逆に、kintone アプリで Webhook 設定が行われていなくても、Customine からは起動可能です。

kintone Webhook 内でエラーが起こっても、kintone の画面側へは表示はされません。kintone Webhook 設定画面にもエラー履歴は残りません。Customine の実行履歴画面で、履歴やエラーを確認きます。

設定するパラメーター

「kintone Webhook のカスタマイズ」「gusuku APIキー」「操作の種類」「アプリ」「レコード」を設定します。

kintone Webhook のカスタマイズ

起動したい kintone Webhook のカスタマイズをリストから選択します。

表示されるのは kintone Webhook のカスタマイズのみで、定期実行タスクのカスタマイズはリストに表示されません。

gusuku APIキー

gusuku の APIキーを指定します。

kintone アプリの APIトークンのことではありませんので注意してください。

操作の種類

どの種類の操作が行われたことにするか?を「レコードを追加した」「レコードを編集した」「レコードのステータスを変更した」から選択します。

「レコードを削除した」「コメントを書き込んだ」には対応していません。

アプリ

どのアプリから Webhook が通知されたことにするか?を設定します。

通常は、「kintone Webhook のカスタマイズ」で選択したカスタマイズの対象アプリと同一アプリを選択してください。

レコード

Webhook に送るレコードデータを選択します。

選択したレコードの中にレコードが複数含まれる場合は、それらがまとめて1回で送られます。複数のレコードを渡して複数回の Webhook を一度に通知するということはできません。但し、一回のアクションで一度に送れるレコードは500レコードまでです。

選択したレコードの中にレコードが1行もなければエラーになります。

選択を省略すると、ユーザーが画面で開いているレコードが送られます。この時、レコードが1つに決まらない場合はエラーになります。

制限事項

  • Customine で作成したものでない kintone Webhook は起動できません。

  • 「レコードを削除した」「コメントを書き込んだ」には対応していません。

  • 標準の kintone Webhook で送信される通知の内容のうち、アプリ名(app.name)とレコードタイトル(recordTitle)は空文字列になります。

    • 標準の kintone Webhook で送信される通知の内容は、Cybozu 公式のヘルプ の「送信される通知の内容」項を参照してください。
  • kintone Webhook の処理が完了した時に発動する「条件」はありません。