# Automation engine
In order to send a webhook request when an automation rule is triggered, add a "trigger webhook" action to the rule and enter the URL for the webhook in the URL field. When the rule is triggered, a POST request will be sent to the given URL with JSON-encoded data about the event.
The JSON will contain the following keys:
| || ||The name of the repository which was scanned.|
| || ||The name of the branch which was scanned.|
| || ||The name of the commit which was scanned.|
| || ||A link to |
| || ||A unique identifier for the rule that was triggered.|
| || ||A link to |
| || ||An array of |
Each element of
triggeredFor will contain the following keys:
| || ||The name of the dependency which caused the rule to trigger.|
| || ||An array of licenses affecting the dependency, each encoded as a string using the same name shown in the license view.|
| || ||A link to the dependency on |
| || ||Information about the vulnerability which caused the rule to trigger, or |
| || ||The name of the vulnerability which caused the rule to trigger.|
| || ||A link to the vulnerability on |
| || ||CVSS2 score for the vulnerability, or |
| || ||CVSS3 score for the vulnerability, or |
# Sample Request
A sample webhook request can be sent to the specified URL by clicking "send sample request".
triggeredFor array will be populated using up to three vulnerabilities which were found the last time this repository was scanned.
Note that these vulnerabilities may not necessarily satisfy the conditions specified in the rule.
# Verification Secret
To ensure that a webhook request was sent by Debricked, a key can specified in the "verification secret" field.
When a verification secret is specified, webhook requests made by this rule will include the header
X-Debricked-Signature, containing an SHA256-HMAC signature generated using the webhook payload and the verification secret.