agency-board

POST /v1/agency/boards/{boardId}/event-subscriptions

Turn a platform event on for this board.

agency-board အားလုံးသော အဆုံးသတ်များ

စစ်မှန်ကြောင်း အတည်ပြုခြင်း

API သော့တစ်ခုကို bearer token အဖြစ် ပေးပို့ပါ။ ဤ အမှတ်အသားအဆုံး (endpoint) သည် သတ်မှတ်ချက်တွင် တိကျသော ခွင့်ပြုချက်တစ်ခုကို မဖော်ပြထားပါသဖြင့်၊ သင့်သော့ကို အနည်းဆုံး လိုအပ်သည်များသာ ပေးအပ်ပြီး မူလအခြေအနေကို ယူဆမည့်အစား တုံ့ပြန်မှုကို စစ်ဆေးပါ။

ဤ အမှတ်ဆက် (endpoint) သည် အဖွဲ့အစည်း အိုင်ဒီ (organisation id) ကို မယူပါ။ သင်၏ သော့ချက် (key) သည် ၎င်းပိုင်ဆိုင်သည့် အဖွဲ့အစည်းကို အလိုအလျောက် ဖော်ထုတ်ပြီးဖြစ်ကာ တုံ့ပြန်ချက်ကိုလည်း ၎င်းနှင့်သာ ကန့်သတ်ထားမည် ဖြစ်သည်။

စမ်းကြည့်ရန်

ထောင့်ချိတ်များအတွင်းရှိ မည်သည့်အရာကိုမဆို သင်၏ကိုယ်ပိုင်တန်ဖိုးများဖြင့် အစားထိုးပြီး သင့်ဒက်ရှ်ဘုတ်မှ သော့ချက်တစ်ခုဖြင့် key ကို အစားထိုးပါ။

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 ကွန်ဆိုးလ်တွင် သင့်၏ တကယ့်အဖွဲ့အစည်း ID နှင့် သင့်ကိုယ်ပိုင်သော့ချက်တို့ဖြင့် ဖြည့်သွင်းပေးပြီး တကယ့်တုံ့ပြန်ချက်ကို သင်မြင်နိုင်ရန် တိုက်ရိုက် API (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို 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