← Receivers

video:join-event

video family

Record a peer join event for tracking and lifecycle; public — called from the /go/ link handler

Effect
signal
Fire-and-forget — the call returns once accepted, not once done.
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/video:join-event \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "workspace": "acme", "roomSlug": "consult-abc", "role": "guest" }}'

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
  • roomSlug string required
  • role string optional
  • actorId string optional

Response

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

  • ok boolean
  • error string

Traffic

Every call to video:join-event, 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 video:join-event, 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

video:join-event Resolved outside this repo — the pay, channels or api worker answers it. Dispatched through POST /api/signal/video:join-event, after the envelope validates the payload.
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace": {
      "type": "string"
    },
    "roomSlug": {
      "type": "string"
    },
    "role": {
      "type": "string"
    },
    "actorId": {
      "type": "string"
    }
  },
  "required": [
    "workspace",
    "roomSlug"
  ]
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "error": {
      "type": "string"
    }
  },
  "required": [
    "ok"
  ]
}