agency-board
POST /v1/agency/boards/{boardId}/event-subscriptions
Turn a platform event on for this board.
Autentifikatsiya
API kalitini bearer token sifatida yuboring. Ushbu yakuniy nuqta spetsifikatsiyada ma'lum bir ruxsatni ko'rsatmaydi, shuning uchun kalitingizga eng kam kerakli huquqni bering va taxmin qilish o'rniga javobni tekshiring.
Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
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> }'Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
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.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
boardId (path) | Uuid | Ha | Project board ID (UUIDv7). |
Soʻrov tanasi
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
event_type | string | Ha | — |
column_id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | Yo'q | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | Yo'q | — |
enabled | boolean | Yo'q | — |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
event_type | string | Ha | — |
column_id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | Yo'q | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | Yo'q | — |
enabled | boolean | Ha | — |
card_count | integer | Yo'q | — |
last_card_at | string | Yo'q | — |
created_at | string | Yo'q | — |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 422