broadcast:test

Send a test email for a broadcast to one address

Effect: signal; Fire-and-forget — the call returns once accepted, not once done.
Caller: write; The class of authority the caller must already hold, decided from the attested context with no round trip.
Cost: variable; What one call costs, so you can budget before acting.
Reversible: no; This cannot be undone. Dry-run it first where the contract allows.
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/signal/broadcast:test \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "workspace": <string>, "broadcastId": <string>, "to": <string> }}'

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.

workspace string required
broadcastId string required
to string required

Response

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

ok boolean

Traffic

Every call to broadcast:test, 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 broadcast:test, 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/components/newsletter/NewsletterStudio.tsx:227

Agent runtime 1

channels/src/tools/newsletter.ts:109

→

Answered by

broadcast:test one.ie/web/src/lib/resolvers/newsletter.ts:112 Dispatched through POST /api/signal/broadcast:test, after the envelope validates the payload.

broadcast family · 7 more

broadcast:cancel broadcast:create broadcast:get broadcast:list broadcast:schedule broadcast:send broadcast:update

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace": {
      "type": "string"
    },
    "broadcastId": {
      "type": "string"
    },
    "to": {
      "type": "string",
      "format": "email",
      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    }
  },
  "required": [
    "workspace",
    "broadcastId",
    "to"
  ]
}

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