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
Add Shortcut section to the Pro Integrations docs (#15209)
Documents instance setup with a Shortcut API token, the Team (Group)
UUID used by the issue tracker mapping, severity mapping via story
labels, and status mapping via numeric workflow state IDs, including
how to look up teams and workflow states with the Shortcut API.
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Cody Maffucci <46459665+Maffooch@users.noreply.github.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
@@ -230,6 +230,49 @@ This maps to the ServiceNow Impact field.
230
230
-**False Positive Mapping**: `Resolved`
231
231
-**Risk Accepted Mapping**: `Resolved`
232
232
233
+
## Shortcut
234
+
235
+
The Shortcut integration allows you to push DefectDojo Findings as [Shortcut](https://www.shortcut.com/) Stories. Stories are created with the story type of Bug and assigned to a Team in your Shortcut workspace.
236
+
237
+
### Instance Setup
238
+
239
+
-**Label** should be the label that you want to use to identify this integration.
240
+
-**Location** should be set to `https://api.app.shortcut.com`.
241
+
-**API Token** should be set to a Shortcut API token. Tokens can be generated in Shortcut under Settings, then Your Account, then [API Tokens](https://app.shortcut.com/settings/account/api-tokens).
242
+
243
+
### Issue Tracker Mapping
244
+
245
+
-**Team (Group) ID** should be set to the UUID of the Shortcut Team that Stories will be created for. You can find this UUID by opening the Team page in Shortcut and copying the identifier from the URL, or by calling the Shortcut API:
Each severity value is applied to the Story as a label. Labels are created automatically in Shortcut if they do not already exist, so the default values below can be used as they are, or replaced with label names of your choosing. When a Finding's severity changes, the old severity label is removed from the Story and the new one is added.
254
+
255
+
-**Severity Field Name**: `Label`
256
+
-**Info Mapping**: `sev-info`
257
+
-**Low Mapping**: `sev-low`
258
+
-**Medium Mapping**: `sev-medium`
259
+
-**High Mapping**: `sev-high`
260
+
-**Critical Mapping**: `sev-critical`
261
+
262
+
### Status Mapping Details
263
+
264
+
Each status value must be set to the numeric ID of a Workflow State in your Shortcut workspace. Workflow State IDs are unique to each workspace, so there are no default values. You can list the Workflow States and their IDs by calling the Shortcut API:
-**Active Mapping**: the ID of the state for open work, for example a Backlog or To Do state.
272
+
-**Closed Mapping**: the ID of a Done type state. When a Finding is deleted in DefectDojo, its Story is moved to this state.
273
+
-**False Positive Mapping**: the ID of the state to use for False Positive Findings.
274
+
-**Risk Accepted Mapping**: the ID of the state to use for Risk Accepted Findings.
275
+
233
276
## Freshservice
234
277
235
278
The Freshservice Integration allows you to push DefectDojo Findings and Finding Groups as Freshservice tickets, assigned to an agent Group of your choice.
0 commit comments