快速开始
用最短路径创建端点、触发投递并查看结果。
这个流程会创建一个 Webhook 回调端点，然后立即创建 Task Run 进行投递。
回调端点
01
触发来源
02
执行任务
03
投递尝试
04
重试任务
05
死信
06
1. 创建端点
Endpoint 是 EdgeCron 要调用的目标地址。生产环境中建议使用 HTTPS，并在你的服务端校验自有 webhook secret。
curl -X POST 'https://api.edgecron.com/v1/endpoints' \
-H 'X-Key-ID: ak_your_key_id' \
-H 'X-Timestamp: 1782873600' \
-H 'X-Signature: your_lowercase_hex_signature' \
-H 'Content-Type: application/json' \
--data '{
"name": "billing-webhook",
"url": "https://example.com/webhooks/edgecron",
"method": "POST",
"timeout_ms": 5000
}'2. 创建一次性任务
直接创建 Task Run 适合立即投递、延迟一次性投递或补偿任务。将 run_at 设置为 0 表示立即执行。
curl -X POST 'https://api.edgecron.com/v1/tasks' \
-H 'X-Key-ID: ak_your_key_id' \
-H 'X-Timestamp: 1782873600' \
-H 'X-Signature: your_lowercase_hex_signature' \
-H 'Content-Type: application/json' \
--data '{
"endpoint_id": 101,
"payload": "{\"invoice_id\":\"inv_123\",\"status\":\"paid\"}",
"run_at": 0
}'3. 查看投递尝试
Delivery Attempt 是一次真正的 HTTP 调用结果。如果失败并且策略允许，后续会产生 Retry Job。
curl 'https://api.edgecron.com/v1/deliveries?page=1&page_size=20' \
-H 'X-Key-ID: ak_your_key_id' \
-H 'X-Timestamp: 1782873600' \
-H 'X-Signature: your_lowercase_hex_signature'生产建议
在生产环境中，请让你的目标端点校验自有 Webhook secret，并确保接口能够在超时时间内返回 2xx。
另一条常见路径：发布事件
事件适合业务语义清晰的场景，例如订单、账单、用户状态变化。EdgeCron 会按 Endpoint 订阅规则匹配并 fan-out。
curl -X POST 'https://api.edgecron.com/v1/events' \
-H 'X-Key-ID: ak_your_key_id' \
-H 'X-Timestamp: 1782873600' \
-H 'X-Signature: your_lowercase_hex_signature' \
-H 'Content-Type: application/json' \
--data '{
"event_name": "invoice.paid",
"event_key": "inv_123",
"payload": {
"invoice_id": "inv_123",
"status": "paid"
}
}'