agency-board

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

Turn a platform event on for this board.

تمام agency-board اینڈ پوائنٹس

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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_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