agency-board

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

Turn a platform event on for this board.

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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