Trigger automation webhook
POST
/webhooks/automation/{webhookId}Request có chữ ký
Được chứng minh bằng X-ReleaseFlow-Signature-256, không phải bằng phiên đăng nhập.
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ú |
|---|---|---|---|
X-ReleaseFlow-Timestamp | string | Tùy chọn | |
X-ReleaseFlow-Delivery | string | Tùy chọn | |
X-ReleaseFlow-Signature-256 | 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: 202
| Trường | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
runId | string (uuid) | Tùy chọn | |
status | enum ExecutionStatus | Tùy chọn | PENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED |
statusPath | 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/automation/$WEBHOOK_ID" \
-H "X-ReleaseFlow-Timestamp: $X_RELEASEFLOW_TIMESTAMP" \
-H "X-ReleaseFlow-Delivery: $X_RELEASEFLOW_DELIVERY" \
-H "X-ReleaseFlow-Signature-256: $X_RELEASEFLOW_SIGNATURE_256" \
-H "Content-Type: application/json" \
--data-binary @payload.json
Response
202Ví dụ
{
"runId": "<uuid>",
"status": "PENDING",
"statusPath": "<string>"
}