Broadcast Ping
broadcastSend a custom ping to a room the account belongs to. Pass data.checklist.items to send a checklist the room ticks through together; read the ticks back as checklist_state. Rate-limited. In someone else's personal room only a Pro account may send it, text only (a link in the message is refused too), without title, is_urgent or requires_ack (all three are ignored there), and it counts toward the visitor's two-ping cap; otherwise use trigger_quick_action there.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"invite_code": "<invite_code>",
"message": "<message>"
},
"name": "broadcast"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Arbitrary structured context (max 25 keys / 8KB). Read surfaces return it after connector privacy filtering; do not put secrets in data. data.location is reserved for a shareable location, data.checklist for a checklist, and data.url + data.button_label are reserved for a tappable link ping. data.actions is reserved for up to 3 buttons. | |
| tags | No | Up to 10 labels to file this ping under, so history can later be filtered by one (list_notifications and wait_for_notification take a tag). Each is 1 to 32 characters: lowercase letters, digits, "-" and "_", starting with a letter or digit. Trimmed, lowercased and de-duplicated for you. | |
| title | No | Optional headline. Defaults to the room name, which someone else's personal room always keeps. | |
| message | Yes | Ping body text (max 120 characters in private rooms, 160 in public rooms). | |
| ack_mode | No | With requires_ack: any (default) resolves on the first confirmation; all waits for every original eligible recipient. Read action_state.confirmed_count and required_count for progress. | |
| reply_to | No | Id of the ping this one answers (notification id or correlation id). | |
| is_urgent | No | Deliver time-sensitive so the ping breaks through Focus / Do Not Disturb and reaches members who muted the room or you (a block still wins). Independent of requires_ack: urgent affects delivery only and asks nothing of the recipient. | |
| action_icon | No | Optional emoji shown with the ping. | |
| invite_code | Yes | Room invite code. | |
| replace_key | No | Your own handle for "the ping I keep updating" (1 to 64 characters: letters, digits and . _ : -). Only on a server that has replacing turned on, which is when replace_notification is in your tool list: there a send with a replace_key replaces your earlier ping with the same key in the same room, instead of sending a new one, while that ping is under 24 hours old, replaced fewer than 20 times and replaceable (see replace_notification); the answer is then 200 with the same id and replaced: true. Otherwise, and always while replace_notification is not listed, a new ping is sent and keeps the key. A send that asks for something a replacement cannot do (requires_ack, is_urgent, attachment_ids, tags, action_number, or a different correlation_id, reply_to or action_icon) always sends a new ping. | |
| requires_ack | No | Keep this ping open until its confirmation rule is met, and show it as a lock-screen card with an Acknowledge button. Does not raise the interruption level on its own — combine with is_urgent for an ack that also breaks through Focus. | |
| action_number | No | Optional quick-action slot to attribute the ping to. | |
| attachment_ids | No | Ids of up to 4 uploaded attachments (see upload_attachment) to include. Uploading requires a Pro account. | |
| correlation_id | No | Your own id, echoed back unchanged on read. | |
| ack_timeout_seconds | No | Optional acknowledgement deadline in seconds. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | A privacy-minimized, chainable PingRoom notification result. |