Webhooks
Disponible avecFreeProResearch
Un webhook est une adresse web que Readsira appelle quand quelque chose se produit dans votre bibliothèque, par exemple quand vous enregistrez un lien. Vous l'utilisez pour connecter Readsira à un script, à un outil d'automatisation ou à un canal de discussion que vous contrôlez. Chaque message est signé, ce qui permet à votre récepteur de vérifier qu'il vient bien de Readsira. Si vous écrivez le récepteur vous-même, voir Webhooks pour les développeurs pour les charges utiles et la vérification de la signature.
Avant de commencer
- Il vous faut un récepteur : une adresse
https://publique qui accepte une requête POST avec un corps JSON. Les adresses de votre propre ordinateur ou de votre réseau privé (commelocalhost) sont refusées. - Prévoyez de stocker le secret que Readsira affiche quand vous ajoutez le webhook. Il n'est affiché qu'une seule fois.
Ajouter un webhook
-
Ouvrez Paramètres et choisissez Webhooks. Vous pouvez aussi ouvrir
app.readsira.com/settings/webhooks. -
Sous Ajouter un webhook, saisissez votre adresse dans URL du récepteur et sélectionnez Ajouter.
-
Un encadré affiche Sauvegardez ce secret maintenant. Il ne sera plus affiché. Copiez le secret et gardez-le là où votre récepteur peut le lire.
-
Choisissez les événements voulus sous Événements sur la carte du webhook. Un nouveau webhook démarre avec
bookmark.createduniquement. -
Sélectionnez Tester. Readsira envoie un message de test immédiatement, et le badge de la carte affiche la réponse de votre récepteur, par exemple
HTTP 200.
Événements
| Événement | Quand il est envoyé |
|---|---|
bookmark.created | Vous enregistrez un élément |
bookmark.updated | Un élément change |
bookmark.deleted | Un élément est supprimé |
bookmark.visited | Vous ouvrez un élément |
collection.created, collection.updated, collection.deleted | Proposés dans l'app, mais pas encore envoyés |
output.created | Une production de projet est prête |
Les éléments qu'un import ajoute n'envoient pas de webhooks.
Ce que signifie le badge d'une carte
HTTP 200(ou un autre nombre 2xx) : le dernier appel a fonctionné.- Un autre nombre, en rouge : votre récepteur a répondu par une erreur. La carte affiche le texte de l'erreur.
- en attente du premier envoi : Readsira ne l'a pas encore appelé. Utilisez Tester.
- désactivé : le webhook est désactivé.
Quand votre récepteur répond par une erreur serveur ou ne répond pas dans les 5 secondes, Readsira réessaie, jusqu'à 4 tentatives en tout, avec des pauses de plus en plus longues entre elles. Readsira ne suit pas les redirections ; utilisez donc l'adresse finale.
Gérer un webhook
- Renouveler le secret crée un nouveau secret. Votre récepteur échoue à la vérification de la signature tant qu'il n'utilise pas le nouveau ; changez-le donc immédiatement à cet endroit.
- Désactiver met le webhook en pause, et Activer le redémarre.
- Supprimer le supprime.
Pendant que la suppression d'un compte attend la fin de son délai de grâce, les webhooks sont suspendus (voir Supprimer votre compte).