integration

This configures the manager to connect ThreatLockDown to external APIs and alerting tools such as Slack, PagerDuty, VirusTotal, Shuffle, and Maltiverse.

Integration options

name

This indicates the service to integrate with.

Default value

n/a

Allowed values

slack, pagerduty, virustotal, shuffle, maltiverse, any string that begins with 'custom-'

Note

In the case of custom external integration, name must begin with custom- for example: custom-myintegration. Read the How to integrate external software using Integrator document for more information.

hook_url

This is the URL that is used for communication with the software being integrated. It's mandatory for the Slack, Shuffle, and Maltiverse integrations.

Default value

n/a

Allowed values

Slack URL, Shuffle URL, Maltiverse URL

api_key

This is the key that you would have retrieved from the PagerDuty, VirusTotal, or Maltiverse API. This is mandatory for PagerDuty, VirusTotal, and Maltiverse.

Default value

n/a

Allowed values

PagerDuty/VirusTotal/Maltiverse Api key

alert_format

This writes the alert file in the JSON format, which the Integrator uses to fetch fields values.

Default value

n/a

Allowed values

json

Note

Set this option as json for Slack, VirusTotal, Shuffle, and Maltiverse integrations.

Optional filters

level

This filters alerts by rule level so that only alerts with the specified level or above are pushed.

Default value

n/a

Allowed values

Any alert level from 0 to 16

rule_id

This filters alerts by rule ID.

Default value

n/a

Allowed values

Comma-separated rule IDs

group

This filters alerts by rule group. For the VirusTotal integration, only rules from the syscheck group are available.

Default value

n/a

Allowed values

Any rule group or comma-separated rule groups.

event_location

This filters alerts by where the event originated.

Default value

n/a

Allowed values

Any sregex expression.

Optional settings

max_log

The maximum length of an alert snippet that will be sent to the Integrator. Longer strings will be truncated with ...

Default value

165

Allowed values

Any integer from 165 to 1024 inclusive.

Note

This option only applies if alert_format is not set to json.

options

This overwrites the previous fields or adds customization fields according to the information provided in the JSON object.

Default value

n/a

Allowed values

json

timeout

The timeout (in seconds) to wait for a valid response from the external integration server.

Default value

10

Allowed values

Any positive integer.

retries

On timeout, the maximum number of retry attempts for a request to the external integration server.

Default value

3

Allowed values

Any positive integer.

Configuration example

<!-- Integration with Slack -->
<integration>
  <name>slack</name>
  <hook_url>https://hooks.slack.com/services/...</hook_url> <!-- Replace with your Slack hook URL -->
  <level>10</level>
  <group>multiple_drops,authentication_failures</group>
  <alert_format>json</alert_format>
  <options>{"pretext": "Custom Title"}</options> <!-- Replace with your custom JSON object -->
</integration>

<!-- Integration with PagerDuty -->
<integration>
  <name>pagerduty</name>
  <api_key>API_KEY</api_key> <!-- Replace with your PagerDuty API key -->
  <options>{"pretext": "Custom title"}</options> <!-- Replace with your custom JSON object -->
  <alert_format>json</alert_format> <!-- With the new script this is mandatory -->
</integration>

<!-- Integration with VirusTotal -->
<integration>
  <name>virustotal</name>
  <api_key>API_KEY</api_key> <!-- Replace with your VirusTotal API key -->
  <group>syscheck</group>
  <alert_format>json</alert_format>
  <timeout>30</timeout>
  <retries>5</retries>
</integration>

<!-- Integration with Shuffle -->
<integration>
  <name>shuffle</name>
  <hook_url>http://IP:3001/api/v1/hooks/HOOK_ID</hook_url> <!-- Replace with your Shuffle hook URL -->
  <level>3</level>
  <alert_format>json</alert_format>
  <options>{"data": {"title": "Custom title"}}</options> <!-- Replace with your custom JSON object -->
</integration>

<!-- Integration with Maltiverse -->
<integration>
  <name>maltiverse</name>
  <hook_url>https://api.maltiverse.com</hook_url>
  <api_key>API_KEY</api_key> <!-- Replace with your Maltiverse API key -->
  <alert_format>json</alert_format>
</integration>

<!--Custom external Integration -->
<integration>
  <name>custom-integration</name>
  <hook_url>WEBHOOK</hook_url>
  <level>10</level>
  <group>multiple_drops,authentication_failures</group>
  <api_key>APIKEY</api_key> <!-- Replace with your external service API key -->
  <alert_format>json</alert_format>
  <options>{"data": "Custom data"}</options> <!-- Replace with your custom JSON object -->
</integration>