Get pipeline health

Operational health of this workspace's sending pipeline: due and overdue messages with the oldest due age, approvals pending, current holds by reason, the last successful run, the last delivery event per type, send errors in the last 24 hours by code, paused seats by reason and open manual tasks. status is failing when no run succeeded in 30 minutes; degraded when a message is overdue by 30 minutes, a send failed in 24 hours, an emergency stop or compliance hold is holding messages, or a seat is paused; otherwise ok. reasons lists why. Changes nothing.

Outcome

Before you start

Verify the intended environment, signed-in credential, authorized organization and the action permission workspace:read.
Discover and select an authorized canonical Engage workspace. Pass resourceType=workspace and resourceId separately from action input.

Discover the target

topolo whoami --json
topolo actions get app_topolo_engage.ops.health.get --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

This action accepts an empty input object ({}). Resource context is supplied separately when required.

Validate, plan and execute

Build payload.json from the current schema and discovered identifiers. The action description above defines its behavior, limits, side effects and declared errors.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions validate app_topolo_engage.ops.health.get --data @payload.json --json
topolo actions plan app_topolo_engage.ops.health.get --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --json

Execute the unchanged validated read.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions call app_topolo_engage.ops.health.get --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --json

For MCP, use topolo_get_action, topolo_validate_action, topolo_plan_action and topolo_call_action. Pass resource context separately where required; confirm:true is required for mutations.

Captured successful requests and responses

Captured HTTP 200 · the runner on a WhatsApp template step > holds as whatsapp_not_permitted when Nexus refuses Engage, for a day, and surfaces it in ops holds

Action input

{}

Actual local response

{
  "health": {
    "status": "failing",
    "reasons": [
      "no_successful_run"
    ],
    "checkedAt": "2026-10-06T08:30:00.000Z",
    "thresholds": {
      "runStaleMinutes": 30,
      "overdueMinutes": 30,
      "errorWindowHours": 24,
      "retentionDays": 30
    },
    "queue": {
      "dueNow": 0,
      "overdue": 0,
      "oldestDueAt": null,
      "approvalsPending": 0,
      "oldestDueAgeSeconds": null
    },
    "holds": {
      "emergency_stop": 0,
      "compliance_hold": 0,
      "approval_pending": 0,
      "cap_reached": 0,
      "seat_paused": 0,
      "ineligible": 0,
      "channel_unavailable": 1,
      "other": 0
    },
    "runs": {
      "lastSuccessfulRunAt": null,
      "lastRunAt": null,
      "lastRunStatus": null,
      "lastWorkspaceRunAt": null
    },
    "events": [],
    "errors24h": [],
    "pausedSeats": {
      "total": 0,
      "byReason": []
    },
    "tasks": {
      "open": 0,
      "overdue": 0
    }
  }
}

Source test: the runner on a WhatsApp template step > holds as whatsapp_not_permitted when Nexus refuses Engage, for a day, and surfaces it in ops holds. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · ops.health.get > reports an empty, never-run workspace as failing

Action input

{}

Actual local response

{
  "health": {
    "status": "failing",
    "reasons": [
      "no_successful_run"
    ],
    "checkedAt": "2026-10-06T08:30:00.000Z",
    "thresholds": {
      "runStaleMinutes": 30,
      "overdueMinutes": 30,
      "errorWindowHours": 24,
      "retentionDays": 30
    },
    "queue": {
      "dueNow": 0,
      "overdue": 0,
      "oldestDueAt": null,
      "approvalsPending": 0,
      "oldestDueAgeSeconds": null
    },
    "holds": {
      "emergency_stop": 0,
      "compliance_hold": 0,
      "approval_pending": 0,
      "cap_reached": 0,
      "seat_paused": 0,
      "ineligible": 0,
      "channel_unavailable": 0,
      "other": 0
    },
    "runs": {
      "lastSuccessfulRunAt": null,
      "lastRunAt": null,
      "lastRunStatus": null,
      "lastWorkspaceRunAt": null
    },
    "events": [],
    "errors24h": [],
    "pausedSeats": {
      "total": 0,
      "byReason": []
    },
    "tasks": {
      "open": 0,
      "overdue": 0
    }
  }
}

Source test: ops.health.get > reports an empty, never-run workspace as failing. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · ops.health.get > snapshots the pipeline of this workspace only

Action input

{}

Actual local response

{
  "health": {
    "status": "degraded",
    "reasons": [
      "messages_overdue",
      "send_errors",
      "emergency_stop",
      "compliance_hold",
      "seats_paused"
    ],
    "checkedAt": "2026-10-06T08:30:00.000Z",
    "thresholds": {
      "runStaleMinutes": 30,
      "overdueMinutes": 30,
      "errorWindowHours": 24,
      "retentionDays": 30
    },
    "queue": {
      "dueNow": 2,
      "overdue": 1,
      "oldestDueAt": "2026-10-06T07:50:00.000Z",
      "approvalsPending": 1,
      "oldestDueAgeSeconds": 2400
    },
    "holds": {
      "emergency_stop": 1,
      "compliance_hold": 1,
      "approval_pending": 1,
      "cap_reached": 1,
      "seat_paused": 0,
      "ineligible": 0,
      "channel_unavailable": 0,
      "other": 0
    },
    "runs": {
      "lastSuccessfulRunAt": "2026-10-06T08:30:00.000Z",
      "lastRunAt": "2026-10-06T08:30:00.000Z",
      "lastRunStatus": "succeeded",
      "lastWorkspaceRunAt": "2026-10-06T08:20:00.000Z"
    },
    "events": [
      {
        "eventType": "nexus.email.bounced.soft",
        "lastReceivedAt": "2026-10-06T08:10:00.000Z"
      },
      {
        "eventType": "nexus.email.delivered",
        "lastReceivedAt": "2026-10-06T08:15:00.000Z"
      }
    ],
    "errors24h": [
      {
        "code": "network_error",
        "count": 1
      },
      {
        "code": "upstream_unavailable",
        "count": 1
      }
    ],
    "pausedSeats": {
      "total": 2,
      "byReason": [
        {
          "code": "manual",
          "count": 1
        },
        {
          "code": "unspecified",
          "count": 1
        }
      ]
    },
    "tasks": {
      "open": 2,
      "overdue": 1
    }
  }
}

Source test: ops.health.get > snapshots the pipeline of this workspace only. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · ops.health.get > counts a workspace's own manual run as success, and goes stale after 30 minutes

Action input

{}

Actual local response

{
  "health": {
    "status": "ok",
    "reasons": [],
    "checkedAt": "2026-10-06T08:30:00.000Z",
    "thresholds": {
      "runStaleMinutes": 30,
      "overdueMinutes": 30,
      "errorWindowHours": 24,
      "retentionDays": 30
    },
    "queue": {
      "dueNow": 0,
      "overdue": 0,
      "oldestDueAt": null,
      "approvalsPending": 0,
      "oldestDueAgeSeconds": null
    },
    "holds": {
      "emergency_stop": 0,
      "compliance_hold": 0,
      "approval_pending": 0,
      "cap_reached": 0,
      "seat_paused": 0,
      "ineligible": 0,
      "channel_unavailable": 0,
      "other": 0
    },
    "runs": {
      "lastSuccessfulRunAt": "2026-10-06T08:30:00.000Z",
      "lastRunAt": null,
      "lastRunStatus": null,
      "lastWorkspaceRunAt": "2026-10-06T08:30:00.000Z"
    },
    "events": [],
    "errors24h": [],
    "pausedSeats": {
      "total": 0,
      "byReason": []
    },
    "tasks": {
      "open": 0,
      "overdue": 0
    }
  }
}

Source test: ops.health.get > counts a workspace's own manual run as success, and goes stale after 30 minutes. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · ops.health.get > snapshots the pipeline of this workspace only

Action input

{}

Actual local response

{
  "health": {
    "status": "ok",
    "reasons": [],
    "checkedAt": "2026-10-06T08:30:00.000Z",
    "thresholds": {
      "runStaleMinutes": 30,
      "overdueMinutes": 30,
      "errorWindowHours": 24,
      "retentionDays": 30
    },
    "queue": {
      "dueNow": 0,
      "overdue": 0,
      "oldestDueAt": null,
      "approvalsPending": 0,
      "oldestDueAgeSeconds": null
    },
    "holds": {
      "emergency_stop": 0,
      "compliance_hold": 0,
      "approval_pending": 0,
      "cap_reached": 0,
      "seat_paused": 0,
      "ineligible": 0,
      "channel_unavailable": 0,
      "other": 0
    },
    "runs": {
      "lastSuccessfulRunAt": "2026-10-06T08:30:00.000Z",
      "lastRunAt": "2026-10-06T08:30:00.000Z",
      "lastRunStatus": "succeeded",
      "lastWorkspaceRunAt": null
    },
    "events": [
      {
        "eventType": "nexus.email.replied",
        "lastReceivedAt": "2026-10-06T08:29:00.000Z"
      }
    ],
    "errors24h": [],
    "pausedSeats": {
      "total": 0,
      "byReason": []
    },
    "tasks": {
      "open": 0,
      "overdue": 0
    }
  }
}

Source test: ops.health.get > snapshots the pipeline of this workspace only. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · ops.health.get > counts a workspace's own manual run as success, and goes stale after 30 minutes

Action input

{}

Actual local response

{
  "health": {
    "status": "failing",
    "reasons": [
      "no_successful_run"
    ],
    "checkedAt": "2026-10-06T09:01:00.000Z",
    "thresholds": {
      "runStaleMinutes": 30,
      "overdueMinutes": 30,
      "errorWindowHours": 24,
      "retentionDays": 30
    },
    "queue": {
      "dueNow": 0,
      "overdue": 0,
      "oldestDueAt": null,
      "approvalsPending": 0,
      "oldestDueAgeSeconds": null
    },
    "holds": {
      "emergency_stop": 0,
      "compliance_hold": 0,
      "approval_pending": 0,
      "cap_reached": 0,
      "seat_paused": 0,
      "ineligible": 0,
      "channel_unavailable": 0,
      "other": 0
    },
    "runs": {
      "lastSuccessfulRunAt": "2026-10-06T08:30:00.000Z",
      "lastRunAt": null,
      "lastRunStatus": null,
      "lastWorkspaceRunAt": "2026-10-06T08:30:00.000Z"
    },
    "events": [],
    "errors24h": [],
    "pausedSeats": {
      "total": 0,
      "byReason": []
    },
    "tasks": {
      "open": 0,
      "overdue": 0
    }
  }
}

Captured HTTP 200 · ops.health.get > counts a workspace's own manual run as success, and goes stale after 30 minutes

Action input

{}

Actual local response

{
  "health": {
    "status": "failing",
    "reasons": [
      "no_successful_run"
    ],
    "checkedAt": "2026-10-06T09:01:00.000Z",
    "thresholds": {
      "runStaleMinutes": 30,
      "overdueMinutes": 30,
      "errorWindowHours": 24,
      "retentionDays": 30
    },
    "queue": {
      "dueNow": 0,
      "overdue": 0,
      "oldestDueAt": null,
      "approvalsPending": 0,
      "oldestDueAgeSeconds": null
    },
    "holds": {
      "emergency_stop": 0,
      "compliance_hold": 0,
      "approval_pending": 0,
      "cap_reached": 0,
      "seat_paused": 0,
      "ineligible": 0,
      "channel_unavailable": 0,
      "other": 0
    },
    "runs": {
      "lastSuccessfulRunAt": null,
      "lastRunAt": null,
      "lastRunStatus": null,
      "lastWorkspaceRunAt": null
    },
    "events": [],
    "errors24h": [],
    "pausedSeats": {
      "total": 0,
      "byReason": []
    },
    "tasks": {
      "open": 0,
      "overdue": 0
    }
  }
}

Effects and response meaning

Operational health of this workspace's sending pipeline: due and overdue messages with the oldest due age, approvals pending, current holds by reason, the last successful run, the last delivery event per type, send errors in the last 24 hours by code, paused seats by reason and open manual tasks. status is failing when no run succeeded in 30 minutes; degraded when a message is overdue by 30 minutes, a send failed in 24 hours, an emergency stop or compliance hold is holding messages, or a seat is paused; otherwise ok. reasons lists why. Changes nothing.

Verify the outcome

Check the response against the declared output schema and the requested operation. For mutations, use the action-specific read described in the action description before any dependent operation.

Recover

For an uncertain result, inspect current retained state with a read action before retrying. Do not replay a mutation unless its contract explicitly guarantees idempotency.

Refused requests

Captured HTTP 403 · ops.health.get > refuses callers without read permission

Action input

{}

Actual local response

{
  "error": {
    "code": "permission_denied",
    "message": "The credential lacks workspace:read.",
    "details": {
      "requiredPermission": "workspace:read"
    }
  }
}

Source test: ops.health.get > refuses callers without read permission. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Error recovery

HTTP 403 permission_denied: Stop and inspect the current credential and selected resource. It needs workspace:read; do not broaden access or switch organization automatically.

Evidence and limits

/api/ops/health
Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.
Widget/bootstrap use actual app handler but mocked worker runtime and app identity.
No gateway execution, live permissions, external delivery or deployed proof.

These are local route captures with synthetic identity and simulated dependencies. They do not prove live authorization, gateway execution, production state, or external delivery.

Get pipeline health

Outcome

Before you start

Discover the target

Input contract

Validate, plan and execute

Captured successful requests and responses

Captured HTTP 200 · the runner on a WhatsApp template step > holds as whatsapp_not_permitted when Nexus refuses Engage, for a day, and surfaces it in ops holds

Captured HTTP 200 · ops.health.get > reports an empty, never-run workspace as failing

Captured HTTP 200 · ops.health.get > snapshots the pipeline of this workspace only

Captured HTTP 200 · ops.health.get > counts a workspace's own manual run as success, and goes stale after 30 minutes

Captured HTTP 200 · ops.health.get > snapshots the pipeline of this workspace only

Captured HTTP 200 · ops.health.get > counts a workspace's own manual run as success, and goes stale after 30 minutes

Captured HTTP 200 · ops.health.get > counts a workspace's own manual run as success, and goes stale after 30 minutes

Effects and response meaning

Verify the outcome

Recover

Refused requests

Captured HTTP 403 · ops.health.get > refuses callers without read permission

Error recovery

Related actions

Evidence and limits