メインコンテンツへスキップ

ワークフロー設定

Webhookトリガー

Webhookでは、作成したURLを対象のアプリケーションへ設定することで、任意のトリガーと連携して自動的にワークフローを実行することができます。こちらの機能を使用してアプリケーションのイベントやjobの前後などにワークフローを実行することもできます。

使用方法

Webhook URLの作成

1　ワークフロー一覧画面から定期的に実行させたいワークフローをクリックし、ワークフローの詳細が表示される画面を開きます。その後、右上のWebhoookアイコンをクリックします。
01.png
2　トリガーを作成をクリックします。
02.png
3　URLの確認
03.png
このURLにPOSTリクエストを送信するとワークフローが実行されます。このURLが漏れてしまうとワークフローが実行できてしまうため、URLをの取り扱いにはご注意ください。
※ワークフロー実行は、1つのワークフローにつき、15分間に1回の実行制限がございます
POSTリクエスト例
curl -X POST https://hooks.reckoner-api.com/api/v2/workflows/xxxx/run/xxxxxxxxxxxxxxxxxxx
※Content-lengthが不足しているエラーが出た場合は「-H "Content-Length: 0"」を追加してください

URLの削除

1　「・・・」をクリックし、削除を選択します。

04.png
削除済みのURLにPOSTリクエストを送信してもワークフローは実行されません。一回削除したURLは戻せないですが、作成ボタンをクリックしたら再作成ができます。再作成の場合、URLが変わりますのでご注意ください。
実行履歴の確認
1　実行履歴をクリックします。
05.png
2　Webhookにて実行されたJobは実行方法が「Webhook」となっています
06.png

パラメーター変数の更新

Webhook実行時のリクエストボディに設定するパラメータをJSON形式で定義し、更新することができます。

リクエスト例（curl）

curl --request POST \
 --url https://hooks.dev-reckoner-api.com/api/v2/workflows/xxxx/run/xxxxx \
 --header 'content-type: application/json' \
 --data '{"parameters": [{"key": "変数1","value": "設定する値"},{"key": "変数2","value": "設定する値"}]}'

パラメータ例

{
 "parameters": [
  {
   "key": "変数1",
   "value": "xxxx.csv"
  }, 
  {
   "key": "変数2",
   "value": "accesskey-xxxxxxxxx"
   }
 ]
}
キー   型 詳細
parameters   array of objects 更新するパラメータ名と値のリストを定義します
  key string ワークフローで設定した変数名を設定します
  value string 変数の値を設定します

制限事項

  • 変数に設定する値は文字列形式で設定する必要があります
  • CURRENT_DATEなどのパラメータ関数を設定した場合、関数を実行後の値が設定されます
  • valueを定義しない、あるいはvalueに空文字（""）を設定した場合、変数は更新されません
    • 例: { "key": "変数1", "value": ""} , { "key": "変数1"}
  • ワークフローに設定されていないパラメータ変数をWebhook実行時のJSONボディ内に設定した場合もワークフローは実行されます
  • Webhook実行時のリクエストボディがJSONとして解釈できない場合はエラーとなり、ワークフローは実行されません。ワークフローの実行履歴にも残りません。