Webhooks
Verfügbar inFreeProResearch
Ein Webhook ist eine Webadresse, die Readsira aufruft, wenn in deiner Bibliothek etwas passiert, zum Beispiel wenn du einen Link speicherst. Damit verbindest du Readsira mit einem Skript, einem Automatisierungstool oder einem Chat-Kanal, den du selbst kontrollierst. Jede Nachricht ist signiert, sodass dein Empfänger prüfen kann, dass sie wirklich von Readsira kommt. Wenn du den Empfänger selbst schreibst, findest du die Payloads und die Signaturprüfung unter Webhooks für Entwickler.
Bevor du anfängst
- Du brauchst einen Empfänger: eine öffentliche
https://-Adresse, die eine POST-Anfrage mit JSON-Body annimmt. Adressen auf deinem eigenen Computer oder in einem privaten Netzwerk (etwalocalhost) werden abgelehnt. - Speichere das Geheimnis, das Readsira beim Hinzufügen des Webhooks anzeigt. Es wird nur einmal angezeigt.
Einen Webhook hinzufügen
-
Öffne Einstellungen und wähle Webhooks. Du kannst auch
app.readsira.com/settings/webhooksöffnen. -
Gib unter Webhook hinzufügen deine Adresse in Empfänger-URL ein und wähle Hinzufügen.
-
Ein Feld zeigt Speichere dieses Secret jetzt. Es wird nicht erneut angezeigt. Kopiere das Geheimnis und bewahre es dort auf, wo dein Empfänger es lesen kann.
-
Wähle auf der Karte des Webhooks unter Ereignisse die gewünschten Ereignisse. Ein neuer Webhook startet nur mit
bookmark.created. -
Wähle Testen. Readsira sendet jetzt eine Testnachricht, und das Badge auf der Karte zeigt die Antwort deines Empfängers, zum Beispiel
HTTP 200.
Ereignisse
| Ereignis | Wann es gesendet wird |
|---|---|
bookmark.created | Du speicherst einen Eintrag |
bookmark.updated | Ein Eintrag ändert sich |
bookmark.deleted | Ein Eintrag wird gelöscht |
bookmark.visited | Du öffnest einen Eintrag |
collection.created, collection.updated, collection.deleted | In der App aufgeführt, aber noch nicht gesendet |
output.created | Ein Projekt-Ergebnis ist fertig |
Einträge, die ein Import hinzufügt, senden keine Webhooks.
Was das Badge auf einer Karte bedeutet
HTTP 200(oder eine andere 2xx-Nummer): Der letzte Aufruf hat funktioniert.- Eine andere Nummer, in Rot: Dein Empfänger hat mit einem Fehler geantwortet. Die Karte zeigt den Fehlertext.
- wartet auf erste Auslösung: Readsira hat ihn noch nicht aufgerufen. Nutze Testen.
- deaktiviert: Der Webhook ist ausgeschaltet.
Wenn dein Empfänger mit einem Serverfehler antwortet oder nicht innerhalb von 5 Sekunden antwortet, versucht Readsira es erneut, insgesamt bis zu 4 Versuche, mit länger werdenden Pausen dazwischen. Readsira folgt keinen Weiterleitungen, verwende also die endgültige Adresse.
Einen Webhook verwalten
- Secret erneuern erzeugt ein neues Geheimnis. Dein Empfänger besteht die Signaturprüfung erst wieder, wenn er das neue verwendet, ändere es dort also sofort.
- Deaktivieren pausiert den Webhook, und Aktivieren startet ihn wieder.
- Löschen entfernt ihn.
Solange eine Kontolöschung ihre Karenzzeit abwartet, sind Webhooks pausiert (siehe Dein Konto löschen).