Webhook générique¶
Pour brancher un outil à vous (gestion d'incidents, automatisation, chatbot
maison), RestoreProof envoie une requête POST en JSON vers une adresse HTTPS
de votre choix, et la signe pour que vous puissiez vérifier qu'elle vient
bien de lui. Le fonctionnement commun des canaux est décrit dans
Notifications.
Ce type de canal est disponible avec toutes les offres.
À la création du canal (Notifications, Ajouter un canal, Webhook),
vous ne fournissez que l'adresse. RestoreProof génère un secret de signature
de la forme whsec_… et l'affiche une seule fois : copiez-le tout de suite.
L'adresse doit être en https et joignable depuis Internet : les adresses
privées (réseau local, localhost) sont refusées, et les redirections ne sont
pas suivies.
Le contenu du message et la façon de vérifier sa signature sont décrits dans Format du message et signature.
Changer le secret¶
Depuis la page du canal, Régénérer le secret en crée un nouveau, affiché une
seule fois. L'ancien continue de signer pendant 24 heures : pendant ce temps
l'en-tête webhook-signature porte deux signatures, une par secret. Vous
avez donc le temps de déployer le nouveau secret chez vous sans perdre un seul
message, et le code de vérification de la page
Format du message et signature accepte les deux sans rien
changer.
Ce que votre serveur doit répondre¶
| Votre réponse | Ce que fait RestoreProof |
|---|---|
2xx |
Message livré. |
408, 429, 5xx, délai dépassé (10 secondes), connexion impossible |
Nouvelle tentative, voir les tentatives. Un en-tête Retry-After est respecté, dans la limite d'une heure. |
3xx |
Abandon : les redirections ne sont jamais suivies. |
Tout autre 4xx |
Abandon : le message est refusé, il n'est pas retenté. |
Répondez vite (200 ou 204 suffisent) et traitez le message ensuite. Le corps
de votre réponse est lu jusqu'à 64 Ko puis ignoré.