integrations.health

Check whether the shop's connections are still working

Read-onlyRead budget

REST

Shipping

POST /api/v1/integrations/health

MCP tool

Live

integrations.health

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

Operating contract

THE READ THAT CATCHES A SILENT FAILURE. An integration does not break loudly: a token expires, a scope is revoked at the other end, a webhook endpoint starts failing — and every screen in this product looks exactly the same while the thing quietly stops happening. This is the only place that says so.

worst is one word for the whole shop: healthy, expiring, degraded or broken. attention is the rows somebody actually has to do something about, worst first — and it is usually short, which is what makes it worth acting on.

EVERY ROW CARRIES ITS OWN FIX, in plain words, and that is the field to read out. 'Reconnect Google Business Profile at Settings → Integrations' is actionable; 'status: broken' is not.

expires_at with days_until_expiry is the one to raise EARLY. A token expiring in nine days is a nine-day warning and a zero-cost fix; the same token expiring yesterday is a shop that has been silently disconnected for a day and does not know.

Webhook endpoints are included alongside integrations, because a failing endpoint is the same class of silent failure — the shop's data is not reaching wherever it was meant to go.

DELIBERATELY UNLINKED CONNECTIONS ARE NOT HERE. A shop that disconnected something on purpose does not want a warning about it.

This scans every live connection and returns them all, 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
attention_only	boolean	True returns only the connections that need somebody to act.

Output

Field	Type	Description
worst	string	—
attention_count	number	—
items	object[]	—
items[].kind	string	—
items[].key	string	—
items[].name	string	—
items[].detail	string \| null	—
items[].status	string	—
items[].reason	string	—
items[].summary	string	—
items[].fix	string	—
items[].needs_reconnect	boolean	—
items[].expires_at	string \| null	—
items[].days_until_expiry	number \| 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/integrations/health \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript (fetch)

const res = await fetch("https://www.servicevin.com/api/v1/integrations/health", {
  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/integrations/health",
    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": "integrations.health",
    "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#