board-github
POST /v1/board-github/links/{linkId}/sync
Refresh one connection from GitHub now.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/board-github/links/{linkId}/sync \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The Temporal sweep does this every five minutes and the webhook does it in seconds; this is the button for somebody who does not want to wait. Both cursors come back. `last_attempted_at` moves for every attempt and `last_synced_at` only on success — so *"last synced 4 minutes ago"* beside *"last attempted 10 seconds ago"* is how a customer sees that we are trying and GitHub is refusing. One timestamp cannot say that.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
linkId (path) | string | Yes | The GitHub Projects connection. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
ok | boolean | No | A distinct field rather than something inferred from the counts. A project that legitimately has no items and a sync that could not see anything are the same zeros. |
error | string | No | — |
items_seen | integer | No | — |
items_created | integer | No | — |
items_updated | integer | No | — |
items_archived | integer | No | — |
fields_seen | integer | No | — |
conflicts | integer | No | — |
pushed_back | integer | No | Fields OUR value won and were therefore re-pushed to GitHub. Keeping a won value only on our side would be a resolution that resolves nothing and reports the same conflict on th… |
pages | integer | No | — |
last_synced_at | string | No | — |
last_attempted_at | string | No | — |
Errors this endpoint can return
401 · 403 · 404