DocsNền tảng mở AIKết thúc móc

Kết thúc móc

Dòng chảy làm việc gây nên sự đáp ứng chấp thuận (POST + get one- click).

Điểm kết thúc web được dùng cho "sự kiện đẩy mạnh tích cực từ hệ thống bên ngoài". Hai loại: bộ gây nên dòng chảy làm việc (hệ thống bên ngoài đẩy dữ liệu lên tiến trình thực hiện) và đồng ý gọi lại (hệ thống bên ngoài đẩy quyết định hoàn tất hướng dẫn công việc).

1

POST /api/webhooks/{webhookId}/trigger
Xác thực: Khóa ARI (Bearer / X-API-Key / Scope: WEBHOOK_TRIGGER

Đầu tiên tạo một cây móc Web trong bàn điều khiển: gắn nó vào workflow mục tiêu và chọn một chiếc khóa ADI với phạm vi WRIK. Một hệ thống bên ngoài PSTs một đối tượng JSON (lên 1 MB) đến địa chỉ URL kích hoạt, và các trường cấp cao của trọng tải bản đồ để làm việc với các biến thay đổi thông qua việc gõ hoặc bằng tên khớp.

Đối với các bước tạo đầy đủ, một ví dụ xoắn kích hoạt, các quy tắc thay đổi, bảng lỗi mã, và chế độ tương thích HMAC, xem Khởi động luồng công việc qua WebokTrang này chỉ trang bìa hợp đồng kết thúc mở.

Ranh giới cho phép

kiểm tra kép

Một Webok được gắn với một apiKeyId tại tạo ra. Khi bị kích hoạt, chìa khóa được giải quyết từ biểu tượng yêu cầu phải chính xác là một ký tự khóa (nghĩa đen), và chìa khóa và lưỡi lê phải thuộc cùng một tài khoản. Điều này đảm bảo rằng ngay cả khi một chiếc chìa khóa với ống ngắm bị rò rỉ, nó chỉ có thể kích hoạt các lưỡi câu Web kết nối chặt chẽ với nó, chứ không phải workflow của bất cứ ai khác. Một Webhook được kết nối với một chiếc khóa API không còn chấp nhận chữ ký HMAC.

2. Đáp ứng chấp nhận (phương phápPOST)

POST /api/webhook-trigger/approval
Xác thực: API Key (Bearer) · Scope: APPROVAL_RESPOND

Dùng để đệ trình một quyết định chấp thuận từ một hệ thống bên ngoài (tự động hóa logic, một robot Slack, email thư, vv.). Thi thể yêu cầu ở 64 KB.

bash

curl -X POST https://braidrun.com/api/webhook-trigger/approval \
  -H "Authorization: Bearer dyk_<id>_<secret>" \
  -H "Content-Type: application/json" \
  -d '{
    "approvalId": "<approval-id>",
    "decision": "approve",
    "comment": "Approved by CFO via Slack"
  }'

Đáp ứng thành công:

json

{
  "ok": true,
  "approvalId": "<approval-id>",
  "decision": "approve"
}

Yêu cầu trường

Tìm kiếm	Kiểu	Mô tả
`approvalId`	string	Lấy từ bảng nháp sự kiện cấp phát âm/ danh sách chú thích
`decision`	string	"vớ vẩn" hay "bị nghi ngờ" (vô cảm)
`comment`	string	Tùy chọn, được ghi lại trong lịch sử chấp nhận

Đáp ứng lỗi

trạng thái mã	nghĩa là
`400`	quyết định không được chấp nhận hay từ chối
`401`	API Key không hợp lệ hoặc thiếu scope APPROVAL_RESPOND
`403`	Chủ chìa khóa không phải là nhà phê bình cho sự chấp thuận này
`404`	Sự chấp thuận không tồn tại hoặc không hiển thị cho chủ sở hữu chìa khóa
`409`	Sự chấp thuận đã được xử lý và không thể quyết định lại
`429`	Quá nhiều yêu cầu; câu trả lời bao gồm việc thử lại sau và X-RateLimit-* người đứng đầu

3. Chấp nhận liên kết một- nhấn (phương thức đèn)

GET /api/webhook-trigger/approval/{approvalId}/{decision}?api_key=…
Xác thực: Khóa API (tham số truy cập) · Scope: APPROVAL_RESPOND

Để cho phép người chấp thuận nhấn vào một liên kết bằng email/Slack/Telegram để hoàn tất sự chấp thuận, một điểm cuối dưới dạng get được cung cấp. Câu trả lời là một trang HTML, không phải JSON.

text

https://braidrun.com/api/webhook-trigger/approval/<approval-id>/approve?api_key=dyk_<id>_<secret>
https://braidrun.com/api/webhook-trigger/approval/<approval-id>/reject?api_key=dyk_<id>_<secret>&comment=Need%20more%20info

Lần đầu tiên một liên kết được mở, nó chỉ hiển thị một trang xác nhận; quyết định được gửi chỉ khi bạn nhắp vào cái nút xác nhận trên nó (mà phần phụ xác nhận = 1 đến URL). Robot xem kết nối trong email và ứng dụng IP chỉ lấy được trang xác nhận, nên họ không thể tình cờ chấp nhận.

Chẳng hạn, bạn có thể nhúng những liên kết này vào thông báo được chấp thuận:

markdown

## 工作流等待您批准

请审批 [发票 #1234] 的支付。

[批准](https://braidrun.com/api/webhook-trigger/approval/<approval-id>/approve?api_key=<api-key>)
[拒绝](https://braidrun.com/api/webhook-trigger/approval/<approval-id>/reject?api_key=<api-key>)

Giới hạn bảo mật cho liên kết một lần nhấn chuột

Một chiếc máy tính xách tay dùng để phê chuẩn nhấn chuột phải có một cuộc sống ngắn (24-72 giờ)
Đã cập nhật
Chuyển tiếp liên kết tương đương với việc trao cho nhà cầm quyền - không đăng các liên kết rõ ràng trong nhóm, tốt nhất là gửi cho họ thông điệp riêng
Trong trường hợp bị rò rỉ liên kết: Hãy nhập vào bảng điều khiển để lập tức thu hồi chìa khóa. Có thể truy ra được sự tán thành và phê duyệt qua bản ghi kiểm tra.

Ký Hiệu HMAC (để tích hợp di sản)

Một cây móc Web không có phím API bị ràng buộc và chỉ một bí mậtKey vẫn còn sử dụng chế độ chung HMAC-SHA256 (người đứng đầu X-Webok-Signture). Một khi bạn đã gắn một chiếc máy tính xách tay vào một cái Webok, HMAC không còn được chấp nhận nữa - di cư là một chiều. Để tìm sự tích hợp mới, hãy sử dụng chế độ khóa API trực tiếp; cho các thuật toán chữ ký và chi tiết di trú, xem Khởi động luồng công việc qua Webok.