board-github
POST /v1/board-github/links
Connect a GitHub Project to this organisation.
ማረጋገጫ
የኤፒአይ ቁልፍ (API key) እንደ ቢረር ቶከን (bearer token) ይላኩ። ይህ የመጨረሻ ነጥብ (endpoint) በመግለጫው ውስጥ የተወሰነ ፈቃድ አልገለጸም፣ ስለዚህ ከማሰብ ይልቅ ለቁልፍዎ የሚያስፈልገውን አነስተኛ ፈቃድ ይስጡት እና ምላሹን ያረጋግጡ።
የድርጅትዎ መታወቂያ የሚገባበት ቦታ
ይህ ማቆሚያ ነጥብ (endpoint) org_idን በJSON አካል ውስጥ እንደ ሜዳ ይወስዳል።
የድርጅትዎ መለያ ቁጥር (ID) በዳሽቦርድዎ ላይ በሚገኙት የኤፒአይ ቁልፎች (API keys) ማያ ገጽ ላይ ከቁልፉ አጠገብ ይገኛል። በሚያደርጉት እያንዳንዱ ጥያቄ ላይ የሚጠቀሙበት መለያ ቁጥር አንድ አይነት ነው።
ሞክሩት
በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።
curl -X POST https://api.zinndigital.com/v1/board-github/links \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "project_node_id": <string>, "project_number": <integer>, "owner_login": <string> }'ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በAPI ኮንሶል ውስጥ ይክፈቱ
ዝርዝሮች
Two-way from the moment it is connected (owner ruling, 2026-09-03). The first sync runs inside this request, so the 201 already carries the project's fields — a connect that returned an empty board and left the customer waiting for the sweep would read as a broken connection. `auth_kind: app` stores only the **installation id**, which is public and appears in the customer's own install URL; nothing long-lived is at rest and an hour-long token is minted per use. `auth_kind: pat` writes the token straight to Vault and never echoes it.
የጥያቄ አካል
| ስም | ዓይነት | የሚያስፈልግ | ምንነቱ |
|---|---|---|---|
project_node_id | string | አዎ | — |
project_number | integer | አዎ | — |
owner_login | string | አዎ | — |
owner_type | string<organization, user> | አይ | — |
auth_kind | GitHubAuthKind | አይ | `app` is the Zinn® GitHub App installation — per-repository scope the customer chooses on GitHub's own screen, revocable by them in one click, belonging to their organisation ra… |
installation_id | string | አይ | — |
token | string | አይ | — |
board_id | string | አይ | Optional. A project may be connected purely for the roll-up and never attached to client work. |
title | string | አይ | — |
org_id | string | አይ | — |
ምላሽ
| ስም | ዓይነት | የሚያስፈልግ | ምንነቱ |
|---|---|---|---|
id | string | አይ | — |
board_id | string | አይ | — |
auth_kind | GitHubAuthKind | አይ | `app` is the Zinn® GitHub App installation — per-repository scope the customer chooses on GitHub's own screen, revocable by them in one click, belonging to their organisation ra… |
installation_id | string | አይ | Public — it appears in the customer's own install URL — and showing it is what lets them confirm on GitHub that they are looking at the right installation. |
has_stored_token | boolean | አይ | Whether a token is held in Vault for this connection. The token itself is never returned. |
project_node_id | string | አይ | — |
project_number | integer | አይ | — |
owner_login | string | አይ | — |
owner_type | string | አይ | — |
title | string | አይ | — |
short_description | string | አይ | — |
closed | boolean | አይ | — |
public | boolean | አይ | — |
direction | GitHubSyncDirection | አይ | `both` is the default (owner ruling, 2026-09-03: a new connection is read-write immediately). `pull` is the honest remedy when a push keeps being refused. |
notice_delivery | GitHubNoticeDelivery | አይ | Where a connection's overdue / gone-quiet / over-WIP notices are allowed to go. Both values raise the same notices and both render them on the board — the difference is delivery… |
views | object[] | አይ | The project's saved views on GitHub, replaced whole on every read so a view deleted there disappears here rather than lingering as a link GitHub answers with a 404. Rendered as… |
url | string | አይ | — |
webhook_state | GitHubWebhookState | አይ | Whether GitHub pushes changes at us, and if not, whose move it is. **Three outcomes and not a boolean.** `automatic` — we created the organisation webhook. `manual` — GitHub wou… |
last_synced_at | string | አይ | When a sync last SUCCEEDED. What the staleness alarm fires off. |
last_attempted_at | string | አይ | When a sync was last ATTEMPTED, stamped for every connection the sweep reaches before the result is read. Two columns rather than one: a cursor only a successful pass advanced w… |
last_error | string | አይ | — |
created_at | string | አይ | — |
fields | GitHubProjectField[] | አይ | The project's fields, with their single-select options and any work-in-progress limits set on them. Returned with the connection rather than fetched separately, because a board… |
ይህ ማብቂያ ሊመልሳቸው የሚችሉ ስህተቶች
401 · 403 · 422