Skip to main content

Broadcast

broadcast sends one body to every other session that is not stale (seen within the last 7 days). The sender is skipped.

Broadcast on the bus: I am rebasing main in 10 minutes, push your branches now.

The tool call and its result:

broadcast { "from": "laptop-api", "body": "I am rebasing main in 10 minutes, push your branches now." }
→ { "ids": [43, 44, 45], "skipped_full": [] }
  • One message is stored per recipient, each with its own id.
  • A recipient with 1000 unacked messages is skipped and listed in skipped_full. The call does not fail.
  • There is no rate limit and no thread_id. Use it sparingly.
  • Push sessions only receive pushes from allowlisted principals (by default their own). Other broadcasts wait in their inbox.