board-github
POST /v1/board-github/links/{linkId}/webhook
Try again to create the webhook on GitHub, and mint a fresh secret.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X POST https://api.zinndigital.com/v1/board-github/links/{linkId}/webhook \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
For the customer who has just granted the permission that was missing, and for rotating a secret that has been shown to somebody it should not have been. **The secret changes on every call**, so a hook the customer created by hand stops verifying until they paste the new one — which is why the response says which state resulted.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
linkId (path) | string | כן | The GitHub Projects connection. |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
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… |
url | string | כן | The payload URL to paste into GitHub. |
secret | string | לא | The signing secret, returned **only** for a connection the customer must configure themselves. Empty for an App connection, which is signed with the platform app's own secret an… |
events | string[] | כן | The events the hook must subscribe to. `projects_v2_item` alone is not enough: renaming or closing the project emits `projects_v2`, and a board whose title is stale until the ne… |
content_type | string | לא | Always `json`. GitHub's default is `form`, which this endpoint cannot read. |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422