Docs & Code Guide

Embed a diagram in Jira: why external images do not render, and what to do instead

By the engineer who builds Datadef, from client work on data platforms · Reviewed August 21, 2026

Someone drops an architecture screenshot into a Jira work item, the ticket gets resolved, and eighteen months later a new engineer finds that screenshot through search and believes it. Jira makes this easy because of how it stores images: every picture in a work item is a copy Jira holds, taken at the moment it was attached. This page covers what the editor actually accepts, why an external image URL is not one of those things, and the split that keeps a Jira project honest.

7 min readFor teams whose architecture arguments happen in Jira work items

See it as a diagram

Everything below, as a diagram you can edit. Describe yours and see it in seconds.

131/20003 credits left
Try:

No account needed · Editable canvas, not a picture

Jira shows images it stores, and only those

The Jira Cloud editor stores content as Atlassian Document Format, and its media node points at an attachment id in the Atlassian media store. That is why the documented ways to get a picture into a description are dropping the file onto the work item or using Add and then Attachment. Attachment size is a site setting, and the figure most search results quote is the wrong one: Atlassian's Configure file attachments page puts the Jira Cloud default at 1 GB per file with a 2 GB ceiling, while the 10 MB default belongs to Jira Data Center.

Paste an image URL instead and Jira treats it as a link. Atlassian smart links give you display options for that link, and for a domain Jira has no integration with, the useful options are a plain URL or an inline card. None of them is an inline picture that repaints when the source changes.

Older self-managed Jira renderers accepted wiki markup that took an image address directly, which is why half the answers you find online do not apply to a Cloud site. On Cloud, the choice is an attachment or a link.

A ticket asks an image to do two different jobs

The first job is evidence. What did the topology look like when this incident started, what did the schema look like when this bug was filed. Evidence should freeze. An attached PNG export is exactly right, and its permanence is the feature.

The second job is reference. Someone reading the epic wants to know how the system is wired now, before they estimate the work. A frozen attachment answers that question wrongly and confidently. Reference belongs in a link.

Splitting them costs nothing and removes the failure mode. Attach the export when you are recording a moment. Link the live diagram when you are pointing at the system.

Current architecture (always the live version):
https://datadef.io/embed/my-platform-a1b2c3d4

Attached: architecture-2026-08-21.png (state at the time of the incident)

Where the live picture actually lives for a Jira team

Jira is a work tracker, and work trackers are the wrong home for reference material. The Atlassian answer is the Confluence page next to it, where the iframe macro renders the interactive diagram inline and the work item links to the page. That route is covered in embed a diagram in Confluence.

For engineering-owned systems, the other home is the repository README, where a markdown image line renders the current diagram to anyone reading the code. See embed an architecture diagram in a GitHub README.

The Jira work item then holds one line: a link to the reference, plus whatever evidence the ticket needed frozen.

FAQ

Can I insert an image from a URL into a Jira work item description?

Not as an inline image on Jira Cloud. The editor stores pictures as attachments in Atlassian media storage, so images arrive by dropping a file on the work item or through Add and then Attachment. A pasted image address becomes a smart link, which you can display as a URL or an inline card but not as a live picture.

Why does the diagram attached to an old Jira ticket no longer match the system?

Because it never could. An attachment is a copy of the image at the moment it was uploaded, stored by Jira and unaffected by anything that happens to the original afterwards. Use attachments when you want a frozen record of a moment, and a link when you want the current state.

Does someone opening the diagram link need a Datadef account?

No. A project shared publicly serves both an image URL and a chrome-less interactive page that anyone can open without signing in. That is what makes the link usable for people outside your Jira licence, such as contractors or auditors.

What image size should I attach to a Jira work item?

The default export is 1600 by 1000 at 2x scale, which reads well in the Jira viewer. The export endpoint accepts a width from 600 to 4000, a height from 400 to 4000, and a scale from 1 to 3, as PNG or JPEG. Attachment size is not the constraint people expect: Jira Cloud defaults to 1 GB per file, and the widely quoted 10 MB limit is the Jira Data Center default.

Can the diagram update itself when the code changes?

Yes, when it is generated from a connected repository. A read-only connection to GitHub, GitLab or Azure DevOps regenerates the diagram and an architecture doc on a daily sync, and an agent connected to the MCP server can trigger a refresh after a merge. Nothing watches your repository in real time; the refresh is a sync or one call away.