Skip to content
SarvexDocs
Esc
↑↓navigate↵open⌘Jpreview

Synthetic endpoint-health probe result

RECEIVEops.health.probe_completed
Message
store_idstringrequired
probe_typestringrequired
Allowed:profile_reachablesignature_roundtripnegotiation_handshakecatalog_lookup
outcomestringrequired
Allowed:passfaildegradedtimeout
latency_msinteger
failure_codestring

Closed enum — see internal/planes/control/endpointhealth's FailureCode. Empty when outcome is pass.

detailstring
syntheticbooleanrequired

Always true — carried for symmetry with telemetry_recorded, not because it varies.

Headers
message_idstringrequired

Unique per message; consumers de-duplicate on this.

ordering_keystringrequired

The store_id. Guarantees per-store ordering; the catalog/serving tenant boundary (a store belongs to one merchant — see architecture §2a).

occurred_atstring<date-time>required
sequenceinteger<int64>

Monotonic per-connector sequence carried from the origin signal (ingest events only).

trace_idstring

Correlates a chain of events from one originating cause.

schema_versionstringrequired
Try it
Server
Payload

Live sending isn't possible for pubsub from a browser tab — copy the sample above and run it against your broker.

Message
{
  "store_id": "string",
  "probe_type": "profile_reachable",
  "outcome": "pass",
  "latency_ms": 0,
  "failure_code": "string",
  "detail": "string",
  "synthetic": true
}