تخطي إلى المحتوى الرئيسي

اعثر على أداتك التالية

API/المرجع/إنشاء خطاف ويب
POST/api/v1/webhooks

إنشاء خطاف ويب

سجّل وجهة استدعاء موقّعة لأحداث المهام والمستندات.

المصادقة

مفتاح API

النطاقات

webhooks:write

العقد

API v1

الطلب

curl -X POST 'https://api.maxscanner.app/api/v1/webhooks' \
  -H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: unique-request-id' \
  -d '{ "url": "https://example.com/maxscanner/webhook", "events": ["job.completed"] }'

نص الطلب

{ "url": "https://example.com/maxscanner/webhook", "events": ["job.completed"] }

الاستجابة

{ "id": "wh_123", "status": "active" }

ملاحظات التنفيذ

  • نقاط نهاية HTTPS فقط.
  • تحقق من التوقيعات وأزل معرّفات الأحداث المكررة.

جرّب نقطة النهاية هذه

استخدم بيئة تجربة API للمصادقة والاختبار بأمان قبل ربط نقطة النهاية بتطبيقك.

فتح بيئة التجربة ←