workflow:webhook-subscribe

workflow family

Register a URL that receives every future run's events for one workflow as signed, retried POSTs. Mints a signing secret server-side, returned once.

Effect: ask; Awaits an outcome — the call returns the response below.
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: no; Not safe to blind-retry — dedupe on the envelope idempotencyKey.

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/ask/workflow:webhook-subscribe \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "workflowId": "wf_abc", "url": "https://example.com/hooks/one" }}'

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.

workflowId string required
url string required

Response

What comes back from the call.

ok boolean
subId string
secret string
error string

Traffic

Every call to workflow:webhook-subscribe, 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 workflow:webhook-subscribe, 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

No caller in this repo. It is reached from outside — an agent, your code, or an MCP client.

→

Answered by

workflow:webhook-subscribe one.ie/web/src/lib/workflow-receivers.ts:1836 Dispatched through POST /api/ask/workflow:webhook-subscribe, after the envelope validates the payload.

workflow family · 17 more

workflow:apply-diff workflow:apply-tql workflow:create workflow:delete workflow:fade workflow:get workflow:list workflow:preview-step workflow:run workflow:runs workflow:settled-notify workflow:step-stats workflow:stop workflow:tql workflow:trigger workflow:update workflow:validate

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workflowId": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "workflowId",
    "url"
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "subId": {
      "type": "string"
    },
    "secret": {
      "type": "string"
    },
    "error": {
      "type": "string"
    }
  },
  "required": [
    "ok"
  ]
}