Chuyển tới nội dung chính

Receive GitHub webhook

POST/webhooks/github/{webhookId}
Request có chữ ký

Được chứng minh bằng X-Hub-Signature-256, không phải bằng phiên đăng nhập.

POST /webhooks/github/{webhookId} không cần phiên đăng nhập hay CSRF token. ReleaseFlow kiểm tra X-Hub-Signature-256 bằng chính secret của kết nối đó trước khi đọc payload, và lấy Organization cùng Project từ kết nối, không bao giờ từ payload. Các phản hồi:

Đọc thêm: Nhận webhook từ GitHubMã nguồn: GitHubWebhookController#receive(mở trong thẻ mới)

Tham số đường dẫn​

TênKiểuBắt buộcGhi chú
webhookIdstringBắt buộc

Header​

TênKiểuBắt buộcGhi chú
X-Hub-Signature-256stringTùy chọn
X-GitHub-EventstringTùy chọn
X-GitHub-DeliverystringTùy chọn

Request body​

application/json · Body là tùy chọn.

Payload JSON của nhà cung cấp, đúng như khi được ký.

Response​

Thành công: 200

TrườngKiểuBắt buộcGhi chú
outcomestringTùy chọn

Lỗi​

Trạng tháiMãÁp dụng cho
400invalid_parametermột tham số trên đường dẫn hoặc query bị thiếu hoặc không chuyển đổi được, chẳng hạn một ID không phải UUIDMọi endpoint
404not_foundkhông có địa chỉ đóMọi endpoint
405method_not_allowedđịa chỉ không nhận phương thức đóMọi endpoint
415unsupported_media_typeđịa chỉ không đọc body thuộc kiểu đóMọi endpoint
500internal_errormột lỗi ReleaseFlow không lường trước; body không bao giờ chứa exception gây ra nóMọi endpoint
400webhook_payload_malformedKhu vực Webhooks
401webhook_signature_invalidKhu vực Webhooks
413webhook_payload_too_largeKhu vực Webhooks
422webhook_repository_mismatchKhu vực Webhooks

Request

bash
# Sign the exact bytes of payload.json with the webhook secret (see the guide).
curl -X POST "http://localhost:8080/webhooks/github/$WEBHOOK_ID" \
-H "X-Hub-Signature-256: $X_HUB_SIGNATURE_256" \
-H "X-GitHub-Event: $X_GITHUB_EVENT" \
-H "X-GitHub-Delivery: $X_GITHUB_DELIVERY" \
-H "Content-Type: application/json" \
--data-binary @payload.json

Response

200

Ví dụ

{
  "outcome": "<string>"
}