事件 · 协作

announcement.read

公告已读

接收人已确认阅读必读公告。

对象类型: announcement
投递对象: 能看到该对象的 Webhook：按角色、数据权限档案和合集确定

有效负载

idstring必填
事件 ID（evt_…），也会作为 webhook-id 头发送。可用于丢弃重复的投递。
typestring必填
可选值: announcement.read
created_atstring (date-time)必填
变更发生的时间（UTC）。
org_idinteger必填
api_versionstring必填
data 结构定义的契约版本。
sequenceinteger
在该 Webhook 内的投递序号（测试事件不返回）。
objectWebhookEventObject必填
payloadstring必填
thin 表示没有 data：请通过 API 读取对象。
可选值: fullthin
dataobject
字段
- announcementEventAnnouncement必填
- user_idinteger必填
  确认已读的用户。
testboolean必填
由 POST /v1/webhooks/{webhook_id}/test 发送的测试事件。

投递示例

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "announcement.read",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "announcement",
    "id": "12"
  },
  "payload": "full",
  "data": {
    "announcement": {
      "id": 12,
      "card_id": "c_9f2e41"
    },
    "user_id": 11
  },
  "test": false
}

接收事件

每次投递都是向 Webhook 接收地址发送的 POST 请求，请求体就是这个 JSON。先验证 webhook-signature 头（Standard Webhooks），再信任请求体；在几秒内返回 2xx 状态，之后再处理。投递到同一个 Webhook 的事件保持原有顺序；投递失败时按逐渐拉长的间隔重试。

随时可能新增事件类型和字段：跳过不认识的类型和字段。

同样的事件在事件记录中保留 30 天 →