Зарегистрировать вебхук
Подписывает публичный 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"} | URL не был допустимым HTTPS-адресом, не распарсился или разрешился в частный/loopback IP. |
| 400 | {"error":"Webhook event is invalid","error_code":"INVALID_WEBHOOK_EVENT"} | Имя события отсутствует в списке разрешённых. Проверьте написание — имена имеют форму «order.<status>». |