Skip to content

Commit aa90681

Browse files
devGregAclaudeMaffooch
authored
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>
1 parent 07eb575 commit aa90681

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
@@ -16,6 +16,7 @@ Supported Integrations:
1616
- [GitLab Boards](/issue_tracking/pro_integration/integrations/#gitlab)
1717
- [Freshservice](/issue_tracking/pro_integration/integrations/#freshservice)
1818
- [ServiceNow](/issue_tracking/pro_integration/integrations/#servicenow)
19+
- [Shortcut](/issue_tracking/pro_integration/integrations/#shortcut)
1920

2021
## Opening the Integrations page
2122

@@ -76,6 +77,7 @@ For the complete list of requirements, please open the vendor specific pages bel
7677
- [GitLab Boards](/issue_tracking/pro_integration/integrations/#gitlab)
7778
- [Freshservice](/issue_tracking/pro_integration/integrations/#freshservice)
7879
- ServiceNow (Coming Soon)
80+
- [Shortcut](/issue_tracking/pro_integration/integrations/#shortcut)
7981

8082
## Error Handling and Debugging
8183

docs/content/issue_tracking/pro_integration/integrations_toolreference.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,49 @@ This maps to the ServiceNow Impact field.
230230
- **False Positive Mapping**: `Resolved`
231231
- **Risk Accepted Mapping**: `Resolved`
232232

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:
246+
247+
```
248+
curl -H "Shortcut-Token: {{API_TOKEN}}" https://api.app.shortcut.com/api/v3/groups
249+
```
250+
251+
### Severity Mapping Details
252+
253+
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:
265+
266+
```
267+
curl -H "Shortcut-Token: {{API_TOKEN}}" https://api.app.shortcut.com/api/v3/workflows
268+
```
269+
270+
- **Status Field Name**: `Workflow State ID`
271+
- **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+
233276
## Freshservice
234277

235278
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

Comments
 (0)