Types
Jira
Create & sync Jira issues from incidents using site URL + email + API token (no OAuth).
Automatically create or update Jira issues for incidents.
Setup (API Token Method)
- In Atlassian: Go to https://id.atlassian.com/manage-profile/security/api-tokens.
- Click Create API token, name it (e.g.
Garmingo Status), copy the token (store securely). - Identify your Jira Cloud base URL (e.g.
https://your-domain.atlassian.net). - In Garmingo → Add Jira integration.
- Fill fields:
- Jira API URL:
https://your-domain.atlassian.net - Jira Email: The Atlassian account email that created the token.
- Jira API Token: Paste token from step 2.
- Project Key: Short key (e.g.
OPS,STAT). - Issue Type: e.g.
Task,Incident,Bug(must exist in the project’s scheme).
- Jira API URL:
- Choose triggering events (Incident Created; optionally Incident Updated, Incident Resolved).
- Save and run a test by creating a low‑severity dummy incident (delete afterwards).
Field Mapping Tips
| Field | Suggested Value |
|---|---|
| Summary | Incident: <Monitor Name> or concise root cause once known |
| Description | Timeline + status page link + affected monitors |
| Labels | status, incident + severity label (e.g. sev1) |
| Priority | Derived from monitor/incident severity mapping |
Example Summary Progression
Initial: Incident: API Latency Spike → Post‑mortem: Root Cause: DB Connection Pool Saturation.
Synchronization Behavior
| Action in Garmingo | Jira Effect (if enabled) |
|---|---|
| Incident Created | New issue created |
| Incident Status/Message Update | Comment appended (timestamped) |
| Incident Resolved | Optional transition or comment ("Resolved in Status") |
(Workflow transitions require the issue type’s workflow to allow the target status; if not, a comment fallback is used.)
Severity & Priority Mapping
Maintain a simple internal map, e.g.:
| Incident Severity | Jira Priority |
|---|---|
| Critical | Highest |
| High | High |
| Medium | Medium |
| Low | Low |
Configure this map in your runbook; currently priority selection is manual via field mapping or defaults.
Security
- API token inherits permissions of the user owning it—grant least privilege (project‑scoped role, not full org admin if possible).
- Rotate tokens periodically (e.g., quarterly) or on personnel changes.
- Revoke immediately if exposed (Atlassian security page) and update integration.
- Avoid embedding sensitive data (credentials, customer PII) in incident descriptions sent to Jira.
Troubleshooting
| Symptom | Likely Cause | Fix |
|---|---|---|
| 401 / Unauthorized | Wrong email/token pair | Regenerate token; verify copy (no whitespace) |
| 404 Project key not found | Typo or insufficient permission | Confirm key on project page & user permissions |
| Issue type invalid | Not in project’s issue type scheme | Add issue type to scheme or pick allowed one |
| Comments not appearing | Comment scope permissions | Ensure user can add comments in project |
| Transition fails | Workflow name/status mismatch | Adjust workflow or disable transition feature |
Audit & Maintenance Checklist
- Token age < 6 months
- User account still active / appropriate role
- Labels set on last 5 issues (consistency)
- No orphan Jira issues (incident already deleted)
Cleanup / Removal
- Disable integration (stop new issues) if doing maintenance.
- Revoke API token in Atlassian when permanently removing.
- Optionally bulk close stale incident issues.
Need advanced mapping (custom fields, components)? Note them and extend when customization UI supports additional fields.