Read & Acknowledge — Documentation

Page Confirmations for Confluence Cloud · Version 1.0 · Runs on Atlassian

Read & Acknowledge adds an explicit "I have read and understood" step to any Confluence page, ties each confirmation to the page version, and exports the records as audit evidence.

Getting started (60 seconds)

1. Open the page that people must read (a policy, SOP, runbook, release note).
2. Open the page menu (•••) → Require acknowledgement…
3. Choose a due period (days after each new version) or a fixed date, pick the groups who must confirm (leave empty for everyone), keep weekly reminders on, and press Save.
4. Readers now see Acknowledgement under the page title. Clicking it opens a small panel with the status and the confirmation button.

The first time, Confluence asks each person to allow the app to act on their behalf (Allow access). This is standard for Forge apps and happens once.

Statuses

• Pending — the person has not confirmed the current version.
• Acknowledged — confirmed the current version.
• Outdated — confirmed an earlier version; the page has changed since.
• Overdue — the due date has passed without a valid confirmation.
• Not required — the person is not in a required group (they can still confirm voluntarily).

How page versions affect confirmations

The app computes a fingerprint of the page title and content. When a new version changes the content, earlier confirmations become Outdated and are requested again. Cosmetic edits that do not change the content (spacing, formatting of macros) are detected automatically and do not reset confirmations. A page editor can also mark the current version as minor in the report (or revert that) if a change does not require re-reading.

Reminders and the ack-required label

• Once a week the app posts one comment on each tracked page that @mentions people from the required groups who still owe a confirmation. Confluence delivers the notification by e-mail — no extra tools needed. Reminders work only for policies with groups (for "everyone" the app cannot list who is missing).
• Add the label ack-required to any page and it is enrolled automatically within an hour, using the site-wide defaults. Administrators can change the label and the defaults in Confluence settings → Read & Acknowledge.

Reports and export

• Page report — page menu ••• → Require acknowledgement… → Report: confirmed / pending / outdated / overdue per person, filters, Export CSV.
• Space overview — space sidebar → Apps → Acknowledgements: every tracked page with coverage, due date and overdue flag; click a row for the page report; CSV export.
• My acknowledgements — Apps menu → My acknowledgements: what you still need to confirm and what you have confirmed.
• Audit log (admins) — Confluence settings → Read & Acknowledge → Audit log: every confirmation with its hash chain, verification status and CSV export.

CSV files include person, account ID, page, versions, timestamps (UTC) and record hashes, so they can be attached to a SOC 2 / ISO 9001 / ISO 27001 audit request or used as a training record.

Security and data

The app runs entirely on the Atlassian Forge platform (Runs on Atlassian): no external servers, no third-party calls. It stores account IDs, timestamps, page IDs, versions and content hashes in Forge storage within your site's region. Confirmation records form an append-only, hash-chained log; any modification of history is detectable. See the Privacy Policy for details.

FAQ

Why did my confirmation reset? The page content changed. Read the new version and confirm again.

Who can see the report? Anyone who can view the page can see its report; settings can be changed only by people who can edit the page; the full audit log is for Confluence administrators.

Can we require confirmation from everyone? Yes — leave groups empty. The report then lists who confirmed; pending people cannot be enumerated and reminders are not sent.

Does it send e-mails? Not directly. Reminder comments @mention people; Confluence sends the notification according to each person's settings.

Where is the data stored and for how long? In Forge storage in your Atlassian region. Settings and version snapshots are removed with the page; the confirmation log is kept while the app is installed and removed on uninstall.

Support

E-mail: andrew@andrewboyko.name. Please include your site URL (no page content needed) and a description of what you expected.