← Receivers

human:notify

human family

Post a channel-shaped approval into a run's conversation when it suspends at a human step — web card · Telegram inline keys · Discord components. Sibling of chat:send.

Effect
signal
Fire-and-forget — the call returns once accepted, not once done.
Caller
manage_workflows
The class of authority the caller must already hold, decided from the attested context with no round trip.
Cost
free
What one call costs, so you can budget before acting.
Reversible
yes
The effect can be undone by a later call.
Idempotent
yes
Safe to retry as-is.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code
Codex
Cursor
Gemini CLI
Claude Desktop
ChatGPT
curl -X POST https://one.ie/api/signal/human:notify \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "runId": "run_1", "stepId": "s2", "stepName": "Approve contract" }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

  • runId string required
  • stepId string required
  • stepName string optional
  • workflowName string optional
  • group string optional

Response

The acknowledgement shape — the work itself completes after the call returns.

  • ok boolean
  • group string
  • error string

Traffic

Every call to human:notify, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names human:notify, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

UI 1
  • one.ie/web/src/pages/twilio.astro:99
API route 3
  • one.ie/web/src/lib/chat/conversation-key.ts:11
  • one.ie/web/src/lib/step-ceiling.ts:17
  • one.ie/web/src/workers/WorkflowRun.ts:377
Agent runtime 2
  • channels/src/channels/voice.ts:93
  • channels/src/index.ts:504
Workflow 2
  • one.ie/web/src/lib/workflow-receivers.ts:462
  • one.ie/web/src/lib/workflow-templates.ts:1057
Docs 2
  • one.ie/web/src/content/docs/workflows.md:62
  • one.ie/web/src/lib/CLAUDE.md:26

Answered by

human:notify one.ie/web/src/lib/resolvers/messaging.ts:897 Dispatched through POST /api/signal/human:notify, after the envelope validates the payload.

human family · 1 more

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "runId": {
      "type": "string"
    },
    "stepId": {
      "type": "string"
    },
    "stepName": {
      "type": "string"
    },
    "workflowName": {
      "type": "string"
    },
    "group": {
      "type": "string"
    }
  },
  "required": [
    "runId",
    "stepId"
  ]
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "group": {
      "type": "string"
    },
    "error": {
      "type": "string"
    }
  },
  "required": [
    "ok"
  ]
}