- Les événements de changement sont envoyés à votre
webhookUrlquand les réponses à un prompt changent : votre marque apparaît ou disparaît, un concurrent prend l’avantage, ou un site est cité pour la première fois. - Les alertes envoient un e-mail aux administrateurs de votre compte quand le taux de mention de la marque sur les sept derniers jours passe
sous
alertBelowPct.
Événements de changement
DéfinissezwebhookUrl quand vous créez ou mettez à jour un moniteur :
400 VALIDATION_ERROR. webhookUrl: null
désactive les événements et efface l’état d’événements du moniteur ; les réactiver repart de son historique.
Types d’événements
Les événements de marque suivent chaque prompt séparément sur chaque moteur et, sur un moniteur en grille, à chaque point. L’état
se lit sur les cinq dernières réponses :
samples: 5 donne donc un état complet en une exécution.
- Un événement est envoyé une fois, quand l’état change. Une marque qui reste absente des réponses envoie un seul
monitor.mention.stopped, puis plus rien jusqu’à son retour. - Un prompt a un état dès qu’il compte cinq réponses. Ce premier état sert de référence et n’envoie rien.
- Un moniteur de catégorie n’a pas de marque propre et n’envoie que
monitor.source.first_cited.
- Activer
webhookUrlsur un moniteur qui a déjà des réponses : l’état de chaque prompt est reconstruit à partir de ses cinq dernières réponses des 30 derniers jours, et chaque domaine déjà cité compte comme connu. Les événements commencent avec la réponse suivante. - Créer un moniteur avec
webhookUrl, ou l’activer avant qu’il n’existe des réponses : la première exécution fixe les domaines connus, etmonitor.source.first_citedcompte les réponses des tâches créées après la soumission complète de cette exécution. Les événements de marque commencent dès qu’un prompt compte cinq réponses.
Charge utile
Chaque événement est unPOST avec un corps JSON. Par exemple :
Signature et nouvelles tentatives
Les événements sont signés et retentés comme les webhooks de tâche : les trois mêmes en-têtesquerying-webhook-*, le même
schéma HMAC-SHA256 et le même calendrier de nouvelles tentatives. Vérifiez-les avec le code de
Webhooks. Deux points diffèrent :
querying-webhook-idest l’idde l’événement. Dédupliquez sur cette valeur.- La clé HMAC est l’empreinte SHA-256 de la clé d’API qui a défini
webhookUrl, et non de la clé d’une tâche.
webhookUrl avec la nouvelle clé : les événements sont alors signés avec elle. Si
la clé qui a défini webhookUrl est révoquée ou expire, les événements s’arrêtent : chacun est marqué failed avec la
raison dans delivery.lastError, et rien n’est envoyé sans signature.
Lister et renvoyer les événements
GET /v1/monitors/{id}/events (référence) liste les événements du plus récent au plus ancien.
La réponse contient
webhookUrl, nextCursor (null sur la dernière page) et events. Chaque événement a id,
type, createdAt, data (comme dans la charge utile) et delivery :
POST /v1/monitors/{id}/events/{eventId}/redeliver
(référence) renvoie un événement maintenant vers le
webhookUrl actuel, avec une nouvelle série de tentatives, et renvoie l’événement avec son delivery mis à jour. Les événements
déjà livrés peuvent aussi être renvoyés. Il renvoie 409 WEBHOOK_NOT_SET quand le moniteur n’a pas de webhookUrl et
404 NOT_FOUND pour un événement inconnu.
Les événements sont conservés 30 jours. Un événement encore en cours de nouvelles tentatives est conservé jusqu’à la fin de celles-ci.
Alertes
DéfinissezalertBelowPct sur un moniteur de marque, un pourcentage entier de 1 à 100, pour recevoir un e-mail quand le
taux de mention de la marque passe en dessous :
- Fenêtre : les réponses notées des 7 derniers jours, sur tous les prompts et moteurs du moniteur. Le rapport couvre 30 jours par défaut, ce qui évolue trop lentement pour prévenir qui que ce soit.
- Moment : à chaque démarrage d’une exécution planifiée. La vérification lit les réponses déjà notées : elle reflète donc les exécutions précédentes.
- Échantillon minimal : moins de 5 réponses notées dans la fenêtre ne déclenche jamais l’alerte. Un nouveau moniteur, ou un moniteur dont les moteurs échouent, reste silencieux.
- Franchissement, pas état : l’alerte se déclenche quand le taux est sous le seuil et que l’alerte est armée,
puis se désarme. Elle se réarme une fois le taux revenu au niveau du seuil ou au-dessus : un moniteur qui reste bas
n’envoie donc qu’un e-mail, pas un à chaque exécution. Modifier
alertBelowPctla réarme.
alertBelowPct avec 400 VALIDATION_ERROR.
alertBelowPct: null désactive l’alerte.
Historique des alertes
GET /v1/monitors/{id}/alerts (référence) renvoie
alertBelowPct, armed et deliveries : les 20 e-mails d’alerte les plus récents du moniteur, tests
compris. Chaque envoi a id, status (pending, sent ou failed), attempts, createdAt,
sentAt, lastError et payload (monitorId, name, ratePct, threshold, windowDays, runs).
Les enregistrements d’envoi sont conservés 90 jours.
Envoyer une alerte de test
POST /v1/monitors/{id}/alerts/test (référence) met en file un e-mail de test
par le même circuit d’envoi qu’une vraie alerte, avec « (test) » après le nom du moniteur, et renvoie
data.queued: true. Vérifiez le résultat dans l’historique des alertes. Vous pouvez envoyer trois e-mails de test par moniteur
toutes les cinq minutes ; au-delà, l’appel renvoie 429 RATE_LIMITED. Un moniteur de catégorie renvoie 400 VALIDATION_ERROR.
Étapes suivantes
Webhooks
Signature, nouvelles tentatives et gestionnaires sûrs pour tous les webhooks.
Sources et réponses
Ouvrez la réponse derrière un événement.