قائمة خطافات الويب

GET /v1/webhooks

قائمة جميع خطافات الويب النشطة للمستخدم المصادق عليه. لا تتضمن الاستجابة أبداً أسرار التوقيع -- فقط البيانات الوصفية للتعريف والإدارة.

جرّبه

اختبر هذا الـ endpoint بشكل تفاعلي في Swagger UI.

المصادقة مطلوبة

أدرج مفتاح API في ترويسة Authorization.

الطلب

الترويسات

الترويسة	القيمة	مطلوب
Authorization	Bearer <token>	نعم

لا تقبل نقطة النهاية هذه أي معاملات استعلام أو جسم طلب.

أمثلة الكود

curl

curl https://api.docmap.io/v1/webhooks \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

const response = await fetch('https://api.docmap.io/v1/webhooks', {
  headers: { 'Authorization': `Bearer ${apiKey}` },
})

const { data } = await response.json()

for (const webhook of data) {
  console.log(`${webhook.url} — events: ${webhook.events.join(', ')}`)
}

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

response = requests.get(
    "https://api.docmap.io/v1/webhooks",
    headers={"Authorization": f"Bearer {api_key}"},
)

webhooks = response.json()["data"]

for webhook in webhooks:
    events = ", ".join(webhook["events"])
    print(f"{webhook['url']} — events: {events}")

الاستجابة

الحالة: 200 OK

يحتوي جسم الاستجابة على مصفوفة data من كائنات البيانات الوصفية لخطافات الويب.

الحقول

يحتوي كل كائن في المصفوفة على:

الحقل	النوع	الوصف
id	string	معرّف فريد لخطاف الويب.
userId	string	معرّف المستخدم الذي يملك خطاف الويب.
url	string	عنوان URL لنقطة النهاية المسجلة.
events	string[]	الأحداث التي اشترك فيها خطاف الويب.
active	boolean	ما إذا كان خطاف الويب نشطاً. دائماً true في هذه الاستجابة.
createdAt	string	طابع زمني ISO 8601 لوقت إنشاء خطاف الويب.

مثال

{
  "data": [
    {
      "id": "webhook-abc123def456",
      "userId": "uid_a1b2c3d4e5f6",
      "url": "https://your-app.com/webhooks/docmap",
      "events": ["extraction.completed", "extraction.failed"],
      "active": true,
      "createdAt": "2025-01-15T10:00:00.000Z"
    },
    {
      "id": "webhook-xyz789uvw012",
      "userId": "uid_a1b2c3d4e5f6",
      "url": "https://slack-webhook.example.com/docmap",
      "events": ["extraction.failed"],
      "active": true,
      "createdAt": "2025-01-10T08:00:00.000Z"
    }
  ]
}

الأخطاء

الحالة	الرمز	الوصف
401	UNAUTHORIZED	مفتاح API / رمز مفقود أو غير صالح أو منتهي الصلاحية.