agency-board

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

Turn a platform event on for this board.

Усі кінцеві точки agency-board

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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 у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого 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_typestringТак
column_idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
label_idUuidНіUUIDv7 identifier — sortable by creation time (docs/02 §8).
card_visibilitystring<internal, client>Ні
enabledbooleanНі

Відповідь

НазваТипОбов'язковеЩо це таке
idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
event_typestringТак
column_idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
label_idUuidНіUUIDv7 identifier — sortable by creation time (docs/02 §8).
card_visibilitystring<internal, client>Ні
enabledbooleanТак
card_countintegerНі
last_card_atstringНі
created_atstringНі

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422