Skip to content

Commit 866f118

Browse files
committed
add webhook notifications section
Signed-off-by: tdruez <tdruez@aboutcode.org>
1 parent e727566 commit 866f118

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

docs/reference-policy-rules.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,3 +224,22 @@ warning-severity rules are triggered.
224224

225225
Clicking the **info icon** next to the panel title opens a modal listing all configured
226226
rules with their current status (Triggered, OK, or Disabled).
227+
228+
6. Webhook Notifications
229+
------------------------
230+
231+
The policy rules engine fires webhook events when violations change state. These can be
232+
used to integrate DejaCode compliance alerts into external workflows such as Slack,
233+
ticketing systems, or CI/CD pipelines.
234+
235+
Two events are available:
236+
237+
- ``policy.violation_detected``: fired when one or more **new** violations are detected
238+
during an evaluation run. The payload includes the product name and a summary of
239+
triggered rules with their violation counts.
240+
- ``policy.violation_resolved``: fired when violations are resolved during an evaluation
241+
run. The payload includes the product name and the number of violations resolved.
242+
243+
.. seealso::
244+
:ref:`integrations_webhook` for instructions on configuring webhook endpoints and
245+
event subscriptions.

0 commit comments

Comments
 (0)