Enregistrer un webhook
Abonne une URL publique aux événements pris en charge. Chaque endpoint reçoit son propre secret HMAC-SHA256, affiché une seule fois lors de sa création. S’il est perdu, supprimez l’endpoint puis ajoutez-le à nouveau.
https://notpanel.com/api/v3action=webhook.addapplication/x-www-form-urlencodedParamètres
| Nom | Type | Description |
|---|---|---|
| keyRequis | string | Votre clé API. |
| actionRequis | string | Doit être la chaîne littérale « webhook.add ». |
| urlRequis | string (URL) | Endpoint HTTPS public qui recevra les POST. Doit être accessible depuis l'internet public. |
| events | string (CSV) | Sous-ensemble séparé par des virgules des six événements pris en charge ci-dessous. Omettez-le pour vous abonner aux six. |
Exemple de requête
Remplacez YOUR_API_KEY par la clé générée sur la page API de votre tableau de bord.
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));
Exemple de réponse
{
"webhook_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
"url": "https://your-server.example.com/notpanel-webhook",
"secret": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"events": [
"order.completed",
"order.refunded"
]
}Erreurs courantes
| Statut | Corps | Cause |
|---|---|---|
| 400 | {"error":"Maximum 5 webhook endpoints per API key"} | Les endpoints existants ont épuisé le plafond. Supprimez d'abord un endpoint inutilisé avec action=webhook.remove. |
| 400 | {"error":"Webhook URL must be a publicly reachable HTTPS URL"} | L’URL n’était pas une adresse HTTPS valide, n’a pas pu être analysée ou s’est résolue en une IP privée/de boucle locale. |
| 400 | {"error":"Webhook event is invalid","error_code":"INVALID_WEBHOOK_EVENT"} | Le nom de l'événement ne figure pas sur la liste d'autorisation. Vérifiez l'orthographe — les noms utilisent la forme « order.<status> ». |