Digests

Not in a released self-host version yet.

A digest is a scheduled summary of what happened in a project, or in a view, since the last one: new issues, regressions, the loudest issues, resolutions, and event totals. Digests are ordinary alert rules with the trigger Daily digest or Weekly digest, created in the same editor. A personal digest goes to your email and in-app inbox. A team digest goes to the rule's channels.

Digests are independent of your alert rules. Turning a digest on or off changes nothing about your alerts, and alert throttles do not apply to digests.

Schedule¶

• Personal digests use the timezone in your account preferences (Account → Preferences). Changing that preference moves your digests with it. The auto preference means "the browser's zone" for display, which the server cannot know, so digests scheduled with auto use UTC.
• Team digests carry their own timezone, which you set on the rule.

Okapi checks for due digests every minute and follows daylight-saving changes in the chosen zone.

Filters¶

A digest accepts two filters, at most one of each: Level (is, at least) and Environment (is). The editor offers only these.

What a digest contains¶

For each project, over the period, a digest counts the events, the new issues, the regressions, and the issues resolved. It then links a few issues:

• Email shows a "New issues" group and a "Regressions" group, each with up to five issues. Only when a project has neither does the email show "Top issues" instead: the five issues with the most events.
• Webhooks get one list of at most five issues per project: new issues first, then regressions, then the loudest issues, with no issue listed twice.
• Slack links at most five issues in the whole digest, not per project, in the same order. It shows a summary line for at most twelve projects.

The headline names the scope and the counts that matter, for example "Daily digest — Checkout: 12 new issues, 3 regressions". The counts line reads like "142 events · 12 new issues · 3 regressions · 5 resolved". Email digests carry a DIGEST badge and the footer "Digests are independent of your alert rules." Webhooks receive digests as kind digest with a digest object — see Webhooks.

A period with nothing to report sends nothing. The schedule moves on to the next period.

The content is fixed when the digest is sent. If a delivery is retried, it repeats the same text; it does not query again.

Digests on a view¶

A digest on a view summarizes all of the view's projects in one message, with a section per project that had something to report. When you create a personal digest on a view, Okapi offers to turn off your default per-project weekly digests for the view's projects, so you do not get both. See Views.

The default weekly digest¶

Every member gets a personal Weekly digest for each new project: Mondays at 09:00 in their timezone, filtered to level at least error, on by default. It is an ordinary rule: edit or delete it like any other. A member who joins later gets one for every existing project. Members and projects that existed before digests do not get one automatically. To add it, create the rule yourself, or press Reset defaults on your personal rules for the project, which adds the weekly digest back. That reset also removes the personal rules you added yourself — see Default rules.

Delivery¶

Digests use the same delivery as alerts: the same retries, destination caps, and History. See Notification channels.

Next: Webhooks.