agency-board
POST /v1/agency/boards/{boardId}/event-subscriptions
Turn a platform event on for this board.
Autentikasi
Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
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> }'Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
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.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
boardId (path) | Uuid | Ya | Project board ID (UUIDv7). |
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
event_type | string | Ya | — |
column_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | Tidak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | Tidak | — |
enabled | boolean | Tidak | — |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
event_type | string | Ya | — |
column_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | Tidak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | Tidak | — |
enabled | boolean | Ya | — |
card_count | integer | Tidak | — |
last_card_at | string | Tidak | — |
created_at | string | Tidak | — |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422