Skip to content
Engage

Documentation

Build with Engage

Connect customer data, business events, and communication channels to build automated journeys with workflows and AI.

Home

What is happening with the business right now — the week in numbers, the conversations waiting on somebody, and anything that is actually broken. One call, because a home screen made of eleven requests arrives in eleven pieces.

GET /v1/home

{
  "from": "2026-09-17T09:00:00Z",
  "to": "2026-09-24T09:00:00Z",
  "messages": { "sent": 263, "byTeam": 84, "byWorkflows": 121, "byCampaigns": 58,
                "received": 180, "conversationsStarted": 37 },
  "attention": { "waitingOnYou": 7, "oldestWaitingAt": "...", "windowClosing": 2, "suggestions": 3 },
  "people": { "customers": 412, "added": 18, "reachable": 380, "optedOut": 9, "leads": 12 },
  "money": { "sales": 9, "amounts": { "NGN": "214500.00" }, "salesAfterFollowUp": 4 },
  "automations": { "active": 4, "runsStarted": 148, "running": 6, "failed": 0, "triggers": 2 },
  "campaigns": { "sending": 1, "scheduled": 2, "completed": 3, "recipients": 1240 },
  "ai": { "available": true, "enabled": true, "autoReply": true,
          "spentThisMonth": "1.24", "monthlyCapCents": 500, "pausedReason": null },
  "alerts": [],
  "setup": [ { "id": "connect_whatsapp", "label": "Connect WhatsApp", "href": "...", "done": true } ]
}

Open to any member: “what is happening?” is everybody's question. ?from= and ?to= take instants with an offset and default to the last seven days.

What covers the range, and what does not

messages, people.added, money, automations and campaigns are about the range. attention is about now, whatever range you ask for, because it is the question somebody opens the screen to ask: waitingOnYou counts open conversations whose last message is the customer's, and windowClosing is how many of those are near the 24-hour reply window - the one that expires, after which answering costs an approved template.

Alerts

Things that are wrong, each with the screen that fixes it: a channel that is not connected or is reporting an error, a quality rating Meta lowered, an assistant that paused itself at its cap, templates Meta rejected, messages that arrived but never reached the inbox, endpoints of yours that are refusing deliveries. An empty list is the normal answer.

An empty workspace is not a broken one

Nothing here warns about having no customers or no sales yet. A home screen that treats a new business as a faulty one teaches people to scroll past the part that matters.

Setup

Five steps between a new workspace and an automation that runs: connect WhatsApp, add customers, get a template approved, turn on a workflow, send the first message. Each is derived from what is actually in the workspace rather than from a flag somebody ticked, so it cannot tell a business to connect a number they connected last month. Once every step is done, the checklist has served its purpose and the dashboard stops showing it.