Webhooks
Disponible enFreeProResearch
Un webhook es una dirección web a la que llama Readsira cuando ocurre algo en tu biblioteca, por ejemplo cuando guardas un enlace. Lo usas para conectar Readsira con un script, una herramienta de automatización o un canal de chat que controlas. Cada mensaje va firmado, para que tu receptor pueda comprobar que de verdad vino de Readsira. Si escribes tú el receptor, consulta Webhooks para desarrolladores para ver las cargas y la comprobación de la firma.
Antes de empezar
- Necesitas un receptor: una dirección pública
https://que acepte una solicitud POST con un cuerpo JSON. Las direcciones de tu propio ordenador o de una red privada (comolocalhost) se rechazan. - Prevé guardar el secreto que muestra Readsira cuando añades el webhook. Se muestra una sola vez.
Añadir un webhook
-
Abre Configuración y elige Webhooks. También puedes abrir
app.readsira.com/settings/webhooks. -
En Añadir un webhook, escribe tu dirección en URL del receptor y selecciona Añadir.
-
Un cuadro dice Guarda este secreto ahora. No se mostrará otra vez. Copia el secreto y guárdalo donde tu receptor pueda leerlo.
-
Elige los eventos que quieras en Eventos en la tarjeta del webhook. Un webhook nuevo empieza solo con
bookmark.created. -
Selecciona Probar. Readsira envía un mensaje de prueba ahora y la insignia de la tarjeta muestra la respuesta de tu receptor, por ejemplo
HTTP 200.
Eventos
| Evento | Cuándo se envía |
|---|---|
bookmark.created | Guardas un elemento |
bookmark.updated | Un elemento cambia |
bookmark.deleted | Se elimina un elemento |
bookmark.visited | Abres un elemento |
collection.created, collection.updated, collection.deleted | Aparecen en la app, pero aún no se envían |
output.created | Un resultado de proyecto está listo |
Los elementos que añade una importación no envían webhooks.
Qué significa la insignia de una tarjeta
HTTP 200(u otro número 2xx): la última llamada funcionó.- Otro número, en rojo: tu receptor respondió con un error. La tarjeta muestra el texto del error.
- esperando el primer envío: Readsira todavía no lo ha llamado. Usa Probar.
- desactivado: el webhook está desactivado.
Cuando tu receptor responde con un error del servidor o no responde en 5 segundos, Readsira lo reintenta, hasta 4 intentos en total, con pausas más largas entre ellos. Readsira no sigue redirecciones, así que usa la dirección final.
Gestionar un webhook
- Renovar secreto crea un secreto nuevo. Tu receptor falla la comprobación de la firma hasta que use el nuevo, así que cámbialo allí de inmediato.
- Desactivar pausa el webhook y Activar lo inicia de nuevo.
- Eliminar lo elimina.
Mientras una eliminación de cuenta espera a que termine su periodo de gracia, los webhooks están en pausa (consulta Eliminar tu cuenta).