Skip to main content

Integration guideSeal API and ScriptsAlpha

Jira

Link issues to deviations, CAPAs and change orders.

Illustration of a seal beside a laptop showing a data table and an evidence binder linked by a red thread.

Jira and SealSeal API and Scripts

Seal reads
The issue types, fields and status changes you agree
Writes back
The fields and status changes you agree
Source of truth
Agreed when scoped
Set up
Scoped with your team
Neil › Linked record review
draft

Link these Jira records to the change they support.

Neil

  • Once the connection is configured, I’ll use the records it provides and cite each one. Anything it doesn’t supply stays listed as missing.
Reads
The issue types, fields and status changes you agree
Returns
  • Jira records and the work they support
  • Missing or unmatched information
  • Next steps for your team to review
Illustrative work with Jira: a request to Neil, the source it reads and the draft it returns for your review.

1What’s connected.

Link Jira issues to Seal deviations, CAPAs and change orders through a connection set up with Seal’s API or Scripts. Agree which issue types, fields and status changes are exchanged, and which system owns each record.

Connection setup and permissions

Use Seal’s APIs or scripting engine for a connection tailored to your process. Agree the data mapping, access and direction of transfer before implementation.

2Link Jira issues to deviations, CAPAs and change orders.

Route

Editing an issue never changes its status: a transition is a separate call, and the transitions available depend on the current status. Edit and create metadata list the fields that can be set.⁠¹ A remote issue link points a Jira issue at a record in another system, and issue properties store JSON against the issue.⁠²³

Record identity

Issues are addressed by ID or key. For a moved issue, Jira returns the current key without a redirect, so keep the ID.⁠¹ A remote issue link with a globalId is updated if one exists and created if not, and any field left out is set to null.⁠²

Revisions

Each issue has a paginated changelog, and webhook payloads include one only for issue updates.⁠¹⁴

When it fails

The same event arrives twice
Webhooks may be delivered more than once and are retried up to five times. The X-Atlassian-Webhook-Identifier header stays the same across retries.⁠⁴ Ignore an identifier that has already been processed.
Events stopped arriving
Webhooks registered through the REST API expire after 30 days.⁠⁴ Refresh the registration before it expires.
Calls are refused with 429
Rate limits return 429 with Retry-After, and per-endpoint burst limits apply even within the hourly quota.⁠⁵ Wait as Retry-After says, then try again.

Check one record

Link one Jira issue to a test deviation in Seal. Move the issue to another project and confirm the link still resolves by issue ID. Then transition it and confirm the Seal record shows the status change once.

3Start with the job.

Tell us what Neil needs to do and which records it needs. We’ll confirm the interface, permissions and implementation scope with your team.

Discuss this connection →

4Before it goes live.

Access and any write-back

Define which records are in scope and whose permissions apply. Whether the connection writes back at all is a separate decision, with its own mapping and approval.

Verification and release

Review the configured connection for its intended use. Keep the requirements, checks and evidence with the change, and approve the release through your team’s controls.

Read the assurance detail →

References

  1. 1Jira Cloud REST API: issues.
  2. 2Jira Cloud REST API: remote issue links.
  3. 3Jira Cloud REST API: issue properties.
  4. 4Jira Cloud: webhooks.
  5. 5Jira Cloud: rate limiting.