- 变化事件:提示词的回答发生变化时发送到你的
webhookUrl:你的品牌出现或消失、竞争对手领先,或某个网站首次被引用。 - 提醒:品牌最近七天的提及率低于
alertBelowPct时,给账户管理员发送邮件。
变化事件
在创建或更新监测器时设置webhookUrl:
400 VALIDATION_ERROR。
webhookUrl: null 关闭事件并丢弃监测器的事件状态;再次开启时会从其历史重新开始。
事件类型
品牌事件按引擎分别跟踪每个提示词,网格监测器还按每个点分别跟踪。状态从最近五个回答读取,因此设置
samples: 5 时一次运行即可得到完整状态。
- 事件在状态变化时发送一次。品牌持续不出现在回答中时,只发送一次
monitor.mention.stopped,直到它回来之前不再发送。 - 提示词积累五个回答后才有状态。第一个状态作为基准,不发送任何事件。
- 品类监测器没有自己的品牌,只发送
monitor.source.first_cited。
- 为已有回答的监测器开启
webhookUrl:每个提示词的状态根据过去 30 天内最近五个回答重建,所有已被引用的域名都视为已知。事件从下一个回答开始。 - 创建时就设置
webhookUrl,或在还没有任何回答时开启:首次运行确定已知域名,monitor.source.first_cited统计该运行全部提交之后创建的任务的回答。 品牌事件在提示词积累五个回答后开始。
负载
每个事件都是带 JSON 正文的POST 请求。例如:
签名与重试
事件的签名和重试方式与任务 Webhook 相同:同样的三个querying-webhook-* 请求头、同样的 HMAC-SHA256 方案和同样的重试计划。
用 Webhook 中的代码验证。有两点不同:
querying-webhook-id是事件的id。请按它去重。- HMAC 密钥是设置
webhookUrl的 API 密钥的 SHA-256 摘要,而不是任务密钥的摘要。
webhookUrl,之后的事件就用新密钥签名。如果设置 webhookUrl 的密钥被吊销或过期,事件会停止:
每个事件都被标记为 failed,原因记录在 delivery.lastError 中,不会发送未签名的事件。
列出和重新投递事件
GET /v1/monitors/{id}/events(参考)按从新到旧列出事件。
响应包含
webhookUrl、nextCursor(最后一页为 null)和 events。每个事件带有 id、
type、createdAt、data(与负载中相同)和 delivery:
POST /v1/monitors/{id}/events/{eventId}/redeliver
(参考)立即把一个事件重新发送到当前的 webhookUrl,重新开始一轮重试,
并返回带有更新后 delivery 的事件。已投递的事件也可以再次发送。监测器没有 webhookUrl 时返回 409 WEBHOOK_NOT_SET,
未知事件返回 404 NOT_FOUND。
事件保留 30 天。仍在重试中的事件会保留到重试结束。
提醒
在品牌监测器上设置alertBelowPct(1 到 100 的整数百分比),品牌提及率低于该值时你会收到邮件:
- 窗口:最近 7 天的已评分回答,涵盖监测器的所有提示词和引擎。报告默认 30 天,变化太慢,无法及时预警。
- 时机:每次计划运行开始时。检查读取的是已评分的回答,因此反映的是之前的运行。
- 最小样本:窗口内已评分回答少于 5 个时永不触发。新监测器或引擎持续失败的监测器不会发出提醒。
- 按越线而非状态:比率低于阈值且提醒处于启用状态时触发,随后解除启用。比率回到阈值或以上后才重新启用,
因此一直偏低的监测器只发一封邮件,而不是每次运行都发。修改
alertBelowPct会重新启用提醒。
alertBelowPct 会以 400 VALIDATION_ERROR 被拒绝。alertBelowPct: null 关闭提醒。
提醒历史
GET /v1/monitors/{id}/alerts(参考)返回
alertBelowPct、armed 和 deliveries:该监测器最近 20 封提醒邮件,包括测试邮件。每次投递带有 id、status(pending、sent 或 failed)、
attempts、createdAt、sentAt、lastError 和 payload(monitorId、name、ratePct、threshold、windowDays、runs)。
投递记录保留 90 天。
发送测试提醒
POST /v1/monitors/{id}/alerts/test(参考)通过与真实提醒相同的投递路径排入一封测试邮件,
监测器名称后附有 “(test)”,并返回 data.queued: true。请在提醒历史中查看结果。每个监测器每五分钟可发送三封测试邮件;超出返回
429 RATE_LIMITED。品类监测器返回 400 VALIDATION_ERROR。
后续步骤
Webhook
所有 Webhook 的签名、重试和安全的处理程序。
来源与回答
打开事件背后的回答。