حذف خطاف ويب

DELETE /v1/webhooks/{id}

حذف خطاف ويب فوراً. بمجرد الحذف، ستتوقف نقطة النهاية عن تلقي الأحداث.

جرّبه

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

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

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

DANGER

حذف خطاف الويب فوري ودائم. ستتوقف نقطة النهاية فوراً عن تلقي الأحداث. لا يمكن التراجع عن هذا الإجراء -- ستحتاج إلى إنشاء خطاف ويب جديد.

الطلب

الترويسات

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

معاملات المسار

المعامل	النوع	مطلوب	الوصف
id	string	نعم	معرّف خطاف الويب المراد حذفه (مثال: webhook-abc123def456).

أمثلة الكود

curl

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

TypeScript

const apiKey = process.env.DOCMAP_API_KEY
const webhookId = 'webhook-abc123def456'

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

const result = await response.json()
console.log(result) // { success: true }

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"
webhook_id = "webhook-abc123def456"

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

print(response.json())  # {"success": True}

الاستجابة

الحالة: 200 OK

مثال

{
  "success": true
}

الأخطاء

الحالة	الرمز	الوصف
401	UNAUTHORIZED	مفتاح API / رمز مفقود أو غير صالح أو منتهي الصلاحية.
403	FORBIDDEN	خطاف الويب ينتمي إلى مستخدم آخر. يمكنك فقط حذف خطافات الويب الخاصة بك.
404	NOT_FOUND	لم يُعثر على خطاف ويب بالمعرّف المحدد.