agency-board
POST /v1/agency/boards/{boardId}/event-subscriptions
Turn a platform event on for this board.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
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_type | string | بله | — |
column_id | Uuid | بله | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | خیر | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | خیر | — |
enabled | boolean | خیر | — |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
id | Uuid | بله | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | بله | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
event_type | string | بله | — |
column_id | Uuid | بله | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | خیر | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | خیر | — |
enabled | boolean | بله | — |
card_count | integer | خیر | — |
last_card_at | string | خیر | — |
created_at | string | خیر | — |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 422