Webhooks


API de gestion des webhooks

Cette API permet l'administration des clés de webhook utilisées pour envoyer vos événements d'usage produit à Skalin.

Toute propriété ou méthode non documentée peut être modifiée ou supprimée sans préavis.

Info

Cette page couvre la gestion des clés. L'envoi des événements lui-même est décrit dans la section webhook.

# Un canal entrant, pas une notification sortante

Le mot « webhook » désigne souvent une notification que l'on reçoit. Ici, c'est l'inverse : un webhook Skalin est un canal d'ingestion.

Créer un webhook produit les identifiants dont votre application se sert pour pousser ses événements d'usage vers Skalin. Ces événements sont ensuite agrégés par compte et par jour, et alimentent les KPI d'usage ainsi que la composante usage du health score.

Pour recevoir des notifications depuis Skalin, ce sont les alertes qu'il faut configurer, avec un type WEBHOOK.

# Cycle de vie d'une clé

Le status gouverne l'acceptation des événements :

Statut Effet
ACTIVE La clé accepte les événements entrants
DISABLED La clé est conservée mais les événements sont rejetés
ERROR Positionné par Skalin après des échecs d'ingestion répétés

Passer une clé en DISABLED permet d'interrompre un flux sans perdre la clé ni l'historique. ERROR est un état constaté par Skalin : il ne se positionne pas via l'API.

# Suppression

Supprimer une clé fait rejeter les événements envoyés avec elle à partir de ce moment. L'usage déjà ingéré est conservé : les KPI historiques ne sont pas affectés.

# Droits

La lecture est ouverte à tous les utilisateurs. La création, la modification et la suppression demandent le rôle ADMIN.

Info

La liste des webhooks n'est pas paginée : la collection complète est renvoyée dans un seul tableau, triée par date de création.

# Pour aller plus loin

# swagger

Contributeurs: Julien