Skip to content

Commit f1484fd

Browse files
devGregAclaudeMaffooch
authored
docs: add Zendesk to the Pro Integrations tool reference (#15215)
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> Co-authored-by: Cody Maffucci <46459665+Maffooch@users.noreply.github.com>
1 parent 031e965 commit f1484fd

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
@@ -19,6 +19,7 @@ Supported Integrations:
1919
- ServiceDesk Plus
2020
- ServiceNow
2121
- Shortcut
22+
- Zendesk
2223

2324
## Opening the Integrations page
2425

@@ -82,6 +83,7 @@ For the complete list of requirements, please open the vendor specific pages bel
8283
- [ServiceDesk Plus](/issue_tracking/pro_integration/integrations_toolreference/#servicedesk-plus)
8384
- [ServiceNow](/issue_tracking/pro_integration/integrations_toolreference/#servicenow)
8485
- [Shortcut](/issue_tracking/pro_integration/integrations_toolreference/#shortcut)
86+
- [Zendesk](/issue_tracking/pro_integration/integrations_toolreference/#zendesk)
8587

8688
## Error Handling and Debugging
8789

docs/content/issue_tracking/pro_integration/integrations_toolreference.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -496,3 +496,45 @@ A few ServiceDesk Plus-specific behaviors to be aware of:
496496
- Updates sync the full request content - unlike most trackers, ServiceDesk Plus allows the subject and description to be edited after creation.
497497
- Requests are closed rather than deleted when a Finding is removed; requests already Closed or Resolved are left untouched.
498498
- If your account makes fields mandatory on closure (for example a resolution), a close pushed from DefectDojo may be rejected by those rules and will appear in the Integration errors table.
499+
500+
## Zendesk
501+
502+
The Zendesk Integration allows you to push DefectDojo Findings and Finding Groups as Zendesk tickets, assigned to a Zendesk Group of your choice.
503+
504+
### Instance Setup
505+
506+
- **Label** should be the label that you want to use to identify this integration.
507+
- **Location** should be set to your Zendesk account URL, for example `https://your-subdomain.zendesk.com`.
508+
- **Email** should be the email address of the Zendesk agent the API token belongs to.
509+
- **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).
510+
511+
### Issue Tracker Mapping
512+
513+
- **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.
514+
515+
### Severity Mapping Details
516+
517+
This maps to the Zendesk ticket **Priority** field, which accepts `low`, `normal`, `high`, and `urgent`:
518+
519+
- **Severity Field Name**: `Priority`
520+
- **Info Mapping**: `low`
521+
- **Low Mapping**: `low`
522+
- **Medium Mapping**: `normal`
523+
- **High Mapping**: `high`
524+
- **Critical Mapping**: `urgent`
525+
526+
### Status Mapping Details
527+
528+
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.
529+
530+
- **Status Field Name**: `Status`
531+
- **Active Mapping**: `new`
532+
- **Closed Mapping**: `solved`
533+
- **False Positive Mapping**: `solved`
534+
- **Risk Accepted Mapping**: `pending`
535+
536+
A few Zendesk-specific behaviors to be aware of:
537+
538+
- 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.
539+
- Tickets are marked `solved` rather than deleted when a Finding is removed; Zendesk closes solved tickets automatically after a period of time.
540+
- `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)