API Notifications

Liste les notifications de l’organisation qui couvrent le projet, de tous les canaux, de la plus ancienne à la plus récente (50 au plus). status, failing_since, last_success_at et last_failure_at sont ceux de ce projet. Le secret de signature d’un webhook n’est jamais renvoyé ici.

Exige la capacité project; un justificatif d’identité limité aux rapports est refusé avec 403 forbidden, car la réponse comprend les URL des récepteurs et les destinataires.

Crée une notification. channel email envoie à recipients (propriétaire, ou user_ids des membres du projet) ; channel webhook fait un POST, signé, vers url, qui suit les règles d’URL de webhook (https sur un hôte public d’Internet, port 443 ou 8443, sinon webhook_url_rejected). conditions liste les changements d’état d’écran qui la déclenchent ; une notification par courriel en exige au moins un, un webhook exige conditions ou event_types. screen_tags limite conditions aux écrans portant l’une de ces étiquettes ; vide signifie tous les écrans, ou audience indique quels écrans selon les règles d’une audience de campagne. min_severity et severity filtrent et classent les avis, et active_hours met en attente ou abandonne les avis en dehors de ses fenêtres.

Une condition ne notifie qu’après avoir duré hold_minutes (10 par défaut), et un avis de résolution suit lorsqu’elle disparaît après l’envoi d’un avis. La notification couvre ce projet seul; une organisation compte au plus 50 notifications, sans compter celles que le système crée par défaut (notification_limit_reached).

Le secret de signature d’un webhook est généré par le serveur et renvoyé uniquement dans cette réponse et dans rotate-secret; conservez-le. Une nouvelle tentative identique avec la même Idempotency-Key renvoie cette même réponse, secret compris, pendant vingt-quatre heures. Les avis commencent avec le premier événement après notification.created.

Exige la capacité project; un justificatif d'identité limité aux rapports est refusé avec 403 forbidden, car la réponse comprend l'URL du récepteur ou les destinataires.

Modifie n’importe lequel de description (vide l’efface), conditions, screen_tags, audience, min_severity, severity, active_hours (null efface chacun de ceux-ci), hold_minutes, recipients (email), url et event_types (webhook), destination et telegram_chat_id (Slack, Teams, PagerDuty et Telegram), enabled et snoozed_until ; channel ne change jamais.

Un champ de l’autre canal est invalid_request. Une nouvelle url est vérifiée comme à la création.

Définir enabled à true sur une notification désactivée efface son état d'échec et démarre à l'événement qui consigne le changement; rien de ce qui est survenu pendant la désactivation n'est envoyé, et les avis encore en attente avant la désactivation sont marqués comme échoués avec webhook_disabled. snoozed_until n'envoie rien avant cet instant (au plus 30 jours à l'avance; null met fin à la pause); les avis qui arrivent à échéance entre-temps sont ignorés (snoozed).

Ajoute notification.updated. If-Match protège la révision. Seule une notification qui ne couvre que ce projet se modifie ici; une notification qui couvre aussi d’autres projets de l’organisation donne notification_covers_other_projects et se modifie depuis la page Notifications de l’organisation.

Supprime la notification et ajoute notification.deleted. Ses avis en attente sont marqués comme échoués avec webhook_deleted; son journal de livraison n’est plus adressable et expire avec la conservation des événements. Seule une notification qui ne couvre que ce projet est supprimée ici (sinon notification_covers_other_projects).

Notifications webhook seulement (tout autre canal entraîne invalid_request). Remplace le secret de signature et renvoie la notification avec le nouveau dans secret; l'ancien secret cesse de signer immédiatement, et au plus une tentative déjà en cours peut encore arriver signée avec l'ancien, donc acceptez les deux brièvement. Ajoute notification.updated avec details.changed [secret].

Une nouvelle tentative exacte avec la même Idempotency-Key retourne le même nouveau secret pendant vingt-quatre heures.

Ajoute un événement de projet notification.test et met en file d'attente une livraison de cet événement pour cette notification uniquement (aucune autre notification ne reçoit notification.test).

Un webhook reçoit l’événement comme corps de requête ; une notification par courriel envoie un courriel de test à ses destinataires ; une notification Slack, Teams ou Telegram publie un message de test ; une notification PagerDuty déclenche un événement d’information et le résout aussitôt.

Il fonctionne sur une notification désactivée ou en pause, n'est tenté qu'une fois, sans nouvelle tentative, et ne modifie jamais l'état d'échec de la notification. Interrogez le journal des livraisons pour en connaître le résultat.

Le journal des livraisons de la notification, de l'événement le plus récent au plus ancien. Une ligne par événement, et par condition de cet événement pour un avis d'écran; les nouvelles tentatives mettent la ligne à jour et GET .../deliveries/{delivery_id}/attempts liste ses tentatives les plus récentes. Un avis qui n'a jamais eu besoin d'être envoyé est ignoré, avec sa raison.

Les lignes sont conservées comme les événements (la durée de conservation des événements du forfait, au moins la fenêtre de nouvelles tentatives de 24 heures). Renvoyez next_cursor comme précédemment pour obtenir la page suivante.

Les tentatives d'une livraison, de la plus récente à la plus ancienne, les 20 plus récentes, conservées avec la ligne de livraison et aussi longtemps qu'elle. Chacune comporte son numéro de tentative, l'heure de sa fin, le statut HTTP du récepteur (null si aucun n'a répondu ou pour un courriel), la classe d'erreur (null en cas de succès) et sa durée.

Une livraison qui n'appartient pas à cette notification, ou une notification d'un autre projet, renvoie not_found.

Renvoie les courriels d’une notification à une personne qui les avait arrêtés avec le lien de désabonnement de son courriel (Notification.unsubscribed liste les personnes concernées). Idempotent : une personne qui n’est pas arrêtée ne change rien, et la réponse est la notification telle qu’elle est.

Un changement augmente la révision et ajoute notification.updated avec les détails change resubscribed, user_id et via api. Une session du tableau de bord peut réabonner n’importe quelle personne du projet; une information d’identification d’agent exige la capacité d’écriture du projet. Le moyen qu’a la personne de revenir elle-même est le bouton Resubscribe de la page que renvoie son lien de désabonnement.

Le lien dans le pied de page d’un courriel d’alerte. Il ne porte ni session ni jeton porteur; le jeton t, créé par screenRIG pour une notification n et une personne u, est toute l’autorité, n’expire jamais et reste valide tant que la version de clé d’émission qu’il nomme est conservée.

La réponse est une page qui demande d’arrêter les courriels de cette notification pour cette personne et qui ne change rien, de sorte qu’un analyseur de courriel qui ouvre le lien n’arrête rien; son bouton publie vers ce chemin. Une personne déjà arrêtée voit une page dont le bouton la réabonne.

Tout jeton, toute notification ou toute personne qui ne correspond pas, ainsi qu’une notification supprimée ou qui n’est pas une notification par courriel, obtient la même page 404. La page n’a aucun script et ne publie que vers cette origine. Au plus 30 requêtes par minute par adresse (rate_limited).

Arrête les courriels d’une notification pour la personne à qui le lien est destiné. La chaîne de requête est celle du lien GET; le corps n’est pas lu, de sorte que la requête en un clic RFC 8058 d’un fournisseur de courriel (List-Unsubscribe=One-Click, issue des en-têtes List-Unsubscribe et List-Unsubscribe-Post que porte chaque courriel d’alerte et de test) et le bouton de la page fonctionnent tous deux.

Seule cette personne est arrêtée, pour cette notification seulement; les autres continuent de recevoir les courriels, et la personne reste parmi les destinataires (recipients). L’opération est idempotente. La première fois, elle augmente la révision et ajoute notification.updated avec les détails change unsubscribed, user_id et via email_link.

La page qu’elle renvoie contient un bouton Resubscribe (POST /api/notifications/resubscribe); un membre du projet voit les personnes arrêtées dans Notification.unsubscribed. Lorsqu’il ne reste personne à qui écrire, un avis est ignoré avec no_recipients. Tout lien qui ne correspond pas obtient la page 404 du GET. Au plus 30 requêtes par minute par adresse (rate_limited).

Annule POST /api/notifications/unsubscribe pour la personne à qui le lien est destiné : le bouton Resubscribe de la page qu’il renvoie. Même lien, même autorité et même page 404; idempotent. Un changement augmente la révision et ajoute notification.updated avec les détails change resubscribed, user_id et via email_link. Au plus 30 requêtes par minute par adresse (rate_limited).