agency-board

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

Turn a platform event on for this board.

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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 په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (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_type`	`string`	هو	—
`column_id`	`Uuid`	هو	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`label_id`	`Uuid`	نه	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_visibility`	`string<internal, client>`	نه	—
`enabled`	`boolean`	نه	—

ځواب

نوم	ډول	اړین	دا څه شی دی
`id`	`Uuid`	هو	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	هو	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`event_type`	`string`	هو	—
`column_id`	`Uuid`	هو	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`label_id`	`Uuid`	نه	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_visibility`	`string<internal, client>`	نه	—
`enabled`	`boolean`	هو	—
`card_count`	`integer`	نه	—
`last_card_at`	`string`	نه	—
`created_at`	`string`	نه	—

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 422

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