HTTP Server - Send to Webhook

HTTP Server - Send to Webhook serializes the entities retrieved from the saved query supplied as a trigger (or entities selected in the asset table) as JSON. This JSON data is sent to a configured webhook. When used with a saved query as a trigger, only the fields configured in the saved query are added to the JSON.

Required Fields

These fields must be configured to run the Enforcement Set.

• Webhook URL - Specify the webhook URL.
• Custom format for body (use {$BODY} as keyword) (default: {"entities": {$BODY}}) - You can customize the webhook body.
  • Use {$BODY} to include the entities found in the saved query supplied as a trigger (or entities that have been selected in the asset table) data.
  • Use {$BODY_ESCAPED} instead of {$BODY} if you want to escape JSON characters so that the JSON is sent as a string instead of an object. The following example shows how to use the $BODY_ESCAPED option in this Enforcement Action's Dynamic Value statement.

device all
then form.custom_format
set_value concat (
"{\n", 
"    \"subject\": \"Axonius Test Message\",\n", 
"    \"message\": {$BODY_ESCAPED},\n",
"    \"issueType\": \"IT - Reports\",\n", 
"    \"subIssueType\": \"Problem\",\n", 
"    \"email\": {\n",  
"        \"to\": \"[email protected]\"\n", 
"    },\n",
"    \"source\": {\n", 
"        \"name\": \"Axonius Enforcement: alerthandler_ec2-uptime>60-days\",\n",
"        \"time\": \"2024-08-20T20:54:08.219Z\"\n",
"    }\n",
"}"
)

• Connection timeout (seconds) (default: 10 seconds) - Define the number of seconds before the attempt to connect to the webhook is considered to be timed out. As a result, the enforcement action execution will fail.
• Writing data to webhook timeout (seconds) (default: 1200 seconds) - Define the maximum number of seconds before the attempt of completing sending the data to the webhook is considered to be timed out. As a result, the enforcement action execution will fail.

• Compute Node - The Axonius node to use when connecting to the specified host. For more details, see Working with Axonius Compute Nodes.

Additional Fields

These fields are optional.

• Authorization header user name and authorization header password (default: empty) - Specify authorization header user name and password, if required.
  • If supplied, Axonius passes the specified authorization header information along with the Webhook URL.
  • If not supplied, Axonius does not pass any additional information along with the Webhook URL.

• Verify SSL (optional) - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.

• HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.

• HTTP proxy - When a proxy is supplied, Axonius uses the proxy instead of the direct URL, when connecting to the HTTP Webhook URL.
• Additional headers The default header:

{"Content-type": "application/json"}

• Add Customized Headers to be Sent with Request. For Example:

{"Content-type":"application/json","Accept":"application/json","Authorization":"Bearer "}

• Max retry attempts - Enter the number of times you want to retry running the action before reporting a failure.
• Map Axonius fields to custom field names - Use the Field Mapping Wizard to rename Axonius field keys in the JSON payload. Select an Axonius field on the left and provide the desired output name on the right (for example, map mssql_adapter=mssql_email → email).
• Only include entity fields - When enabled, the webhook body only includes the fields configured in the query columns. System fields such as adapter metadata and internal IDs are excluded.

• Gateway Name - Select the Gateway through which to connect to perform the action.