agency-board
POST /v1/agency/boards/{boardId}/event-subscriptions
Turn a platform event on for this board.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
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> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
boardId (path) | Uuid | Ja | Project board ID (UUIDv7). |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
event_type | string | Ja | — |
column_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | Nein | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | Nein | — |
enabled | boolean | Nein | — |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
event_type | string | Ja | — |
column_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
label_id | Uuid | Nein | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_visibility | string<internal, client> | Nein | — |
enabled | boolean | Ja | — |
card_count | integer | Nein | — |
last_card_at | string | Nein | — |
created_at | string | Nein | — |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422