Webhookアクション（Webhook action）

Watcher webhook action

webhook アクションを使用して、任意のウェブサービスにリクエストを送信します。Webhook アクションは、HTTP および HTTPS 接続の両方をサポートしています。サポートされている属性については、Webhook アクション属性を参照してください。

Configuring webhook actions

actions 配列で webhook アクションを構成します。アクション固有の属性は、webhook キーワードを使用して指定されます。

次のスニペットは、シンプルな webhook アクションの定義を示しています:

Js

"actions" : {
  "my_webhook" : {
   "transform" : { ... },
   "throttle_period" : "5m",
   "webhook" : {
   "method" : "POST",
   "host" : "mylisteningserver",
   "port" : 9200,
   "path": "/{{ctx.watch_id}}",
   "body" : "{{ctx.watch_id}}:{{ctx.payload.hits.total}}"
   }
  }
}

セキュリティで保護されたウェブサービスにリクエストを送信する際に、基本認証を使用できます。たとえば、次の webhook アクションは、GitHub に新しい問題を作成します:

Js

"actions" : {
  "create_github_issue" : {
   "transform": {
   "script": "return ['title':'Found errors in \\'contact.html\\'', 'body' : 'Found ' + ctx.payload.hits.total + ' errors in the last 5 minutes', 'assignee' : 'web-admin', 'labels' : ['bug','sev2']]"
   },
   "webhook" : {
   "method" : "POST",
   "url" : "https://api.github.com/repos/<owner>/<repo>/issues",
   "body": "{{#toJson}}ctx.payload{{/toJson}}",
   "auth" : {
   "basic" : {
   "username" : "<username>",
   "password" : "<password>"
   }
   }
   }
  }
}

デフォルトでは、ユーザー名とパスワードは .watches インデックスにプレーンテキストで保存されます。Elasticsearch のセキュリティ機能が有効になっている場合、Watcher はパスワードを保存する前に暗号化できます。

Elasticsearch のセキュリティ機能が有効になっているクラスターにリクエストを送信する際に、PKI ベースの認証を使用することもできます。HTTP 基本認証の代わりに PKI ベースの認証を使用する場合、ウォッチ自体に認証情報を保存する必要はありません。PKI ベースの認証を使用するには、elasticsearch.yml で Watcher の SSL キー設定を 構成します。

Query Parameters

params フィールドを使用してリクエストと共に送信するクエリパラメータを指定できます。このフィールドは、キーがパラメータ名、値がパラメータ値として機能するオブジェクトを保持します:

Js

"actions" : {
  "my_webhook" : {
   "webhook" : {
   "method" : "POST",
   "host" : "mylisteningserver",
   "port" : 9200,
   "path": "/alert",
   "params" : {
   "watch_id" : "{{ctx.watch_id}}"
   }
   }
  }
}

Custom Request Headers

headers フィールドを使用してリクエストと共に送信するリクエストヘッダーを指定できます。このフィールドは、キーがヘッダー名、値がヘッダー値として機能するオブジェクトを保持します:

Js

"actions" : {
  "my_webhook" : {
   "webhook" : {
   "method" : "POST",
   "host" : "mylisteningserver",
   "port" : 9200,
   "path": "/alert/{{ctx.watch_id}}",
   "headers" : {
   "Content-Type" : "application/yaml"
   },
   "body" : "count: {{ctx.payload.hits.total}}"
   }
  }
}

Webhook action attributes