board-github

POST /v1/board-github/webhook/{endpointKey}

One GitHub webhook delivery for a linked project.

همه نقاط پایانی board-github

همهٔ مستندات توسعه‌دهندگان

احراز هویت

این نقطه پایانی عمومی است. هیچ مدرک احراز هویت و هیچ سازمانی نمی‌پذیرد — این همان چیزی است که سایت بازاریابی خودمان و موتورهای پاسخ‌دهنده هوش مصنوعی می‌خوانند.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X POST https://api.zinndigital.com/v1/board-github/webhook/{endpointKey}

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Public and unauthenticated — the HMAC is the authentication. GitHub cannot present a session, so X-Hub-Signature-256 over the raw body with this connection's own secret is the whole control. Answers 202 for every valid delivery, including ones we do not act on — a ping, or an event type we ignore. Answering those with an error paints the endpoint permanently red on the customer's own GitHub screen, so a working integration looks broken; the reason field says which. A bad or absent signature is 401 with an empty body: a response that distinguished "no such endpoint" from "wrong secret" would be an oracle for guessing endpoint keys.

پارامترها

نامنوعالزامیچیست
endpointKey (path)stringبلهThe connection's opaque endpoint key, or app for the platform GitHub App's own shared webhook. Not the connection's id — a URL the customer pastes into GitHub ends up in their…

پاسخ

نامنوعالزامیچیست
acceptedbooleanبله
reasonstringخیرWhy a valid delivery was not acted on (ping, an unhandled event, an unlinked project).
link_idstringخیر
queuedbooleanخیر

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401