تسجيل webhook
يشترك عنوان URL عام في الأحداث المدعومة. تتلقى كل نقطة نهاية سر HMAC-SHA256 خاصًا بها يُعرض مرة واحدة عند الإنشاء. إذا فُقد، فاحذف نقطة النهاية وأضفها مجددًا.
https://notpanel.com/api/v3action=webhook.addapplication/x-www-form-urlencodedالمعاملات
| الاسم | النوع | الوصف |
|---|---|---|
| keyمطلوب | string | مفتاح API الخاص بك. |
| actionمطلوب | string | يجب أن يكون السلسلة النصية الحرفية "webhook.add". |
| urlمطلوب | string (URL) | نقطة نهاية HTTPS علنية ستستقبل طلبات POST. يجب أن تكون قابلة للوصول من الإنترنت العام. |
| events | string (CSV) | مجموعة فرعية مفصولة بفواصل من الأحداث الستة المدعومة أدناه. احذفه للاشتراك في الأحداث الستة كلها. |
مثال على الطلب
استبدل YOUR_API_KEY بالمفتاح المُولَّد ضمن صفحة API في لوحة تحكمك.
curl -X POST https://notpanel.com/api/v3 \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "key=YOUR_API_KEY&action=webhook.add&url=https://your-server.example.com/notpanel-webhook&events=order.completed,order.refunded"const res = await fetch("https://notpanel.com/api/v3", {
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded" },
body: new URLSearchParams({
key: "YOUR_API_KEY",
action: "webhook.add",
url: "https://your-server.example.com/notpanel-webhook",
events: "order.completed,order.refunded",
}),
});
const data = await res.json();
console.log(data);import requests
res = requests.post(
"https://notpanel.com/api/v3",
data={
"key": "YOUR_API_KEY",
"action": "webhook.add",
"url": "https://your-server.example.com/notpanel-webhook",
"events": "order.completed,order.refunded",
},
)
print(res.json())<?php
$body = http_build_query([
'key' => 'YOUR_API_KEY',
'action' => 'webhook.add',
'url' => 'https://your-server.example.com/notpanel-webhook',
'events' => 'order.completed,order.refunded',
]);
$response = file_get_contents('https://notpanel.com/api/v3', false, stream_context_create([
'http' => [
'method' => 'POST',
'header' => "Content-Type: application/x-www-form-urlencoded\r\n",
'content' => $body,
'ignore_errors' => true,
],
]));
print_r(json_decode($response, true));
مثال على الاستجابة
{
"webhook_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
"url": "https://your-server.example.com/notpanel-webhook",
"secret": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"events": [
"order.completed",
"order.refunded"
]
}الأخطاء الشائعة
| الحالة | الجسم | السبب |
|---|---|---|
| 400 | {"error":"Maximum 5 webhook endpoints per API key"} | استنفدت نقاط النهاية القائمة الحد الأقصى. أزل نقطة نهاية غير مستخدمة عبر action=webhook.remove أولاً. |
| 400 | {"error":"Webhook URL must be a publicly reachable HTTPS URL"} | لم يكن الرابط عنوان HTTPS صالحًا، أو تعذّر تحليله، أو حُلّ إلى عنوان IP خاص/محلي (loopback). |
| 400 | {"error":"Webhook event is invalid","error_code":"INVALID_WEBHOOK_EVENT"} | اسم الحدث ليس ضمن قائمة السماح. تحقّق من الإملاء — تأخذ الأسماء الشكل "order.<status>". |