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:
Tham số đường dẫn
| Tên | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
webhookId | string | Bắt buộc |
Header
| Tên | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
webhook-id | string | Tùy chọn | |
webhook-timestamp | string | Tùy chọn | |
webhook-signature | string | Tùy chọn | |
X-Gitlab-Token | string | Tùy chọn | |
X-Gitlab-Event | string | Tùy chọn | |
X-Gitlab-Event-UUID | string | Tù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ường | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
outcome | string | Tùy chọn |
Lỗi
| Trạng thái | Mã | Áp dụng cho |
|---|---|---|
400 | invalid_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 UUID | Mọi endpoint |
404 | not_foundkhông có địa chỉ đó | Mọi endpoint |
405 | method_not_allowedđịa chỉ không nhận phương thức đó | Mọi endpoint |
415 | unsupported_media_typeđịa chỉ không đọc body thuộc kiểu đó | Mọi endpoint |
500 | internal_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 |
400 | webhook_payload_malformed | Khu vực Webhooks |
401 | webhook_signature_invalid | Khu vực Webhooks |
413 | webhook_payload_too_large | Khu vực Webhooks |
422 | webhook_repository_mismatch | Khu 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
200Ví dụ
{
"outcome": "<string>"
}