Skip to content

docs: match the Sample Payload and support page labels #16222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blakeaowens merged 1 commit into from
Oct 6, 2026
Merged

docs: match the Sample Payload and support page labels #16222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/automation/triage_engine/webhook_receivers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Posting comments needs a go-integrators version that provides it. When DefectDoj

1. **New Webhook Receiver**, then **Custom Webhook**. Give it a label and choose how the sender authenticates.
2. Save. The **Setup** tab shows the URL to give the sender.
3. On **Sample Payload**, paste an example from the sender's documentation, or send one for real. **Parse** lists every path in it, such as `webhook.payload.issue.key`, with an example value and a copy button.
3. On **Sample Payload**, paste an example from the sender's documentation, or send one for real, and **Submit** it. The tab lists every path in it, such as `webhook.payload.issue.key`, with an example value and a copy button.
4. **Create a Rule** opens the editor with an **On an Inbound Webhook** trigger for this receiver. Add **Find Findings by a Value** to turn a payload value into Findings, then any Findings or Egress nodes.
5. **Preview** runs the rule against the sample, or against a payload you paste into **Test With a Payload**, and changes nothing. A webhook rule has no manual **Run**: it runs when its receiver records a delivery.

Expand Down
8 changes: 4 additions & 4 deletions docs/content/navigation/PRO__support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 11
audience: pro
---

DefectDojo Pro carries two support pages. **Support** is where you file a request and follow it. **Community requests** is the board of topics DefectDojo has published for customers to vote on.
DefectDojo Pro carries two support pages. **Support** is where you file a request and follow it. **Community Requests** is the board of topics DefectDojo has published for customers to vote on.

> The Support pages are a DefectDojo Pro feature. The instance calls DefectDojo from its own server, never from your browser.

Expand All @@ -26,9 +26,9 @@ A fifth choice, **Security disclosure**, files nothing. The form points you to D

Under the form, **My requests** lists everything your account has filed, with the status DefectDojo staff last set on it. If the instance cannot reach DefectDojo, the list falls back to the copy the instance stores locally and the page says the status updates are paused.

## Community requests
## Community Requests

**Community requests** (`/ui/cloud/support/community`) lists the topics DefectDojo has published. Each row carries a title, a status and a vote button. Vote once per topic to say it matters to you. The count rises and the button locks. Completed topics (Shipped, Merged, Aged out) sit greyed out at the bottom of the board and no longer take votes. If DefectDojo decides not to pursue a topic, it leaves the board; a request you linked to it stays in **My requests**. When a topic you voted on changes status, DefectDojo e-mails the address on your DefectDojo user, provided it is at your organization's e-mail domain (the domain of your Cloud Portal account).
**Community Requests** (`/ui/cloud/support/community`) lists the topics DefectDojo has published. Each row carries a title, a status and a vote button. Vote once per topic to say it matters to you. The count rises and the button locks. Completed topics (Shipped, Merged, Aged out) sit greyed out at the bottom of the board and no longer take votes. If DefectDojo decides not to pursue a topic, it leaves the board; a request you linked to it stays in **My requests**. When a topic you voted on changes status, DefectDojo e-mails the address on your DefectDojo user, provided it is at your organization's e-mail domain (the domain of your Cloud Portal account).

A request you file does not reach the board on its own. DefectDojo staff decide what to publish there.

Expand Down Expand Up @@ -58,7 +58,7 @@ If enrolment is refused for any other reason, the log line names the credential

## Airgapped instances

An instance with no route off its network cannot use the support pages at all. Turn on the **Airgapped instance** feature flag under **Settings → Feature Flags**. Both pages then open a dialog that says support tracking is not supported for airgapped instances, with the DefectDojo support address to write to instead. Its **Go back** button returns you to the page you came from. The flag takes effect on the next page load; no restart is needed.
An instance with no route off its network cannot use the support pages at all. Turn on the **Airgapped instance** feature flag under **Settings → Feature Flags**. Both pages then open a dialog that says support tracking is not supported for airgapped instances, with the DefectDojo support address to write to instead. Its **Back** button returns you to the page you came from. The flag takes effect on the next page load; no restart is needed.

With the setting on, the instance makes no outbound support call and no documentation call. The dialog opens as soon as the page loads. It does not wait for a call to time out first.

Expand Down
Loading