How the Jira Integration Works
This page explains how the Jira integration behaves internally: how data flows between Qualytics and Jira, what is synced, and how fields are mapped.
Integration Flow Diagram
The following diagram illustrates how data flows between Qualytics and Jira. It shows the outbound path only. The return path, where issue status, summary and comments are read back into Qualytics, is described in What Gets Synced.
flowchart TB
subgraph Qualytics["Qualytics Platform"]
A[Anomaly Detected] --> B{User Action}
B -->|Create Ticket| C[Create Ticket Request]
B -->|Acknowledge| D[Status Change Event]
B -->|Add Comment| E[Comment Event]
B -->|Archive/Resolve| F[Resolution Event]
end
subgraph Background["Background Processing"]
C --> G[Qualytics API]
D --> H[Sync Worker]
E --> I[Sync Worker]
F --> J[Sync Worker]
end
subgraph Jira["Jira Instance"]
G -->|POST /issue| K[New Issue Created]
H -->|POST /comment| L[Comment Added]
I -->|POST /comment| L
J -->|POST /comment| M[Resolution Comment]
end
K --> N[Ticket Link Stored]
N --> O[Anomaly & Issue Linked]
What Gets Synced
Qualytics writes to the linked issue, and reads the issue's status, summary and comments back. Writing happens only for issues synced two-way, see Read only and two-way sync.
| Direction | Action | Result | Status |
|---|---|---|---|
| Qualytics → Jira | Create ticket from anomaly | New issue created with the anomaly's details (see Create a Jira Ticket) | |
| Qualytics → Jira | Acknowledge anomaly | Comment added to issue with status change. With status sync on, the issue also moves to the mapped status | |
| Qualytics → Jira | Archive anomaly (resolve) | Comment added to issue with resolution status. With status sync on, the issue also moves to the mapped status | |
| Qualytics → Jira | Add comment to anomaly (standalone, on a specific change, or a reply) | Comment pushed to Jira issue | |
| Qualytics → Jira | Link existing ticket | Link stored in Qualytics only. The Jira issue is not modified | |
| Qualytics → Jira | Update Ticket Status Flow action | Issue moved through the matching workflow transition | |
| Jira → Qualytics | Change issue status | Shown on the linked ticket card. With status sync on, a mapped status also moves the anomaly | |
| Jira → Qualytics | Add comments to issue | Mirrored onto the anomaly's timeline (see Comments from Jira) | |
| Jira → Qualytics | Close or resolve issue | Shown on the linked ticket card. With status sync on, the anomaly is archived with the mapped status |
When the read-back happens
Three triggers keep a linked issue's status, summary and comments fresh in Qualytics:
- Opening the anomaly. Viewing an anomaly queues a background refresh of its own linked issues, skipping any that were synced within the last minute so revisits do not call Jira on every page load. The ticket cards open with the last stored data and pick up the refreshed status, summary and comments moments later, while the anomaly stays open.
- A scheduled sweep. Every linked issue is re-read on a background schedule, hourly by default. Self-hosted deployments can tune the interval or disable the sweep.
- A registered webhook (optional). A webhook registered in Jira tells Qualytics the moment an issue changes, so the linked ticket refreshes within seconds instead of waiting for a view or the sweep. The webhook URL is shown on the integration settings; see Register the Jira Webhook.
The webhook payload is only a trigger. Qualytics reads the issue reference from it and re-reads that issue with its own stored credentials, so nothing in the payload is written to the platform, and events for issues that are not linked to any anomaly are ignored.
Authentication
The Jira integration uses Basic Authentication with an email address and an API token (formatted as email:api_token). The API token is generated from Atlassian account settings and grants Qualytics the ability to act on behalf of the account.
See the Configure Jira and Add Connection guides for the full setup flow.
What Happens on Each Operation
Creating and linking issues, what Qualytics appends to a new issue, the two sync modes, the status mapping, and how comments travel in each direction are covered on their own page. See Jira Sync Behavior.
The form a person fills in when creating an issue, with every field it accepts and what each one arrives pre-filled with, is on Create a Jira Ticket.
What the Integration Can Do
Issues
- Create a Jira issue from an anomaly, with the anomaly's context and a link back to Qualytics already in the description.
- Link an issue that already exists, found by key or by summary.
- Link several issues to one anomaly, and the same issue to several anomalies.
- Open issues automatically from a Flow, and move an existing linked issue with the Update Ticket Status action.
Status
- Post a status note to every two-way linked issue when the anomaly is acknowledged or archived.
- Read each issue's status and summary back onto its ticket card.
- Move issues and anomalies together through a status mapping, which is off until an administrator turns it on.
Comments
- Push comments written on the anomaly onto the issue, naming their Qualytics author.
- Mirror comments written on the issue onto the anomaly's Timeline.
- Carry edits and deletions across in both directions.
Control
- Set the whole integration, or one single linked issue, to read only.
- Refresh a linked issue within seconds through a webhook registered in Jira, instead of waiting for the next scheduled read.
What It Does Not Do
- One ticketing integration at a time. A deployment connects either Jira or ServiceNow, and a second one is refused until the first is disconnected.
- Basic authentication only. The integration authenticates with an Atlassian account email and an API token. OAuth 2.0 is not supported.
- Credentials live in Qualytics. They are stored encrypted by the platform rather than read from an external secrets manager such as HashiCorp Vault.
- Jira Cloud only. The integration calls the Jira Cloud REST API, so a Data Center or Server instance cannot be connected. See Requirements.
See Also
-
Sync Behavior
What happens on each operation, from creating and linking issues to the two sync modes and comments in both directions.
-
Requirements
The Jira instance, the account Qualytics authenticates as, and what it must be allowed to do.
-
Best Practices
Reading the Tickets panel, and the choices that keep issues and anomalies in step.
-
Permissions
The roles, team permissions, and Jira-side permissions each action needs.