agency-board

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

Turn a platform event on for this board.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`boardId (path)`	`Uuid`	Ano	Project board ID (UUIDv7).

Tělo požadavku

Název	Typ	Požadováno	Co to je
`event_type`	`string`	Ano	—
`column_id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`label_id`	`Uuid`	Ne	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_visibility`	`string<internal, client>`	Ne	—
`enabled`	`boolean`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`event_type`	`string`	Ano	—
`column_id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`label_id`	`Uuid`	Ne	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_visibility`	`string<internal, client>`	Ne	—
`enabled`	`boolean`	Ano	—
`card_count`	`integer`	Ne	—
`last_card_at`	`string`	Ne	—
`created_at`	`string`	Ne	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422

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