Broadcast Ping
broadcastSend a custom ping to a room the account belongs to. Rate-limited. Not available in personal rooms (use trigger_quick_action there).
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, and data.url + data.button_label are reserved for a tappable link ping. | |
| title | No | Optional headline. Defaults to the room name. | |
| 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. | |
| 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. |