Skip to content
Documentation
GOCUX / Documentationapi reference

Migration reference: change monitoring intent

Review a new objective without silently rewriting an approved definition.

Review a new objective without silently rewriting an approved definition.

Practical procedure

  1. Read the current objective, sources and version and identify what needs to change.
  2. Pause the old monitor when appropriate, then create and approve a new definition for the revised intent through the supported workflow.
  3. Establish a new baseline and keep old occurrences associated with the original definition.

Define an evidence-backed Pulse monitor

Pulse monitors track an objective against selected Knowledge sources. A definition records cadence, timezone, source policy, materiality rule and notification mode. Review and approve the exact definition version before running it. An occurrence records a particular run; it is distinct from the monitor definition and from any resulting email delivery.

Contract example

Developer examples below describe routes on an authorized, configured GoCux control-plane base URL. They are request shapes or operation references, not claims that a particular public hostname exposes the API. Use the workspace for the corresponding human workflow; availability and permissions depend on the actual deployment.

Operation reference for this workflow

GET /pulse/monitors/{monitor_id}
POST /pulse/monitors/{monitor_id}/pause

Inspect the result

Inspect occurrence state and available evidence before reporting a change. A new or missing source passage can change the support for a value even when the displayed value is unchanged. Notification mode can be none or email; choosing email is not evidence that delivery is configured or that a message reached its recipient.

What to keep explicit

The current route set does not establish a generic PATCH monitor operation. Do not forward an external update payload to a guessed endpoint.

Handle incomplete and refused work

Creation requires at least one unique Knowledge source identifier. Decisions and transitions use explicit version checks and Idempotency-Key. A stale definition or a monitor that is not active can return 409. A 503 is unavailable monitor storage or materialization, not a statement that nothing changed. Pause or archive intentionally when the monitoring objective ends.

Bring this workflow into your workspace.

Set the scope. Review the evidence. Approve the steps that need it.

Open the workspace

Keep exploring