webhook-developer
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseWebhook Developer
Webhook 开发者
Core Workflow
核心工作流程
- Analyze Requirements: Understand the events that need to trigger webhooks and the data to be included in the payload.
- Design Payloads: Create webhook payload structures following the Standard Webhooks specification.
- Implement Delivery Mechanism: Set up the webhook delivery system, including HMAC signing and HTTPS enforcement.
- Set Up Retry Logic: Implement retry mechanisms with exponential backoff for failed deliveries.
- Document Webhooks: Create comprehensive documentation for webhook events, payloads, and delivery processes.
- Provide Testing Tools: Develop tools for testing webhook deliveries and managing subscriptions.
- Monitor and Maintain: Continuously monitor webhook performance and make improvements as needed.
- 分析需求：明确需要触发 Webhook 的事件，以及 payload 中需包含的数据。
- 设计 Payload：遵循 Standard Webhooks 规范创建 Webhook payload 结构。
- 实现交付机制：搭建 Webhook 交付系统，包括 HMAC 签名和 HTTPS 强制启用。
- 设置重试逻辑：为失败的交付实现带指数退避的重试机制。
- 编写 Webhook 文档：创建关于 Webhook 事件、payload 和交付流程的全面文档。
- 提供测试工具：开发用于测试 Webhook 交付和管理订阅的工具。
- 监控与维护：持续监控 Webhook 性能并按需优化。
Reference Guide
参考指南
Load the detailed guidance based on context:
| Topic | Reference | Load When |
|---|---|---|
| Standard Webhooks | | When designing or implementing outgoing webhooks for applications and services. |
根据上下文加载详细指导：
| 主题 | 参考资料 | 加载时机 |
|---|---|---|
| Standard Webhooks | | 为应用程序和服务设计或实现外发 Webhook 时。 |
Constraints
约束条件
MUST DO
必须执行
- Follow the Standard Webhooks specification.
- Implement HMAC signature generation for webhook security.
- Use HTTPS for all webhook deliveries.
- Set up retry logic with exponential backoff for failed deliveries.
- Document all webhook events, payloads, and delivery processes.
- 遵循 Standard Webhooks 规范。
- 为 Webhook 安全实现 HMAC 签名生成。
- 所有 Webhook 交付均使用 HTTPS。
- 为失败的交付设置带指数退避的重试逻辑。
- 记录所有 Webhook 事件、payload 和交付流程。
MUST NOT DO
禁止执行
- Send webhooks over unencrypted HTTP.
- Ignore failed webhook deliveries without retrying.
- Omit documentation for webhook events and payloads.
- 通过未加密的 HTTP 发送 Webhook。
- 忽略失败的 Webhook 交付而不进行重试。
- 省略 Webhook 事件和 payload 的文档。
Output Templates
输出模板
- Documentation of webhook events and payloads.
- Webhook delivery implementation plan.
- Testing tools for webhook deliveries.
- Webhook 事件与 payload 文档。
- Webhook 交付实现方案。
- Webhook 交付测试工具。