Webhook後処理

概要

Webhook後処理は「ジョブの実行」または「ポリシーセットの評価」が完了した際に、その結果を任意のURLにてPOSTリクエストで受け取るための機能です。

Webhook後処理で送信される結果はJSON文字列となります。また、その際に Authorization ヘッダの値を通じて認証を行うこともできます。

設定項目

設定方法

1. サイドメニューの後処理設定から「後処理の追加」メニューを開きます。
   
2. 基本情報、Webhook通知設定に以下の項目を入力し、追加をクリックします
   

POSTリクエストを受け取る側の注意点

Webhook URLとして入力したURLは以下のように動作する必要があります。

ステータスコードとして 200番台 以外が返された場合は、Cloud Automator側のジョブログやポリシーログにおいてWebhook後処理の実行に失敗したものとして記録されます。

リクエストがCloud Automatorからのものであることを確認する必要がある場合は、 User-Agent ヘッダ の値が Cloud Automator (Serverworks Co.,Ltd.) となっているかどうかで判別することができます。

ネットワークの問題などでCloud AutomatorからWebhook URLへのリクエストに失敗した場合には一定間隔毎に10回まで送信を試み、それでも失敗した場合はWebhook後処理の実行に失敗したものとしてジョブログやポリシーログに記録します。

POSTリクエストの内容

Webhook URLに送信されるPOSTリクエストのリクエストボディは以下のような内容となります。

ジョブの後処理として設定した場合

[
  {
    "type": "job",
    "trigger_job_id": 10000,
    "trigger_job_log_id": 20000,
    "status": "completed",
    "name": "Job Name",
    "started_at": "2017-08-16T11:13:59Z",
    "finished_at": "2017-08-16T11:14:15Z"
  }
]

各プロパティの値は下記の通りです。

現時点ではJSONに含まれる実行結果は常に1件のみですが、将来的には複数の結果が含まれるように仕様が変更となる可能性があります。

ポリシーの後処理として設定した場合

[
  {
    "type": "policy",
    "status": "completed",
    "policy_set_name": "Policy Set Name",
    "rule_name": "Policy Name",
    "evaluations_time": "2017-08-16T11:13:59Z",
    "evaluations": [
      {
        "ResourceId": "AWS Resource ID",
        "ResourceName": "AWS Resource Name",
        "ComplianceType": "COMPLIANT",
        "ResultDetailCode": null
      }
    ]
  }
]

各プロパティの値は下記の通りです。

現時点ではJSONに含まれる評価結果は常に1件のみですが、将来的には複数の結果が含まれるように仕様が変更となる可能性があります。

Webhook後処理のテスト方法

作成したWebhook後処理の詳細ページに表示されている「テストリクエストを送信」ボタンを押すと、Webhook URLにテストリクエストを送信してその成否を確認することができます。

テストとして送信されるリクエストの内容は以下のような「ジョブの後処理として設定した場合」のものとなります。

[
  {
    "type": "job",
    "trigger_job_id": 1,
    "trigger_job_log_id": 8,
    "status": "completed",
    "name": "Job for Test Request",
    "started_at": "2017-10-01T09:00:00Z",
    "finished_at": "2017-10-01T09:01:00Z",
  }
]

関連情報

• Zapierを使ってジョブの実行完了時にDatadogと連携する(Webhook後処理)
• Webhook後処理：複数のジョブを連続実行する（EC2インスタンスのスケールアップ）