事件 · 作业与导出
export.ready
导出已就绪
导出文件已可下载:卡片导出、组织导出或重新生成的文件。
- 对象类型
- file
- 投递对象
- 具有 admin 角色的 Webhook
有效负载
idstring必填事件 ID(
evt_…),也会作为webhook-id头发送。可用于丢弃重复的投递。typestring必填可选值:
export.readycreated_atstring (date-time)必填变更发生的时间(UTC)。
org_idinteger必填api_versionstring必填data结构定义的契约版本。sequenceinteger在该 Webhook 内的投递序号(测试事件不返回)。
payloadstring必填thin表示没有data:请通过 API 读取对象。可选值:
fullthindataobject字段
kindstring必填导出的内容:
cards、answer、card、report、org等。job_idinteger | null索引作业或导出作业。
actor_idinteger | null必填执行该操作的用户;由组织 API 密钥或平台自身执行时为
null。regeneratedboolean文件已重新生成(
POST /v1/files/{file_id}/regenerate)。
testboolean必填由
POST /v1/webhooks/{webhook_id}/test发送的测试事件。
投递示例
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "export.ready",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "file",
"id": "f2b1c0de-0000-4000-8000-000000000001"
},
"payload": "full",
"data": {
"file": {
"id": "f2b1c0de-0000-4000-8000-000000000001",
"filename": "cards.xlsx",
"format": "xlsx",
"size": 18234,
"expires_at": "2026-10-31T10:00:00Z"
},
"kind": "cards",
"job_id": null,
"actor_id": 7
},
"test": false
}接收事件
每次投递都是向 Webhook 接收地址发送的 POST 请求,请求体就是这个 JSON。先验证 webhook-signature 头(Standard Webhooks),再信任请求体;在几秒内返回 2xx 状态,之后再处理。投递到同一个 Webhook 的事件保持原有顺序;投递失败时按逐渐拉长的间隔重试。
随时可能新增事件类型和字段:跳过不认识的类型和字段。