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

Receive GitLab webhook

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

Được chứng minh bằng Standard Webhooks headers or X-Gitlab-Token, không phải bằng phiên đăng nhập.

POST /webhooks/gitlab/{webhookId} không cần phiên đăng nhập hay CSRF token, và ReleaseFlow xác minh lần gửi bằng chính secret của nguồn đó trước khi đọc payload. Cách kiểm tra nào được áp dụng là do bạn chọn khi kết nối nguồn:

Đọc thêm: Nhận webhook từ GitLabMã nguồn: GitLabWebhookController#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ú
webhook-idstringTùy chọn
webhook-timestampstringTùy chọn
webhook-signaturestringTùy chọn
X-Gitlab-TokenstringTùy chọn
X-Gitlab-EventstringTùy chọn
X-Gitlab-Event-UUIDstringTù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/gitlab/$WEBHOOK_ID" \
-H "webhook-id: $WEBHOOK_ID" \
-H "webhook-timestamp: $WEBHOOK_TIMESTAMP" \
-H "webhook-signature: $WEBHOOK_SIGNATURE" \
-H "X-Gitlab-Token: $X_GITLAB_TOKEN" \
-H "X-Gitlab-Event: $X_GITLAB_EVENT" \
-H "X-Gitlab-Event-UUID: $X_GITLAB_EVENT_UUID" \
-H "Content-Type: application/json" \
--data-binary @payload.json

Response

200

Ví dụ

{
  "outcome": "<string>"
}