Centre d'aide caisse enregistreuse
This help will guide you through the setup and usage of our point of sale cash register software.
Rechercher par mot clé dans l'aide :
Gestion des webhooks
Creez, modifiez, listez et surveillez les webhooks JSON nouvelle generation.
Les endpoints ci-dessous utilisent l'authentification API existante : shopID + key. Pour envoyer un corps JSON, placez shopID et key dans l'URL, puis envoyez les parametres du webhook dans le JSON.
Authentification commune
| Naam | Verplicht | Beschrijving |
|---|---|---|
shopID | Ja | Identifiant de votre boutique. |
key | Ja | Cle API de votre boutique. |
Evenements disponibles
Le champ events accepte un tableau JSON, une chaine separee par des virgules, ou * pour ecouter tous les evenements.
customer.created- Customer createdcustomer.updated- Customer updatedsale.created- Sale createdsale.refunded- Sale refundedsale.paid- Sale paidproduct.created- Product createdproduct.updated- Product updatedstock.low- Stock lowstock.out- Stock outorder.sent_to_preparation- Order sent to preparationorder.preparation_completed- Order preparation completeddelivery.started- Bezorger onderwegday_closing.created- Day closing created
Creer un webhook
POST https://kash.click/workers/addWebhook.php
| Naam | Verplicht | Beschrijving |
|---|---|---|
url | Ja | URL cible appelee en POST JSON. Elle doit commencer par http:// ou https://. |
events | Ja | Liste des evenements ecoutes, par exemple ['sale.created','customer.created']. |
description | Neen | Nom interne libre, utile pour identifier le webhook dans l'interface. |
active | Neen | 1 par defaut. Mettre 0 pour creer un webhook inactif. |
secret | Neen | Secret partage utilise pour signer les livraisons. Si vide, Kash.click en genere un et le retourne une seule fois. |
fetch("https://kash.click/workers/addWebhook.php?shopID=[SHOPID]&key=[APIKEY]", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ url: "https://hooks.zapier.com/hooks/catch/123456/abcdef/", description: "Zapier production", events: ["customer.created", "sale.created", "sale.paid", "product.created", "stock.low"], active: 1 })}).then(r => r.json()).then(console.log);Lister les webhooks
GET https://kash.click/workers/getWebhooks.php
Retourne la liste des webhooks actifs/non supprimes et la liste des evenements disponibles.
{ "success": true, "result": "OK", "events": { "sale.created": "Sale created" }, "webhooks": [ { "id": 12, "url": "https://example.com/webhook", "description": "Zapier production", "events": ["sale.created", "sale.paid"], "active": 1, "hasSecret": 1, "created_at": "2026-07-16T10:00:00Z", "updated_at": "2026-07-16T10:00:00Z", "last_success_at": null, "last_failure_at": null } ]}Modifier un webhook
POST https://kash.click/workers/editWebhook.php
| Naam | Verplicht | Beschrijving |
|---|---|---|
id | Ja | Identifiant du webhook. |
url | Neen | Nouvelle URL cible. |
description | Neen | Nouvelle description. |
events | Neen | Nouvelle liste d'evenements. Remplace la liste precedente. |
active | Neen | 1 pour activer, 0 pour desactiver. |
secret | Neen | Remplace le secret par la valeur fournie. |
rotateSecret | Neen | Mettre 1 pour generer un nouveau secret. Le nouveau secret est retourne une seule fois. |
{ "id": 12, "url": "https://example.com/new-target", "events": ["sale.created", "sale.paid"], "active": 1}Supprimer un webhook
POST https://kash.click/workers/delWebhook.php
La suppression est logique : le webhook est desactive et marque comme supprime.
{ "id": 12 }Historique des livraisons
GET https://kash.click/workers/getWebhookDeliveries.php
| Naam | Verplicht | Beschrijving |
|---|---|---|
webhookID | Neen | Filtrer sur un webhook. |
status | Neen | pending, success ou failed |
limit | Neen | Nombre de lignes retournees. Par defaut 50, maximum 100. |
{ "id": 345, "delivery_id": "del_...", "event_id": "evt_...", "type": "sale.created", "webhook_id": 12, "url": "https://example.com/webhook", "status": "failed", "attempts_count": 5, "max_attempts": 5, "created_at": "2026-07-16T10:00:00Z", "next_attempt_at": null, "last_attempt_at": "2026-07-16T16:21:00Z", "http_code": 500, "error": "", "attempts": [ { "attempt": 5, "attempted_at": "2026-07-16T16:21:00Z", "success": 0, "http_code": 500, "response": "Internal server error", "error": "" } ]}Relancer une livraison
POST https://kash.click/workers/retryWebhookDelivery.php
Remet une livraison en status pending avec une prochaine tentative immediate.
{ "id": 345 }Notes importantes
- Les reponses 2xx sont considerees comme un succes.
- Les webhooks inactifs ne recoivent plus de livraisons.
- Le secret n'est jamais retourne lors de la liste : seulement a la creation ou lors d'une rotation.
- La signature envoyee au destinataire est documentee dans la page Webhook.
Ce document est mis à disposition selon les termes de la licence Creative Commons Attribution 4.0 International (CC BY 4.0) .