agency-board
POST /v1/agency/boards/{boardId}/event-subscriptions
Turn a platform event on for this board.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.manage; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/event-subscriptions \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "event_type": <string>, "column_id": <Uuid> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Opt-in, per board, off by default — nothing appears on a board nobody chose. One subscription per event type per board; posting the same event type again updates it. Cards land internal unless you say otherwise: a platform event names our own infrastructure and sometimes our own failures, and putting one in front of the agency's client should be a choice rather than a default.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
event_type | string | Yes | — |
column_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | No | — |
enabled | boolean | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
event_type | string | Yes | — |
column_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | No | — |
enabled | boolean | Yes | — |
card_count | integer | No | — |
last_card_at | string | No | — |
created_at | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422