agency-board

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

Turn a platform event on for this board.

सर्व agency-board एंडपॉइंट्स

प्रमाणीकरण

बेअरर टोकन म्हणून API की पाठवा. या एंडपॉईंटने स्पष्टीकरणामध्ये ठराविक परवानगी नमूद केलेली नाही, त्यामुळे तुमच्या कीला आवश्यक तेवढाच कमीत कमी ॲक्सेस द्या आणि गृहीत धरण्याऐवजी प्रतिसाद तपासा.

या एंडपॉइंटला कोणतीही संस्था आयडी (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 कन्सोल तुमची खरी संस्था आयडी आणि तुमची स्वतःची की आपोआप भरतो आणि लाइव्ह 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