agency-board
POST /v1/agency/boards/{boardId}/event-subscriptions
Turn a platform event on for this board.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
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> }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
boardId (path) | Uuid | Tak | Project board ID (UUIDv7). |
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
event_type | string | Tak | — |
column_id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | Nie | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | Nie | — |
enabled | boolean | Nie | — |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
event_type | string | Tak | — |
column_id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | Nie | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | Nie | — |
enabled | boolean | Tak | — |
card_count | integer | Nie | — |
last_card_at | string | Nie | — |
created_at | string | Nie | — |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 422