Weekly KPI email

What it adds to your app

A weekly schedule over one table. An in-app notification and an email to a role, with week-over-week changes.

How its workflows run

Each one is a server workflow in your project: it runs on its trigger, with retries, and its runs show in the builder's log.

1. Weekly ‹entity› KPIs by email

   On a schedule: schedule weekly ‹day› ‹time› over ‹entity›. Then: Run code, then Notify ‹role›, then Send email.

Set it up

It merges into the contract of an app you already have. Nothing is overwritten: a name you already use is refused until you pass a prefix.

1. Pick the project

   Use the button above, or ask your coding agent with the Appbricx MCP server connected (quickstart).

2. Point it at your tables and roles

   Leave out the ones with defaults; a wrong one is refused with the options your app has.

   Param	What it is	Example
   entity	The table whose rows the report counts.	order
   value_field	Optional: a number field to total and average, such as an amount. Optional.	total
   date_field	The date that puts a row in a week. Optional.	created_at
   group_field	Optional: a choice field to count this week's rows by. Optional.	status
   role	The role that receives the report (every user with it). Optional.	staff
   day	The day it goes out: mon, tue, wed, thu, fri, sat or sun. Optional.	mon
   time	When it goes out, 24-hour HH:MM. Optional.	08:30
   tz	The IANA time zone for the day and time (empty means UTC). Optional.	Europe/London
   format	number or currency. Optional.	currency
   currency	ISO currency code when the format is currency. Optional.	GBP

3. Preview, then apply to dev

   A dry run shows the diff and the check report; applying it changes your dev environment only.

4. Deploy

   When dev looks right, deploy. Production gets a snapshot first, so you can roll back.

Use it with your coding agent

The agent reads the template, runs a dry run, shows you the diff and applies it.

Add the Weekly KPI email template (slug "weekly-kpi-email") to my Appbricx project. Read it with get_template, run use_template with dry_run first and show me the diff, then apply it. Ask me where it attaches if you can't tell from my contract (entity: table to report on; value_field: number to total (optional); date_field: date field; group_field: break down by (optional); role: who gets it; day: day; time: time of day; tz: time zone; format: number format; currency: currency).

{
  "tool": "use_template",
  "arguments": {
    "slug": "weekly-kpi-email",
    "project_id": "<your project id>",
    "params": {
      "entity": "order",
      "value_field": "total",
      "date_field": "created_at",
      "group_field": "status",
      "role": "staff",
      "day": "mon",
      "time": "08:30",
      "tz": "Europe/London",
      "format": "currency",
      "currency": "GBP"
    },
    "dry_run": true
  }
}

appbricx templates use weekly-kpi-email --param entity=order --param value_field=total --param date_field=created_at --param group_field=status --param role=staff --param day=mon --param time=08:30 --param tz=Europe/London --param format=currency --param currency=GBP --dry-run