agency-board

POST `/v1/agency/boards/{boardId}/event-subscriptions`

Turn a platform event on for this board.

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

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.

参数

名称	类型	必填	内容简介
`boardId (path)`	`Uuid`	是	Project board ID (UUIDv7).

请求正文

名称	类型	必填	内容简介
`event_type`	`string`	是	—
`column_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`label_id`	`Uuid`	否	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_visibility`	`string<internal, client>`	否	—
`enabled`	`boolean`	否	—

响应

名称	类型	必填	内容简介
`id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`event_type`	`string`	是	—
`column_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`label_id`	`Uuid`	否	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_visibility`	`string<internal, client>`	否	—
`enabled`	`boolean`	是	—
`card_count`	`integer`	否	—
`last_card_at`	`string`	否	—
`created_at`	`string`	否	—

此端点可能返回的错误

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/event-subscriptions