跳转到内容

回调通知

当运行请求包含 callback_url 时,CoreClaw 会在运行状态变化或结束后,向调用方提供的地址发送 POST 请求。

回调适合用来减少主动轮询次数。调用方仍应保存启动运行时返回的 data.run_slugrequest_id,用于后续查询、排查和幂等处理。

在支持请求体的运行类接口中传入 callback_url,例如直接运行 Worker:

{
"input": {
"parameters": {
"custom": {
"keywords": [
"coffee"
],
"base_location": "New York,USA",
"max_results": 1
}
}
},
"is_async": true,
"limit": 20,
"offset": 0,
"callback_url": "https://example.com/coreclaw/callbacks"
}

CoreClaw 发送的回调请求使用 POST 方法,Body 为 JSON:

{"run_id":123456,"run_status":"succeeded","error_message":"","execution_start_timestamp":100,"execution_end_timestamp":200,"running_duration":100,"result_count":3,"result_message":"done"}
字段类型说明
run_idinteger平台运行结果 ID。
run_statusstring运行状态,例如 succeeded
error_messagestring失败时的错误信息;没有错误时为空字符串。
execution_start_timestampnumber执行开始时间戳。
execution_end_timestampnumber执行结束时间戳。
running_durationnumber运行耗时。
result_countnumber当前结果数量。
result_messagestring结果摘要或运行消息。
  1. 回调地址应能被 CoreClaw 服务端访问,并返回 2xx HTTP 状态。
  2. 根据运行标识做幂等处理,避免重复通知造成重复写入。
  3. 收到回调后,如需完整结果,请继续调用运行详情、日志、结果或导出接口读取。
  4. 不要把 API key 放进 callback_url;如需校验来源,请在自己的回调服务中使用独立签名或随机路径。