Registrar webhook
Suscribe una URL pública a eventos compatibles. Cada endpoint recibe su propio secreto HMAC-SHA256, que se muestra una sola vez al crearlo. Si se pierde, elimina el endpoint y añádelo de nuevo.
https://notpanel.com/api/v3action=webhook.addapplication/x-www-form-urlencodedParámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| keyObligatorio | string | Tu clave de API. |
| actionObligatorio | string | Debe ser la cadena literal "webhook.add". |
| urlObligatorio | string (URL) | Endpoint HTTPS público que recibirá POSTs. Debe ser accesible desde la internet pública. |
| events | string (CSV) | Subconjunto separado por comas de los seis eventos compatibles que aparecen abajo. Omítelo para suscribirte a los seis. |
Ejemplo de petición
Reemplaza YOUR_API_KEY por la clave generada en la página de API de tu panel.
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));
Ejemplo de respuesta
{
"webhook_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
"url": "https://your-server.example.com/notpanel-webhook",
"secret": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"events": [
"order.completed",
"order.refunded"
]
}Errores comunes
| Estado | Cuerpo | Causa |
|---|---|---|
| 400 | {"error":"Maximum 5 webhook endpoints per API key"} | Los endpoints existentes agotaron el límite. Elimina primero un endpoint sin usar con action=webhook.remove. |
| 400 | {"error":"Webhook URL must be a publicly reachable HTTPS URL"} | La URL no era HTTPS válida, no se pudo analizar o se resolvió a una IP privada/de loopback. |
| 400 | {"error":"Webhook event is invalid","error_code":"INVALID_WEBHOOK_EVENT"} | El nombre del evento no está en la lista de permitidos. Revisa la ortografía: los nombres usan el formato "order.<status>". |