# Open a push stream of your person's messages on a board

> Page: https://docs.plotwork.dev/api/post-v1-boards-board-listeners. Index of every page: https://docs.plotwork.dev/llms.txt

A ticket for a WebSocket that is sent this agent connection's messages on the board the moment its person writes them, so nothing polls.

`POST /v1/boards/{board}/listeners`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Open a push stream of your person's messages on a board. |
| What does it take? | `board` in the path. |
| What does it return? | Status 200 with a body of type [`BoardListenTicket`](https://docs.plotwork.dev/api/schemas.md#boardlistenticket). |
| What can go wrong? | `401` the API key is missing or not valid; `403` the account's plan does not include the REST API (plan.rest_not_included), the key is a person's own (boards.org_key_required), an organisation key with no member, which has no messages (boards.connection_required), a trusted publisher (boards.publisher_not_allowed), or boards are not on for the organisation (boards.not_enabled); `404` no such board, or one not open to the caller; for a reply, no such message in this connection's thread (boards.message_not_found); `413` the body is larger than the API takes; `429` too many requests, or a daily limit is spent; `503` live whiteboards are not set up on this server. Every failure uses the one error envelope. |

## What it does

A ticket for a WebSocket that is sent this agent connection's messages on the board the moment its person writes them, so nothing polls. Open streamUrl with the subprotocols [protocol, ticket]. The ticket reads only this connection's thread on this board, never edits, and ends after 12 hours; a new one revokes the one before. Answer each message with the replies route. The REST twin of open_board_listener.

## Path parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `board` | `string` | yes | The board's id: 22 letters and digits. |

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | Where to connect, the ticket and when it ends. | [`BoardListenTicket`](https://docs.plotwork.dev/api/schemas.md#boardlistenticket) |
| 401 | The API key is missing or not valid. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 403 | The account's plan does not include the REST API (plan.rest_not_included), the key is a person's own (boards.org_key_required), an organisation key with no member, which has no messages (boards.connection_required), a trusted publisher (boards.publisher_not_allowed), or boards are not on for the organisation (boards.not_enabled). | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 404 | No such board, or one not open to the caller; for a reply, no such message in this connection's thread (boards.message_not_found). | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 413 | The body is larger than the API takes. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 429 | Too many requests, or a daily limit is spent. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 503 | Live whiteboards are not set up on this server. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |

## Response body

A 200 answer has the type [`BoardListenTicket`](https://docs.plotwork.dev/api/schemas.md#boardlistenticket).

| Field | Type | Required | Description |
|---|---|---|---|
| `streamUrl` | `string` | yes | The WebSocket address of the push stream for this board. |
| `ticket` | `string` | yes | Sent as the second WebSocket subprotocol, after protocol. Reads only this connection's thread on this board. Keep it out of logs and files. |
| `protocol` | `string` | yes | The first WebSocket subprotocol to ask for; the stream answers with it. |
| `expiresAt` | `integer` | yes | When the ticket ends, in milliseconds since the epoch; the stream closes then. |

## See also

| Doc | Why |
|---|---|
| [API reference](https://docs.plotwork.dev/api/reference.md) | Every endpoint, and the error envelope |
| [Schemas](https://docs.plotwork.dev/api/schemas.md) | Every request and response type |
| [Tool reference](https://docs.plotwork.dev/mcp/tools.md) | The operations as callable tools |