Skip to content

Commit

Permalink
Fix example usage for HTTP Post 2
Browse files Browse the repository at this point in the history
  • Loading branch information
lepouletsuisse committed Nov 1, 2021
1 parent 18affed commit dc4e752
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/source/ruletypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2210,7 +2210,7 @@ Example usage::
authorization: Basic 123dr3234

HTTP POST 2
~~~~~~~~~
~~~~~~~~~~~

This alert type will send results to a JSON endpoint using HTTP POST. The key names are configurable so this is compatible with almost any endpoint. By default, the JSON will contain all the items from the match, unless you specify http_post_payload, in which case it will only contain those items.
This alert is a more flexible version of the HTTP Post alerter.
Expand Down Expand Up @@ -2242,11 +2242,13 @@ Example usage::
alert: post
http_post_url: "http://example.com/api"
http_post_payload:
description: "An event came from IP {{clientip}}"
username: "{{user.name}}"
http_post_raw_fields:
ip: clientip
http_post_static_payload:
apikey: abc123
http_post_headers:
authorization: Basic 123dr3234
X-custom-type: {{type}}

Jira
~~~~
Expand Down

0 comments on commit dc4e752

Please sign in to comment.