You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: docs/content/issue_tracking/pro_integration/integrations_toolreference.md
+43Lines changed: 43 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -183,3 +183,46 @@ This maps to the ServiceNow Impact field.
183
183
-**Closed Mapping**: `Closed`
184
184
-**False Positive Mapping**: `Resolved`
185
185
-**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