Documentation
OneNote Reports for Jira sends a fresh table of your Jira issues into a OneNote page on a schedule. This page covers install, every-day use, and the answers to the questions people ask most.
What you'll need
- An Atlassian Cloud site where you can install Marketplace apps.
- A Microsoft 365 account with OneNote (work, school, or personal — all supported).
- About two minutes for the first setup.
Getting started
1. Install the app
Install from the Atlassian Marketplace. The app appears in Jira under Apps → OneNote Reports in the left sidebar. The first time you open it, you'll see a Connect Microsoft prompt.
2. Connect your Microsoft account
Click Connect Microsoft. A new browser tab opens to Microsoft's sign-in. Pick the account whose OneNote you want to write to. The consent screen shows two permissions:
Notes.ReadWrite— read and write your OneNote notebooks.User.Read— show your name and email in the app's header so you know which account is connected.
That's all the app can do on the Microsoft side. It cannot read your mail, your files, your calendar, or anything outside the OneNote pages it writes.
After consent, the new tab shows a "Microsoft account connected" page. Close it and return to Jira — the dashboard updates automatically within a few seconds.
3. Create your first report
Click Create your first report. A four-step wizard walks you through the configuration:
- Filter — pick one of your saved Jira filters from the dropdown, or paste JQL directly. The wizard validates against Jira before letting you continue.
- Destination — pick a OneNote notebook and section. The dropdown lists everything your Microsoft account can see. Optionally set a page title template (defaults to the report name; supports
{date},{week},{year}placeholders). - Columns — pick which fields to show in the table. Defaults are Key, Summary, Status, Assignee, Due, and Sprint. The Notes column is on by default — see below for what it does.
- Review — confirm everything and click Create report.
The app creates a new OneNote page in the section you picked and immediately runs the first export. You land back on the dashboard with the new row, an Open in OneNote link, and a green success status.
How refreshes work
Each report refreshes automatically every five minutes when it's Active. Each refresh:
- Re-runs your JQL against Jira (as you — the report's owner).
- Reads the current OneNote page.
- Builds a new table with the latest issues, preserving the Notes column.
- Pushes the new table back, replacing the old one in place. Your freeform paragraphs above and below the table stay untouched.
If new issues appear since the last refresh, they get a fresh row at the top of the table. If issues fall out of the filter (closed, resolved, moved out of scope), they drop to a "Resolved / no longer in filter" section at the bottom so your team can still see the trail of decisions.
The Notes column
Each row carries an optional Notes column on the right that's yours. Type meeting commentary, action items, decisions — anything you want. When the table refreshes, the app reads your existing notes and copies them onto the new rows for the same issues. The mapping is by Jira key, so even if the row order changes, your notes stay attached to the right issue.
If you disable the Notes column when creating the report, refreshes don't touch any external column — your team can still write paragraphs above and below the table, those always stay.
Dashboard actions
Each row on the dashboard has four quick actions on the right:
- History — show the last 25 refreshes for this report with timestamps, source (scheduled / manual / inline), and counts of issues added / updated / resolved / notes preserved. Errors are shown inline if any.
- Run now — force an immediate refresh, regardless of the schedule. The table updates within a couple of seconds.
- Pause / Resume — toggle the schedule. Paused reports keep their config and OneNote page but don't refresh until you resume.
- Delete — remove the report config and its run history from the dashboard. The OneNote page itself is not deleted — you can keep it as an archive or remove it from OneNote yourself.
Disconnecting Microsoft
The Disconnect link in the header (next to your account name) deletes the stored Microsoft refresh token. Your existing reports remain on the dashboard but won't refresh until you reconnect. The OneNote pages themselves are untouched. To reconnect, click Connect Microsoft on the empty-state screen — it's a fresh OAuth flow.
FAQ
Does this sync OneNote edits back to Jira?
No. The app is one-direction only: Jira → OneNote. The Notes column inside the table is yours to edit; everything else reflects the current state of Jira. If you edit a Jira field directly in OneNote, that edit gets overwritten on the next refresh.
Can multiple people on my team see the same OneNote page?
Yes. Page visibility is controlled by OneNote's normal sharing — if your team has access to the section, they see the report. The app doesn't add anything on top.
What if I delete the OneNote page?
The next scheduled refresh detects the missing page and creates a fresh one in the same section. The new page won't have any of the notes from the deleted one — notes only persist while the page exists.
What if I delete the table inside the page but keep the page?
The next refresh appends a fresh table to the bottom of the page. Anything else you wrote on the page stays.
Does it work with Jira Data Center / Server (on-prem)?
Cloud only at this time.
Does it support Microsoft Loop?
Not yet. Loop integration is on the roadmap if there's customer demand.
Is there a free tier?
The app is free during early access. Pricing tiers will be announced before any paid plan is introduced — current users will get advance notice.
How are my tokens stored?
Encrypted at rest with AES-256-GCM under per-deployment keys, never logged. See the security page for the full breakdown.
Getting help
Email support@crosstowntech.com. Include the name of your Jira site and the name of the report that's having trouble — that's enough for us to find your install in our logs and dig in.