Skip to content
GOCUX
Documentation
GOCUX / Documentationapi reference

Reference: create a Pulse definition

Create a versioned monitoring objective for selected project sources.

Create a versioned monitoring objective for selected project sources.

Practical procedure

  1. Supply projectId, title, objective, cadence and timezone.
  2. Choose sourcePolicy.knowledgeSourceIds and materialityPolicy with schemaVersion 1 and rule supported_value_or_support_change; set notificationMode to none or email.
  3. Send an operation-specific Idempotency-Key and review the returned definition before approving it.

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

POST /pulse/monitors
Idempotency-Key: <unique-operation-key>

{
  "projectId": "project-id",
  "title": "Renewal evidence watch",
  "objective": "Observe support for renewal conditions",
  "cadence": "0 9 * * 1",
  "timezone": "Europe/Istanbul",
  "sourcePolicy": {
    "knowledgeSourceIds": [
      "source-id"
    ]
  },
  "materialityPolicy": {
    "schemaVersion": 1,
    "rule": "supported_value_or_support_change"
  },
  "notificationMode": "none"
}

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

A newly created definition does not bypass approval or establish working email delivery. Inspect the first occurrence before relying on its monitoring outcome.

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