Skip to content

Commit def3d86

Browse files
devGregAclaude
authored andcommitted
docs: add Zendesk to the Pro Integrations tool reference
Covers instance setup (agent email + API token basic auth, subdomain URL), the numeric group ID mapping identifier, priority and status mappings, and the Zendesk-specific caveats (immutable description, solve-on-delete, closed is terminal). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent af3716f commit def3d86

2 files changed

Lines changed: 44 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
@@ -14,6 +14,7 @@ Supported Integrations:
1414
- [GitHub](/issue_tracking/pro_integration/integrations/#github)
1515
- [GitLab Boards](/issue_tracking/pro_integration/integrations/#gitlab)
1616
- [ServiceNow](/issue_tracking/pro_integration/integrations/#servicenow)
17+
- [Zendesk](/issue_tracking/pro_integration/integrations/#zendesk)
1718

1819
## Opening the Integrations page
1920

@@ -72,6 +73,7 @@ For the complete list of requirements, please open the vendor specific pages bel
7273
- [GitHub](/issue_tracking/pro_integration/integrations/#github)
7374
- [GitLab Boards](/issue_tracking/pro_integration/integrations/#gitlab)
7475
- ServiceNow (Coming Soon)
76+
- [Zendesk](/issue_tracking/pro_integration/integrations/#zendesk)
7577

7678
## Error Handling and Debugging
7779

docs/content/issue_tracking/pro_integration/integrations_toolreference.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,3 +183,45 @@ This maps to the ServiceNow Impact field.
183183
- **Closed Mapping**: `Closed`
184184
- **False Positive Mapping**: `Resolved`
185185
- **Risk Accepted Mapping**: `Resolved`
186+
187+
## Zendesk
188+
189+
The Zendesk Integration allows you to push DefectDojo Findings and Finding Groups as Zendesk tickets, assigned to a Zendesk 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 Zendesk account URL, for example `https://your-subdomain.zendesk.com`.
195+
- **Email** should be the email address of the Zendesk agent the API token belongs to.
196+
- **API Token** should be set to a Zendesk API token. An administrator can create one in the Zendesk Admin Center under **Apps and integrations > APIs > Zendesk API** (token access must be enabled).
197+
198+
### Issue Tracker Mapping
199+
200+
- **Group ID** should be the numeric ID of the Zendesk Group that tickets will be assigned to. You can find it in the Admin Center under **People > Team > Groups**, or in the URL while viewing the group.
201+
202+
### Severity Mapping Details
203+
204+
This maps to the Zendesk ticket **Priority** field, which accepts `low`, `normal`, `high`, and `urgent`:
205+
206+
- **Severity Field Name**: `Priority`
207+
- **Info Mapping**: `low`
208+
- **Low Mapping**: `low`
209+
- **Medium Mapping**: `normal`
210+
- **High Mapping**: `high`
211+
- **Critical Mapping**: `urgent`
212+
213+
### Status Mapping Details
214+
215+
Zendesk tickets support the statuses `new`, `open`, `pending`, `hold`, `solved`, and `closed`. Note that `hold` must be enabled on your account before it can be used.
216+
217+
- **Status Field Name**: `Status`
218+
- **Active Mapping**: `new`
219+
- **Closed Mapping**: `solved`
220+
- **False Positive Mapping**: `solved`
221+
- **Risk Accepted Mapping**: `pending`
222+
223+
A few Zendesk-specific behaviors to be aware of:
224+
225+
- The ticket description is the first comment in Zendesk and cannot be edited after creation, so pushing an updated Finding will sync the ticket's subject, priority, and status, but not description changes.
226+
- Tickets are marked `solved` rather than deleted when a Finding is removed; Zendesk closes solved tickets automatically after a period of time.
227+
- `closed` is a final status - closed tickets cannot be updated at all, and pushing a Finding whose ticket has closed will report an error.

0 commit comments

Comments
 (0)