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