Détecter et rattraper les échecs de webhook
La livraison d'un webhook échoue quand votre endpoint ne l'accepte pas, par exemple parce que l'URL ne peut pas être résolue ou que le serveur répond avec un code d'erreur. Safecube relance plusieurs fois une livraison en échec avant de la marquer comme échouée. La Webhooks API détecte ces échecs et renvoie les messages une fois l'endpoint réparé.
Détecter les échecs par l'API
GET /endpoint/{endpoint_id}/stats renvoie les statistiques de livraison d'un endpoint sur les 28 derniers jours au plus. Les paramètres de requête facultatifs since et until restreignent la période.
curl "https://api.sinay.ai/webhook/api/v1/endpoint/{endpoint_id}/stats?since=2024-06-12T12:00:00Z" \
-H "API_KEY: $SAFECUBE_API_KEY" \
-H "Accept: application/json"
{
"success": 0,
"pending": 0,
"sending": 10,
"fail": 32
}
| Champ | Nombre de messages sur la période |
|---|---|
success | livrés avec succès |
pending | encore en attente |
sending | encore en cours d'envoi ; un message peut être relancé plusieurs fois |
fail | en échec après plusieurs relances |
Dans cet exemple, l'endpoint a enregistré de nombreux échecs et aucun succès : réparez l'endpoint, puis renvoyez les messages en échec.
Rattraper les échecs par l'API
Deux endpoints renvoient des messages à un endpoint sur une période, définie par since et un until facultatif :
POST /endpoint/{endpoint_id}/recoverrenvoie tous les messages en échec depuis l'heure indiquée.POST /endpoint/{endpoint_id}/replay-missingrejoue les messages créés aprèssincequi n'ont jamais été envoyés à l'endpoint ; les messages déjà envoyés ne sont pas renvoyés. Une requête réussie renvoie204 No Content.
curl -X POST "https://api.sinay.ai/webhook/api/v1/endpoint/{endpoint_id}/replay-missing" \
-H "API_KEY: $SAFECUBE_API_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"since": "2024-06-12T12:00:00Z",
"until": "2024-06-12T15:00:00Z"
}'
Détecter et rattraper les échecs dans le tableau de bord Svix
Le tableau de bord Svix affiche les mêmes informations de livraison dans un navigateur. Ouvrez-le depuis l'application web Safecube, avec Developers dans la barre latérale, l'onglet Webhooks puis Open Svix dashboard, ou depuis le lien renvoyé par GET /dashboard.
- La liste Endpoints affiche le taux d'erreur de chaque endpoint.
- Les menus Logs et Activity affichent les messages envoyés et leurs tentatives de livraison. Un message peut être ouvert pour vérifier ce qui a été envoyé et analyser l'erreur.
Un message de webhook a l'un de ces trois statuts :
- Succeeded : l'endpoint a reçu le webhook sans aucun code d'erreur.
- Sending : la livraison a échoué au moins une fois, et Safecube va réessayer.
- Failed : toutes les tentatives de livraison ont échoué.
Une fois le problème réglé, les messages en échec peuvent être renvoyés depuis le tableau de bord, un par un ou en bloc pour tous les messages manquants depuis une date donnée.