docs: add webhook delivery semantics, retry behavior, and self-diagnosis guide - #366
docs: add webhook delivery semantics, retry behavior, and self-diagnosis guide#366rcsh1 wants to merge 2 commits into
Conversation
cobosteven
left a comment
There was a problem hiding this comment.
Doc PR Review — CoboGlobal/developer-site #366
Verdict: REQUEST_CHANGES
Summary
The PR is well-scoped and bilingually faithful: every new EN section, bullet, and self-diagnosis step has a one-to-one CN counterpart, no event codes or status enums are fabricated, and code-side fact-verification surfaced 0 failures (no wrong/invented error codes, status codes, or timing claims). However, one must_fix blocks approval: self-diagnosis step 4 in introduction.mdx (EN and CN) links to a 'Common delivery failures' / '常见投递失败原因' anchor in set-up-endpoint that the PR never creates, so the remediation step resolves to nothing and is non-actionable. Per the verdict rule a must_fix standards violation forces REQUEST_CHANGES; the remaining items are should_fix/nit polish.
must_fix
- Broken cross-link / non-actionable remediation step —
introduction.mdxself-diagnosis step 4 (EN + CN).- EN step 4 links to
/v2/guides/webhooks-callbacks/set-up-endpoint#common-delivery-failures; CN step 4 links toset-up-endpoint#常见投递失败原因. - The PR adds only
Retry behavior/重试行为andDelivery guarantees/投递保证to set-up-endpoint. No "Common delivery failures"/"常见投递失败原因" heading exists in any EN or CN webhooks-callbacks file (grep-confirmed by both reviewers), so the anchor goes nowhere and "resolve the cause" degenerates into a vague directive (violates the exact-path / valid-internal-link rule). - Reviewer disagreement on severity (surfaced): standards reviewer rates this must_fix (broken internal link + non-actionable step); bilingual reviewer rates it should_fix (consistently broken in BOTH languages, a real defect but not an EN/CN divergence). Synthesis keeps it must_fix because actionability of the fix step is the governing standard regardless of language parity.
- Fix (apply to both languages): either add the referenced
Common delivery failures/常见投递失败原因section to both set-up-endpoint files, or re-point step 4 at the#retry-behavior/#重试行为anchor that actually exists.
- EN step 4 links to
|
The only review item is a stale must-fix from cobosteven on June 22, 2026 saying the self-diagnosis step links to a missing section. But on the actual PR branch playbook/run-run_d582a0364048 / local checkout pr-
And the self-diagnosis links in:
already point to those matching anchors. |
cobosteven
left a comment
There was a problem hiding this comment.
Verdict: REQUEST_CHANGES
总评
本 PR 仅复述已有事实、未引入新的计时/SLA/分发声明;事实核查(claude + codex 两分支)0 项 failure,未发现伪造或错误的 error/status code。但仍有 4 项 must_fix 需要修复后再放行:CN 状态枚举值 Delivered/Failed 被翻译,以及自助排查清单第 1/3/4 步缺少可直接操作的 Portal 路径、产品模式层级和具体补救/重试动作。
must_fix
- 【双语一致性】
v2_cn/guides/webhooks-callbacks/set-up-endpoint.mdx的##### 重试行为将事件状态枚举值翻译为「已送达」「发送失败」,但 EN 使用Delivered/Failed。枚举值不应翻译;CN 应保持Delivered、Failed。 - 【标准合规】
v2/guides/webhooks-callbacks/introduction.mdx及 CN 镜像的### No webhook received? Self-diagnosis/### 未收到 Webhook 事件?自助排查第 1 步只说确认 endpoint 已订阅事件类型,但未说明在哪里查看/修改订阅,也未给完整 API 动作。请补充确切 Cobo Portal 点击路径或完整 curl/API-reference 动作。 - 【标准合规】同一自助排查清单第 3 步的 Portal 路径缺少
WaaS 2.0产品模式层级。请统一为 EN: Cobo Portal / Developer / WaaS 2.0 / Webhook Events;CN: Cobo Portal / 开发者 / WaaS 2.0 / Webhook 事件。 - 【标准合规】同一自助排查清单第 4 步的 “resolve the cause, then click Retry”(CN 镜像同义)不可直接操作。请写出常见原因的具体补救动作,并给出失败事件在点击
Retry前的确切路径或 API 动作。
🤖 自动文档 PR 独立审查(doc-pr-review)。
|
Addressed the current review feedback in the latest push (
The June 22 broken-anchor finding was not a change required in this revision: the later issue-level comment and current branch confirm that both 运行过程记录(自动生成)
|
Intent
Ticket 1178598175370948986 (提币交易状态在Submitted没有收到webhook推送): There is no transaction-status-to-webhook trigger matrix, and no documentation on delivery timing, retry behavior, or SLA expectations. Document the full status-to-webhook trigger matrix and add a delivery semantics section.'
Summary
Improve the webhook documentation to help integrators self-diagnose missing webhook notifications (Ticket: 提币交易状态在 Submitted 没有收到 webhook 推送). Six files updated (EN + CN pairs).
Changed files
v2/guides/webhooks-callbacks/set-up-endpoint.mdx— added##### Retry behaviorand##### Delivery guaranteessubsectionsv2_cn/guides/webhooks-callbacks/set-up-endpoint.mdx— CN mirror (##### 重试行为,##### 投递保证)v2/guides/webhooks-callbacks/introduction.mdx— added## Delivery semanticssection and### No webhook received? Self-diagnosischecklistv2_cn/guides/webhooks-callbacks/introduction.mdx— CN mirror (## 投递机制,### 未收到 Webhook 事件?自助排查)v2/guides/webhooks-callbacks/webhook-event-type.mdx— added cross-link to transaction status referencev2_cn/guides/webhooks-callbacks/webhook-event-type.mdx— CN mirror cross-linkAll edits restate facts already documented (2s timeout, 10 attempts,
200/201success, ordering not guaranteed, duplicate delivery possible). No new timing, SLA, or dispatch-behavior claims were asserted.