push:subscribe

push family

Store a browser's Web Push subscription so notify() can reach the caller off-screen — the send side behind the shipped inbox service worker. Optional slug keys the row to a workspace the caller controls (else their own slug).

Effect: ask; Awaits an outcome — the call returns the response below.
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/ask/push:subscribe \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "endpoint": <string>, "keys": <object> }}'

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.

endpoint string required
keys object required
slug string optional

Response

What comes back from the call.

ok boolean
error string

Traffic

Every call to push: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 push: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

push:subscribe one.ie/web/src/lib/resolvers/messaging.ts:673 Dispatched through POST /api/ask/push:subscribe, after the envelope validates the payload.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "keys": {
      "type": "object",
      "properties": {
        "p256dh": {
          "type": "string"
        },
        "auth": {
          "type": "string"
        }
      },
      "required": [
        "p256dh",
        "auth"
      ]
    },
    "slug": {
      "type": "string"
    }
  },
  "required": [
    "endpoint",
    "keys"
  ]
}

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