外发 webhook:运作方式
webhook 是系统在某件事发生的那一刻推送到您指定地址的一条消息,例如新的潜在客户、发票已发送、收到付款或有人下单。这样另一个系统就能立即作出反应,而不必一遍又一遍地询问。
第 3 课,共 9 课 · 运作方式
运作方式
在 «System → Integrations → Integrations & API» 页面的 «Webhook endpoints» 面板中点击 «Add endpoint»。输入名称和地址,然后勾选 «All events»,或从列表中挑选单个事件。
保存后,«Webhook signing secret»(签名密钥)只显示一次。请把它复制到接收系统中,接收方用它来核实推送确实来自您的网站。
当订阅的事件发生时,系统会立即把详细信息推送到该地址。接收方必须在 10 秒内返回成功。
推送失败后,会在 1 分钟、5 分钟、30 分钟、2 小时、12 小时和 24 小时后重试。之后仍失败就标记为失败。
连续失败 25 次的端点会被系统关闭,仪表板上会出现一条待办。接收方恢复正常后,在该行点击 «Enable»。
行上的 «Test»,或端点页面上的 «Send test event»,会推送一条测试消息。端点页面还会显示最近的推送记录,并可以用 «Rotate secret» 更换密钥。
«Delivery log» 列出每一次推送的状态、端点和事件、发送的内容以及收到的回应。«Retry now» 会重新发送失败的推送。记录保留 30 天。
在哪里找到
- System → Integrations → Integrations & API
/admin/integrations - Integrations & API → Delivery log
/admin/integrations/deliveries - System → Automations
/admin/automations
影响它的设置
- Apps & modules (Automation & integrations)
/admin/apps
检查清单
继续之前,请确认您能够:
- 打开 System → Integrations → Integrations & API
- 在 System → Integrations → Integrations & API 页面的 Webhook endpoints 面板中点击 Add endpoint。输入名称和地址,然后勾选 All…
- 保存后,Webhook signing secret(签名密钥)只显示一次。请把它复制到接收系统中,接收方用它来核实推送确实来自您的网站。
- 当订阅的事件发生时,系统会立即把详细信息推送到该地址。接收方必须在 10 秒内返回成功。
- 推送失败后,会在 1 分钟、5 分钟、30 分钟、2 小时、12 小时和 24 小时后重试。之后仍失败就标记为失败。
提示和常见错误
- 什么都没收到?打开推送记录,查看失败那一行收到的回应。最常见的原因是地址错误,或接收方处理时间超过 10 秒。
- 重试之后,同一条推送可能会到达不止一次。接收系统应该根据推送 ID 忽略重复的消息。
- 执行 «Rotate secret» 后,紧接着的下一条推送就会用新密钥签名,所以请同时更新接收系统。
- 重试由后台进程发送。后台进程停止期间,失败的推送不会重试。