sharang/compliance-scanner-agent
1
0
Fork 0
Code Issues 64 Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

docs: rebrand Certifai → Prüfwerk (user-facing name) (#243)
CI / Check (push) Skipped
Details
CI / Detect Changes (push) Successful in 3s
Details
CI / Deploy Agent (push) Skipped
Details
CI / Deploy Dashboard (push) Skipped
Details
CI / Deploy MCP (push) Skipped
Details
CI / Deploy Docs (push) Successful in 1m13s
Details

Browse Source
This commit was merged in pull request #243.
This commit is contained in:
sharang
2026-09-02 08:00:12 +00:00
parent e0c54c4659
commit 710fdcab6f
15 changed files with 59 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/guide/webhooks.md
+13 -13
View File
@@ -1,15 +1,15 @@
# Webhooks & PR Reviews
Webhooks let Certifai respond to events in your Git repositories automatically. When configured, pushes to your repository trigger scans, and pull requests receive automated security reviews.
Webhooks let Prüfwerk respond to events in your Git repositories automatically. When configured, pushes to your repository trigger scans, and pull requests receive automated security reviews.
## What Webhooks Enable
- **Automatic scans on push** -- every time code is pushed to your default branch, a scan is triggered automatically
- **PR security reviews** -- when a pull request is opened or updated, Certifai scans the changes and posts a review comment summarizing any security findings in the diff
- **PR security reviews** -- when a pull request is opened or updated, Prüfwerk scans the changes and posts a review comment summarizing any security findings in the diff
## Finding the Webhook URL and Secret
Each repository in Certifai has its own webhook URL and secret:
Each repository in Prüfwerk has its own webhook URL and secret:
1. Go to **Repositories**
2. Click **Edit** on the repository you want to configure
@@ -22,8 +22,8 @@ Each repository in Certifai has its own webhook URL and secret:
1. Go to your repository in Gitea
2. Navigate to **Settings > Webhooks > Add Webhook > Gitea**
3. Set the **Target URL** to the webhook URL from Certifai
4. Set the **Secret** to the webhook secret from Certifai
3. Set the **Target URL** to the webhook URL from Prüfwerk
4. Set the **Secret** to the webhook secret from Prüfwerk
5. Under **Trigger On**, select:
- **Push Events** -- for automatic scans on push
- **Pull Request Events** -- for PR security reviews
@@ -34,9 +34,9 @@ Each repository in Certifai has its own webhook URL and secret:
1. Go to your repository on GitHub
2. Navigate to **Settings > Webhooks > Add webhook**
3. Set the **Payload URL** to the webhook URL from Certifai
3. Set the **Payload URL** to the webhook URL from Prüfwerk
4. Set the **Content type** to `application/json`
5. Set the **Secret** to the webhook secret from Certifai
5. Set the **Secret** to the webhook secret from Prüfwerk
6. Under **Which events would you like to trigger this webhook?**, select **Let me select individual events**, then check:
- **Pushes** -- for automatic scans on push
- **Pull requests** -- for PR security reviews
@@ -46,8 +46,8 @@ Each repository in Certifai has its own webhook URL and secret:
1. Go to your project in GitLab
2. Navigate to **Settings > Webhooks**
3. Set the **URL** to the webhook URL from Certifai
4. Set the **Secret token** to the webhook secret from Certifai
3. Set the **URL** to the webhook URL from Prüfwerk
4. Set the **Secret token** to the webhook secret from Prüfwerk
5. Under **Trigger**, check:
- **Push events** -- for automatic scans on push
- **Merge request events** -- for PR security reviews
@@ -57,10 +57,10 @@ Each repository in Certifai has its own webhook URL and secret:
When a pull request (or merge request) is opened or updated, the following happens:
1. Your Git provider sends a webhook event to Certifai
2. Certifai checks out the PR branch and runs a targeted scan on the changed files
1. Your Git provider sends a webhook event to Prüfwerk
2. Prüfwerk checks out the PR branch and runs a targeted scan on the changed files
3. Findings specific to the changes in the PR are identified
4. Certifai posts a review comment on the PR summarizing:
4. Prüfwerk posts a review comment on the PR summarizing:
- Number of new findings introduced by the changes
- Severity breakdown
- Details for each finding including file, line, and remediation guidance
@@ -83,5 +83,5 @@ Here is a summary of which events to enable for each feature:
You can enable one or both depending on your workflow.
::: warning
Make sure the webhook secret matches exactly between your Git provider and Certifai. Requests with an invalid signature are rejected.
Make sure the webhook secret matches exactly between your Git provider and Prüfwerk. Requests with an invalid signature are rejected.
:::