Skip to content

Report delivery

Colony delivers reports when they seal. Each person subscribes themselves to the reports they want, and a webhook destination can receive the complete sealed report. There is no org-level recipient list and no digest settings page.

Subscriptions are held by people, one per tenant and period.

  1. Open Reporting (/reporting/reports).
  2. Select the tenant.
  3. Subscribe to its day, week or month report, or unsubscribe again.

You manage only your own subscriptions. Nobody can subscribe or unsubscribe someone else, and an administrator cannot add an address to a list on a teammate’s behalf.

Delivery happens when the report seals, which is shortly after each closed UTC day, week or month. There is no send hour and no time zone to set: every subscriber to the same report is told at the same moment.

A report is delivered once. If the seal has already happened, it is not delivered again.

The email carries the report itself. It opens with Colony’s reading of the period, when one exists. The reading is labeled as Colony’s, sits outside the sealed record and can be wrong. Below it come the nine statements, worded as on the report page. The footer names the first characters of the report’s SHA-256 and says that the sealed report and its file are the record; the email is a copy for reading. Open the report links to the sealed report page.

The seal never waits for the reading. If the reading is not ready within a few minutes, the email goes out without it, and the statements are complete either way.

A report reader is someone invited to read sealed reports without a code-host account, such as a finance or delivery lead. Report readers can subscribe to report emails like members can, from the Reports tab, and they manage only their own subscriptions. See Team & Roles.

Emails are retried per recipient if a send fails.

A webhook destination is not a person, so it receives the complete sealed report as data instead of an email.

  1. Open Operations → Settings (Webhooks) (/operations/settings#webhooks). Webhooks belong to your organization, so the same list appears under every tenant, and a webhook receives sealed reports for every tenant in the org.
  2. Add a webhook and subscribe it to the report.sealed event.

When a report seals, Colony delivers a report.sealed event to each enabled webhook subscribed to it. The body carries event, orgId, tenant and report. tenant (id, externalId, name) identifies which tenant’s report sealed. report is the sealed report as stored, including its id and its sha256. Use the sha256 to check that the report you hold is the one that sealed.

Signing, retries and delivery history work as for every other event. See Webhooks.

Any member or report reader can subscribe themselves to reports they can see. Creating and editing webhook destinations needs the Operations grant, which owners and admins hold; see Webhooks.