Registrar webhook
Subscreve uma URL pública aos eventos suportados. Cada endpoint recebe o seu próprio segredo HMAC-SHA256, mostrado uma única vez na criação. Se o perder, remova o endpoint e adicione-o novamente.
https://notpanel.com/api/v3action=webhook.addapplication/x-www-form-urlencodedParâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| keyObrigatório | string | Sua chave de API. |
| actionObrigatório | string | Deve ser a string literal "webhook.add". |
| urlObrigatório | string (URL) | Endpoint HTTPS público que receberá POSTs. Deve ser acessível pela internet pública. |
| events | string (CSV) | Subconjunto separado por vírgulas dos seis eventos suportados abaixo. Omita-o para subscrever os seis. |
Exemplo de requisição
Substitua YOUR_API_KEY pela chave gerada na página de API do seu painel.
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));
Exemplo de resposta
{
"webhook_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
"url": "https://your-server.example.com/notpanel-webhook",
"secret": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"events": [
"order.completed",
"order.refunded"
]
}Erros comuns
| Status | Corpo | Causa |
|---|---|---|
| 400 | {"error":"Maximum 5 webhook endpoints per API key"} | Os endpoints existentes esgotaram o limite. Remova um endpoint não utilizado com action=webhook.remove primeiro. |
| 400 | {"error":"Webhook URL must be a publicly reachable HTTPS URL"} | A URL não era HTTPS válida, não pôde ser analisada ou resolveu para um IP privado/loopback. |
| 400 | {"error":"Webhook event is invalid","error_code":"INVALID_WEBHOOK_EVENT"} | O nome do evento não está na lista de permitidos. Verifique a grafia — os nomes usam a forma "order.<status>". |