agency-board

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

Turn a platform event on for this board.

सबै agency-board इन्डपइन्टहरू

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (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