نقطة النهاية

نقطة نهاية (ويهوك) تستخدم لـ "مناسبات دفع نشطة من النظم الخارجية" فئتان: محفز سير العمل (يدفع النظام الخارجي البيانات إلى أعلى مستوى لتنفيذ سير العمل) واستعادة الموافقة (يدفع النظام الخارجي القرار complete يستكمل الدليل - خطوة الموافقة).

1 - تدفق العمل

POST /api/webhooks/{webhookId}/trigger
التوثيق: مفتاح (بيرلر) / Scope: WEBHOOK_TRIGGER

First create a Webhook in the console: bind it to the target work flow and pick an API Key with the WeBHOOK TRIGGER scope. نظام خارجي بعد ذلك يُستخدم جسماً من نوع (الجوسون) إلى الزناد (يورل) وخريطة حقول الحمولة من أعلى المستويات إلى متغيرات سير العمل عن طريق تخطيط المتغيرات أو عن طريق مطابقة الأسماء.

For the full creation steps, a trigger curl example, changing-mapping rules, the error-code table, and HMAC compatibility mode, see جهز سير العمل عبر (ويهوك)- لا تغطي هذه الصفحة سوى العقد النهائي المفتوح.

الحدود

2 - الرد على الموافقة (طريقة الموافقة المسبقة عن علم)

POST /api/webhook-trigger/approval
التوثيق: API Key (Bearer) · Scope: APPROVAL_RESPOND

استعمل في تقديم قرار الموافقة من نظام خارجي (منطق العتاد، حزمة سلكية، مناولة بريد إلكتروني، وما إلى ذلك). الجسم الطلبي مجهز في 64 KB.

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"
  }'

الرد الناجح:

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

حقول الطلب

الردود الخاطئة

3. Approval one-click link (GET method)

GET /api/webhook-trigger/approval/{approvalId}/{decision}?api_key=…
التوثيق: مفتاح (مباراة خط الأساس) Scope: APPROVAL_RESPOND

ولتمكين المصدِّق من فتح وصلة في البريد الإلكتروني/Slack/Telegram لاستكمال الموافقة، تُقدَّم نقطة نهاية في شكل نظام الأفضليات المعمم. The response is an HTML page, not JSON.

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

وفي المرة الأولى التي يفتح فيها الرابط لا يظهر سوى صفحة تأكيد؛ ولا يقدم القرار إلا عندما تضغط زر التأكيد عليه (الذي يؤكد من 1 إلى الاتحاد الثوري). أحذية "لينك-فيو" في عملاء البريد الإلكتروني و تطبيقات "إم" لا تحضر سوى صفحة التثبيت، لذا لا يمكنهم الموافقة عن طريق الخطأ.

يمكنك أن تدمج مثل هذه الروابط في رسائل إشعار الموافقة، مثل:

## 工作流等待您批准

请审批 [发票 #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>)

التوقيعات على اتفاقية مكافحة الفساد (للإدماجات القديمة)

A webhook with no bound API Key and only a secretKey still uses HMAC-SHA256 shared-secret mode (the X-Webhook-Signature header). وبمجرد أن تُلزم مفتاحاً لشبكة ويبوهوك، لم تعد شركة HMAC مقبولة - فالهجرة طريق واحد. وللإدماجات الجديدة، تستخدم الطريقة الرئيسية للبروتوكول الاختياري مباشرة؛ وللاطلاع على خوارزمية التوقيع وتفاصيل الهجرة، انظر جهز سير العمل عبر (ويهوك).