Webhooks

Send a test event

POSThttps://ecdsa.com/api/v1/webhooks/test

Sends a "webhook.test" event to one endpoint of the API key's account — also to one that is switched off — and answers once the first attempt is made: status delivered, or pending with the receiver's HTTP status or the failure in lastError (a failed test event is retried like any other delivery). The event's data is {"endpoint": {"id", "url"}}. At most 10 test events per endpoint and hour (rate_limited with Retry-After). Deliveries are POST requests with a JSON body, signed with ECDSA P-256 (ES256): headers ECDSA-Webhook-Id, ECDSA-Webhook-Timestamp and ECDSA-Signature (t=<unix seconds>,kid=<key id>,es256=<base64url r‖s>) over the UTF-8 bytes of "<id>.<t>.<raw body>". The public keys are the JWKS at https://ecdsa.com/.well-known/ecdsa-webhook-keys.json; every official SDK verifies deliveries with verifyWebhook().

API 密钥: 必需，且需要 webhooks 范围
使用密钥时的配额消耗: 每次调用 1 个单位
速率限制: 每个 IP 每分钟 60 次请求

请求

JSON 请求体：SendWebhookTestRequest

字段	类型	必需	说明
id	string	是	The endpoint's id (listWebhooks lists them).

响应

200The test delivery after its first attempt.

字段	类型	必需	说明
delivery	WebhookDelivery	是

响应头： X-Request-Id · X-RateLimit-Limit · X-RateLimit-Remaining · X-RateLimit-Reset · X-Quota-Limit · X-Quota-Remaining · X-Quota-Reset

状态码	含义	错误码
400	Bad request. Input limits: a request body of at most 100 KB (a larger one is answered with 413) and arrays and objects nested at most 64 levels deep, JSON documents inside string fields included.	invalid_json missing_field private_key_rejected
401	Unauthorized.	unauthorized
403	Forbidden.	forbidden_scope
404	Not found.	not_found webhook_not_found
405	Method not allowed.	method_not_allowed
413	Payload too large.	payload_too_large
429	Too many requests.	rate_limited quota_exceeded
500	Internal server error.	internal_error
503	Service unavailable.	service_unavailable webhooks_unavailable
504	Gateway timeout.	timeout

每个错误响应都带有 JSON 信封；错误表说明了每个错误码的含义和处理方法。

示例

Send a test event

curl

curl -sS 'https://ecdsa.com/api/v1/webhooks/test' \
  -H "authorization: Bearer $ECDSA_API_KEY" \
  -H 'content-type: application/json' \
  -d '{
  "id": "7349e17c-8b41-4fc1-b1a9-dca88578ca1c"
}'

JavaScript (fetch)

const response = await fetch("https://ecdsa.com/api/v1/webhooks/test", {
  method: "POST",
  headers: { "content-type": "application/json", authorization: `Bearer ${process.env.ECDSA_API_KEY}` },
  body: JSON.stringify({
    "id": "7349e17c-8b41-4fc1-b1a9-dca88578ca1c"
  }),
});
console.log(response.status, await response.json());

Python (httpx)

import os

import httpx

response = httpx.post(
    "https://ecdsa.com/api/v1/webhooks/test",
    headers={"authorization": f"Bearer {os.environ['ECDSA_API_KEY']}"},
    json={
        "id": "7349e17c-8b41-4fc1-b1a9-dca88578ca1c",
    },
    timeout=30.0,
)
print(response.status_code, response.json())

响应 200

{
  "delivery": {
    "id": "6491ad3b-5b71-417e-a73a-efdb977de0e1",
    "type": "webhook.test",
    "status": "delivered",
    "attempts": 1,
    "createdAt": "2026-10-20T07:34:27.000Z",
    "lastAttemptAt": "2026-10-20T07:34:27.000Z",
    "lastStatusCode": 204,
    "lastError": null,
    "nextAttemptAt": null,
    "deliveredAt": "2026-10-20T07:34:27.000Z"
  }
}

这是 API 对此示例的响应，于2026年10月20日为本页生成；其中的相对时间和天数都以当天为准。

错误码

错误码	状态码	含义
invalid_json	400	The body is not valid JSON or not a JSON object; or the input nests arrays and objects more than 64 levels deep (JSON documents inside string fields count too), or is too complex to inspect for private keys.
missing_field	400	A required field is absent or empty.
private_key_rejected	400	The request contains private-key material (a PEM PRIVATE KEY block, an OpenSSH, SSH2 or PuTTY private key, or a JWK with "d"). Never send private keys anywhere.
unauthorized	401	The Authorization or X-API-Key header is malformed, the API key is not valid (wrong checksum, unknown, revoked or expired), or the operation needs a key.
forbidden_scope	403	The API key is valid but lacks a scope this operation requires; the message names it.
not_found	404	No operation exists at this path.
webhook_not_found	404	The API key's account has no webhook endpoint with this id.
method_not_allowed	405	The path exists but does not accept this HTTP method; see the Allow header.
payload_too_large	413	The body exceeds 100 KB.
rate_limited	429	Too many requests — see Retry-After.
quota_exceeded	429	A daily or monthly quota of the API key's account is used up. X-Quota-Reset (and Retry-After) say when it starts over; retrying earlier cannot succeed.
internal_error	500	Unexpected server error.
service_unavailable	503	API keys cannot be verified right now (the key store is unreachable); retry shortly.
webhooks_unavailable	503	Webhooks are switched off on this server: it has no signing keys configured.
timeout	504	The operation did not finish within its time budget.

Schema

WebhookDelivery

字段	类型	必需	说明
id	string	是	Delivery id, sent as ECDSA-Webhook-Id and as the body's id; the same on every retry.
type	string	是	Event type, e.g. "monitor.grade_changed" or "webhook.test".
status	string	是	"pending"、"delivered"或"failed" 之一
attempts	integer	是	不小于 0
createdAt	string	是	UTC time, ISO 8601. 格式 date-time
lastAttemptAt	string \| null	是
lastStatusCode	integer \| null	是	HTTP status of the last attempt; null when no response arrived.
lastError	string \| null	是	Why the last attempt failed: "http_status" (any status outside 200–299, redirects included), "timeout", "address_refused", "tls_certificate", "endpoint_disabled", … ; null after a success.
nextAttemptAt	string \| null	是	When a pending delivery is tried again.
deliveredAt	string \| null	是

Error

The error envelope of every non-2xx response.

字段	类型	必需	说明
error	object	是
error.code	string	是	Machine-readable error code. Each response lists the codes it can carry; new codes may be added within v1, so treat an unknown code by its HTTP status.
error.message	string	是	Human-readable explanation (English).
error.requestId	string	否	The X-Request-Id of this request — quote it when reporting a problem. Sent since v1.1.
error.detail	object	否	Structured context for the error, such as the offending field; omitted when there is none. 成员名任意
error.docs	string	否	Where the error codes are explained. Sent since v1.1. 格式 uri

所有操作都列在 API 参考中。