Skip to content

Commit 28eacda

Browse files
devGregAclaudemtesauro
authored
docs: add Freshservice Pro integration reference (#15221)
* docs: add Freshservice Pro integration reference Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: correct the Freshservice API key location Freshservice's own API-docs intro still says the key sits next to the change password section, but the current UI shows it in Profile settings below Delegate Approvals, behind a captcha. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: note Freshservice resolution-note and priority-matrix behavior Both surfaced during live testing against a real Freshservice account. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Matt Tesauro <mtesauro@gmail.com>
1 parent 29a4751 commit 28eacda

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

docs/content/issue_tracking/pro_integration/integrations.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Supported Integrations:
1313
- [Azure Devops](/issue_tracking/pro_integration/integrations/#azure-devops-boards)
1414
- [GitHub](/issue_tracking/pro_integration/integrations/#github)
1515
- [GitLab Boards](/issue_tracking/pro_integration/integrations/#gitlab)
16+
- [Freshservice](/issue_tracking/pro_integration/integrations/#freshservice)
1617
- [ServiceNow](/issue_tracking/pro_integration/integrations/#servicenow)
1718

1819
## Opening the Integrations page
@@ -71,6 +72,7 @@ For the complete list of requirements, please open the vendor specific pages bel
7172
- [Azure Devops](/issue_tracking/pro_integration/integrations/#azure-devops-boards)
7273
- [GitHub](/issue_tracking/pro_integration/integrations/#github)
7374
- [GitLab Boards](/issue_tracking/pro_integration/integrations/#gitlab)
75+
- [Freshservice](/issue_tracking/pro_integration/integrations/#freshservice)
7476
- ServiceNow (Coming Soon)
7577

7678
## Error Handling and Debugging

docs/content/issue_tracking/pro_integration/integrations_toolreference.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,3 +183,46 @@ This maps to the ServiceNow Impact field.
183183
- **Closed Mapping**: `Closed`
184184
- **False Positive Mapping**: `Resolved`
185185
- **Risk Accepted Mapping**: `Resolved`
186+
187+
## Freshservice
188+
189+
The Freshservice Integration allows you to push DefectDojo Findings and Finding Groups as Freshservice tickets, assigned to an agent Group of your choice.
190+
191+
### Instance Setup
192+
193+
- **Label** should be the label that you want to use to identify this integration.
194+
- **Location** should be set to your Freshservice URL: `https://yourcompany.freshservice.com`.
195+
- **API Key** should be a Freshservice API key. Find it by clicking your profile picture (top right) > **Profile settings** - the key appears on the right below the **Delegate Approvals** section, after you complete the captcha. If no key is shown there, API access may be disabled at the account level and an administrator has to enable it first.
196+
- **Requester Email** should be the email address tickets are requested on behalf of. Freshservice requires a requester on every ticket, so DefectDojo creates tickets with this address as the requester.
197+
198+
### Issue Tracker Mapping
199+
200+
- **Group ID** should be the numeric ID of the Freshservice agent group tickets will be assigned to. Find it in the URL while viewing the group under **Admin > Agent Groups**.
201+
- **Workspace ID** (optional) routes tickets to a specific workspace on multi-workspace accounts. Leave it empty to use the primary workspace.
202+
203+
### Severity Mapping Details
204+
205+
This maps to the Freshservice ticket **Priority** field, which uses numeric codes (`1` Low, `2` Medium, `3` High, `4` Urgent). The priority names are also accepted:
206+
207+
- **Severity Field Name**: `Priority`
208+
- **Info Mapping**: `1`
209+
- **Low Mapping**: `1`
210+
- **Medium Mapping**: `2`
211+
- **High Mapping**: `3`
212+
- **Critical Mapping**: `4`
213+
214+
### Status Mapping Details
215+
216+
This maps to the ticket **Status** field, which uses numeric codes (`2` Open, `3` Pending, `4` Resolved, `5` Closed). The status names are also accepted:
217+
218+
- **Status Field Name**: `Status`
219+
- **Active Mapping**: `2`
220+
- **Closed Mapping**: `5`
221+
- **False Positive Mapping**: `5`
222+
- **Risk Accepted Mapping**: `3`
223+
224+
A few Freshservice-specific behaviors to be aware of:
225+
226+
- Updates sync the full ticket content - Freshservice allows the subject and description to be edited after creation.
227+
- Tickets are closed rather than deleted when a Finding is removed; tickets already Resolved or Closed are left untouched. A resolution note is attached automatically on closure, so accounts that require one (a common business rule) accept the close.
228+
- Some accounts compute a ticket's priority from an Impact/Urgency matrix or a business rule and ignore the priority sent at creation. DefectDojo detects this and re-applies the mapped priority with a follow-up update, so the mapping still takes effect.

0 commit comments

Comments
 (0)