board-github
POST /v1/board-github/links
Connect a GitHub Project to this organisation.
ದೃಢೀಕರಣ
ಬೀರರ್ ಟೋಕನ್ ಆಗಿ API ಕೀಯನ್ನು ಕಳುಹಿಸಿ. ಈ ಎಂಡ್ಪಾಯಿಂಟ್ ಸ್ಪೆಸಿಫಿಕೇಶನ್ನಲ್ಲಿ ನಿರ್ದಿಷ್ಟ ಅನುಮತಿಯನ್ನು ಸೂಚಿಸುವುದಿಲ್ಲ, ಆದ್ದರಿಂದ ಊಹಿಸುವ ಬದಲು ನಿಮ್ಮ ಕೀಗೆ ಕನಿಷ್ಠ ಅಗತ್ಯವಿರುವದನ್ನು ನೀಡಿ ಮತ್ತು ಪ್ರತಿಕ್ರಿಯೆಯನ್ನು ಪರಿಶೀಲಿಸಿ.
ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ಐಡಿ ಬರುವ ಸ್ಥಳ
ಈ ಎಂಡ್ಪಾಯಿಂಟ್ JSON ಬಾಡಿಯಲ್ಲಿ ಒಂದು ಕ್ಷೇತ್ರವಾಗಿ org_id ಅನ್ನು ತೆಗೆದುಕೊಳ್ಳುತ್ತದೆ.
ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ಐಡಿಯು ನಿಮ್ಮ ಡ್ಯಾಶ್ಬೋರ್ಡ್ನಲ್ಲಿರುವ API ಕೀಗಳ ಪರದೆಯ ಮೇಲೆ, ಕೀ ಯ ಪಕ್ಕದಲ್ಲೇ ಇರುತ್ತದೆ. ನೀವು ಮಾಡುವ ಪ್ರತಿಯೊಂದು ಕರೆ(call)ಯಲ್ಲೂ ಇದು ಒಂದೇ ಐಡಿ ಆಗಿರುತ್ತದೆ.
ಪ್ರಯತ್ನಿಸಿ
ಕೋನೀಯ ಬ್ರಾಕೆಟ್ಗಳಲ್ಲಿರುವ ಯಾವುದೇ ಅಂಶವನ್ನು ನಿಮ್ಮ ಸ್ವಂತ ಮೌಲ್ಯಗಳೊಂದಿಗೆ ಮತ್ತು ಕೀ ಪ್ಲೇಸ್ಹೋಲ್ಡರ್ ಅನ್ನು ನಿಮ್ಮ ಡ್ಯಾಶ್ಬೋರ್ಡ್ನಲ್ಲಿರುವ ಕೀಯೊಂದಿಗೆ ಬದಲಾಯಿಸಿ.
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 ಕನ್ಸೋಲ್ ನಿಮ್ಮ ನೈಜ ಸಂಸ್ಥೆಯ ID ಮತ್ತು ನಿಮ್ಮ ಸ್ವಂತ ಕೀಲಿಯನ್ನು ಭರ್ತಿ ಮಾಡುತ್ತದೆ, ಮತ್ತು ಲೈವ್ API ವಿರುದ್ಧ ವಿನಂತಿಯನ್ನು ರನ್ ಮಾಡುತ್ತದೆ ಆದ್ದರಿಂದ ನೀವು ನಿಜವಾದ ಪ್ರತಿಕ್ರಿಯೆಯನ್ನು ನೋಡಬಹುದು. 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