automations.coverage

Find the moments where no automation tells anybody anything

Read-onlyRead budget

REST

Shipping

POST /api/v1/automations/coverage

MCP tool

Live

automations.coverage

Exposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Automations domain.

Operating contract

THE SILENCE AUDIT. It walks every moment in a job's life a customer or the shop should hear about — booked, confirmed, reminded, started, ready, invoiced, chased, followed up — and says who is telling them, or that nobody is.

missing IS THE FINDING and it is the only part most answers need. A moment with a hole is a customer wondering whether the shop forgot them, and it is invisible from every screen in the product precisely because nothing happens.

status reads worst-first: missing (nobody), paused (a rule exists but is switched off), built_in (a product rail does it, possibly only partly), agent (an AI agent that is on already does it), automation (a live rule of the shop's own). Only the last two are somebody's deliberate decision.

gap ON A COVERED MOMENT IS STILL A HOLE. A built-in rail that texts the customer but tells nobody in the shop is covered and incomplete at the same time, and gap is the sentence saying which half is missing.

master_switch_off: true OUTRANKS EVERY ROW BELOW IT. The shop has rules and none of them run. Say that first — fixing individual moments while the master switch is off changes nothing.

texting_off: true means SMS steps cannot send because texting is not live for this shop yet. A rule that texts is then a rule that does nothing, however green it looks.

applies_to_shop: false on a side means the moment does not apply here at all — a shop that takes no deposits needs no deposit reminder — and it is not a hole.

INSTALLING THE STARTER RULES IS NOT A CAPABILITY. It creates up to twenty live rules that text real customers, and the copy is the shop's voice to sign off. Reading the gaps is the half a machine is good at; the press stays a person on /automations.

The whole catalog is assessed and returned, so nothing is truncated.

Who may call it

Permission: shop.manageThe caller must hold shop.manage at the ACT level. A read-only dashboard grant on the same section is refused.
Plan: Every planNo plan gate. Available on every Service VIN plan.
Retries: naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.
Rate class: readCounted against the read budget — the widest of the four.

Input

Field	Type	Description
missing_only	boolean	True returns only the moments with a side nobody covers.
essential_only	boolean	True narrows to the moments the product treats as essential — the short list worth fixing first.

Output

Field	Type	Description
master_switch_off	boolean	—
texting_off	boolean	—
missing_count	number	—
missing_essential_count	number	—
paused_count	number	—
items	object[]	—
items[].key	string	—
items[].title	string	—
items[].when	string	—
items[].stage	string	—
items[].essential	boolean	—
items[].status	string	—
items[].installable	boolean	—
items[].rules	number	—
items[].customer	object \| null	—
items[].customer.should_hear	string	—
items[].customer.status	string	—
items[].customer.covered_by	string \| null	—
items[].customer.gap	string \| null	—
items[].team	object \| null	—
items[].team.should_hear	string	—
items[].team.status	string	—
items[].team.covered_by	string \| null	—
items[].team.gap	string \| null	—

Examples

Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.

curl

export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/automations/coverage \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript (fetch)

const res = await fetch("https://www.servicevin.com/api/v1/automations/coverage", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;

Python (requests)

import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/automations/coverage",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={},
    timeout=30,
)
payload = res.json()
if not res.ok:
    raise RuntimeError(payload["error"]["code"])
data = payload["data"]

MCP tools/call — https://www.servicevin.com/api/mcp

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "automations.coverage",
    "arguments": {}
  }
}

Refusals

The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.

Status	Code	When
404	`not_found`	The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403	`forbidden`	This login does not hold shop.manage.
422	`validation_error`	An argument was wrong. The message names the field.
429	`rate_limited`	Too many read calls. Back off and retry.
500	`internal_error`	Something failed on our side. Nothing was changed.

Operating contract#

Who may call it#

Input#

Output#

Examples#