Aller au contenu principal

Webhooks

Les webhooks vous permettent d'intégrer Stockaj avec des systèmes externes en envoyant des notifications HTTP en temps réel lorsque des événements se produisent dans votre espace de travail.

info

Les webhooks sont disponibles à partir des forfaits Professionnel.

Comment fonctionnent les webhooks

Lorsqu'un événement se produit dans Stockaj (ex. : une location est créée), Stockaj envoie une requête HTTP POST à votre URL configurée avec les détails de l'événement.

Votre App ← POST ← Stockaj
{
"event": "rent.created",
"data": { ... },
"timestamp": "2025-01-15T10:30:00Z"
}

Gestion des webhooks

Accédez à Paramètres → Webhooks pour gérer vos webhooks.

Capture d'écran nécessaire

screenshot-webhooks-list.png — La page de gestion des webhooks montrant les webhooks configurés avec leur statut et le nombre de livraisons.

Création d'un webhook

  1. Allez dans Paramètres → Webhooks et cliquez sur + Nouveau webhook.
  2. Configurez :
ChampRequisDescription
NomOuiUn nom descriptif (ex. : « Notifier Slack pour les nouvelles locations »)
URLOuiLe point de terminaison HTTPS pour recevoir les événements
ÉvénementsOuiQuels événements déclenchent ce webhook
Délai d'attenteNonDélai d'expiration de la requête en secondes (1-30, par défaut : 10)
  1. Cliquez sur Créer.
  2. Copiez le secret — il n'est affiché qu'une seule fois ! Vous en aurez besoin pour vérifier les signatures des webhooks.

Événements disponibles

ÉvénementDescription
*Tous les événements (joker)
rent.createdUne nouvelle location a été créée
rent.updatedUne location a été mise à jour
rent.status_changedLe statut d'une location a changé
rent.deletedUne location a été supprimée
item.createdUn nouvel article a été créé
item.updatedUn article a été mis à jour
item.deletedUn article a été supprimé
item.low_stockUn article est passé sous sa quantité minimale
renter.createdUn nouveau locataire a été créé
renter.updatedUn locataire a été mis à jour
renter.deletedUn locataire a été supprimé

Sécurité des webhooks

Chaque webhook possède une clé secrète utilisée pour signer les charges utiles. Vérifiez la signature de votre côté pour vous assurer que les requêtes proviennent bien de Stockaj.

La signature est envoyée dans les en-têtes de la requête. Comparez-la avec un hash HMAC-SHA256 de la charge utile en utilisant votre secret.

Régénération des secrets

Si votre secret est compromis :

  1. Allez dans les paramètres du webhook.
  2. Cliquez sur Régénérer le secret.
  3. Mettez à jour votre serveur avec le nouveau secret.

Test des webhooks

Cliquez sur Envoyer un test sur n'importe quel webhook pour envoyer une charge utile de test à votre URL. Cela aide à vérifier que votre intégration fonctionne correctement.

remarque

Les événements de test sont soumis à une limite de débit pour éviter les abus.

Journaux de livraison

Chaque webhook suit son historique de livraison. Cliquez sur un webhook et allez dans Livraisons pour voir :

  • La charge utile de la requête
  • Le code de statut de la réponse
  • Le temps de réponse
  • Le statut succès/échec
Capture d'écran nécessaire

screenshot-webhook-deliveries.png — Le journal de livraison des webhooks montrant les livraisons passées avec les codes de statut et les temps de réponse.

Limites des webhooks

ForfaitMax webhooks
Gratuit0
Starter0
Professionnel10
EntrepriseIllimité